Skip to content

E-Mail-Template erstellen

post

/templates/email/create

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

Diese Templates werden auf der Seite Templates und Medien verfügbar sein. Die Antwort dieses Endpunkts enthält ein Feld für email_template_id, das zum Update des Templates in nachfolgenden API-Aufrufen verwendet werden kann.

Voraussetzungen

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

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
{
   "template_name": (required, string) The name of your email template,
   "subject": (required, string) The email template subject line,
   "body": (required, 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 is used on this template.
 }

Anfrageparameter

Parameter Erforderlich Datentyp Beschreibung
template_name Erforderlich String Name Ihres E-Mail-Templates.
subject Erforderlich String Betreffzeile des E-Mail-Templates.
body Erforderlich String Body des E-Mail-Templates, der HTML enthalten kann. Bis zu 400 KB.
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 App-Gruppe. Erwartet wird true oder false.

Beispielanfrage

1
2
3
4
5
6
7
8
9
10
11
curl --location --request POST 'https://rest.iad-01.braze.com/templates/email/create' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer YOUR_REST_API_KEY' \
--data-raw '{
  "template_name": "email_template_name",
  "subject": "Welcome to my email template!",
  "body": "This is the text within my email body and https://www.braze.com/ here is a link to Braze.com.",
  "plaintext_body": "This is the text within my email body and here is a link to https://www.braze.com/.",
  "preheader": "My preheader is pretty cool.",
  "tags": ["Tag1", "Tag2"]
}'

Beispielantwort

1
2
3
4
{
  "email_template_id": "232b6d29-7e41-4106-a0ab-1c4fe915d701",
  "message": "success"
}

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.
E-Mail muss gültige Content-Block-Namen haben Die E-Mail könnte Content Blocks enthalten, die in dieser Umgebung nicht vorhanden sind.
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!