Skip to content

Vorhandene E-Mail-Templates aktualisieren

post

/templates/email/update

Verwenden Sie diesen Endpunkt, um E-Mail-Templates im Braze-Dashboard zu aktualisieren.

Sie können auf die email_template_id eines E-Mail-Templates zugreifen, indem Sie auf der Seite Templates und Medien dorthin navigieren. Der Endpunkt E-Mail-Template erstellen gibt ebenfalls eine email_template_id-Referenz zurück.

Alle Felder außer email_template_id sind optional, aber Sie müssen mindestens ein Feld zum Aktualisieren angeben.

Voraussetzungen

Um diesen Endpunkt zu verwenden, benötigen Sie einen API-Schlüssel mit der Berechtigung templates.email.update.

Rate-Limit

Wir wenden auf diesen Endpunkt das standardmäßige Braze-Rate-Limit von 250.000 Anfragen pro Stunde an, wie in API-Rate-Limits dokumentiert.

Anfragetext

1
2
Content-Type: application/json
Authorization: Bearer YOUR_REST_API_KEY
1
2
3
4
5
6
7
8
9
10
{
  "email_template_id": (required, string) Your email template's API Identifier,
  "template_name": (optional, string) The name of your email template,
  "subject": (optional, string) The email template subject line,
  "body": (optional, string) The email template body that may include HTML,
  "plaintext_body": (optional, string) A plaintext version of the email template body,
  "preheader": (optional, string) The email preheader used to generate previews in some clients,
  "tags": (optional, array of Strings) Tags must already exist,
  "should_inline_css": (optional, Boolean) If `true`, the `inline_css` feature will be applied to the template.
}

Anfrageparameter

Parameter Erforderlich Datentyp Beschreibung
email_template_id Erforderlich String Der API-Bezeichner Ihres E-Mail-Templates.
template_name Optional String Name Ihres E-Mail-Templates.
subject Optional String Betreffzeile des E-Mail-Templates.
body Optional String Body des E-Mail-Templates, der HTML enthalten kann.
plaintext_body Optional String Eine Klartextversion des E-Mail-Template-Bodys.
preheader Optional String E-Mail-Preheader, der in einigen Clients zur Erstellung von Vorschauen verwendet wird.
tags Optional String Tags müssen bereits existieren.
should_inline_css Optional Boolescher Wert Aktiviert oder deaktiviert das Feature inline_css pro Template. Wenn nicht angegeben, verwendet Braze die Standardeinstellung für die AppGroup. Erwartet wird true oder false.

Beispielanfrage

1
2
3
4
5
6
7
8
9
10
11
12
curl --location --request POST 'https://rest.iad-01.braze.com/templates/email/update' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer YOUR_REST_API_KEY' \
--data-raw '{
  "email_template_id": "email_template_id",
  "template_name": "Weekly Newsletter",
  "subject": "This Week'\''s Styles",
  "body": "Check out this week'\''s digital lookbook to inspire your outfits. Take a look at https://www.braze.com/",
  "plaintext_body": "This is the updated text within my email body and here is a link to https://www.braze.com/.",
  "preheader": "We want you to have the best looks this summer",
  "tags": ["Tag1", "Tag2"]
}'

Fehlerbehebung

Die folgende Tabelle listet mögliche zurückgegebene Fehler und die zugehörigen Schritte zur Fehlerbehebung auf, falls zutreffend.

Fehler Fehlerbehebung
Template-Name ist erforderlich Geben Sie einen Template-Namen ein.
Tags müssen ein Array sein Tags müssen als String-Array formatiert werden, zum Beispiel ["marketing", "promotional", "transactional"].
Alle Tags müssen Strings sein Stellen Sie sicher, dass Ihre Tags in Anführungszeichen ("") eingeschlossen sind.
Einige Tags konnten nicht gefunden werden Um beim Erstellen eines E-Mail-Templates einen Tag hinzuzufügen, muss dieser bereits in Braze vorhanden sein.
Ungültiger Wert für should_inline_css. true oder false wurde erwartet. Dieser Parameter akzeptiert nur boolesche Werte (true oder false). Stellen Sie sicher, dass der Wert für should_inline_css nicht in Anführungszeichen ("") eingeschlossen ist, da der Wert sonst als String gesendet wird.
New Stuff!