Créer un modèle d’e-mail
/templates/email/create
Utilisez cet endpoint pour créer des modèles d’e-mail sur le tableau de bord de Braze.
Ces modèles seront disponibles sur la page Modèles et médias. La réponse de cet endpoint comprend un champ pour email_template_id
, qui peut être utilisé pour mettre à jour le modèle lors des appels d’API suivants.
Le statut de l’abonnement aux e-mails des utilisateurs peut être mis à jour et récupéré via Braze à l’aide d’une API RESTful. Vous pouvez utiliser l’API pour configurer une synchronisation bidirectionnelle entre Braze et d’autres systèmes de messagerie ou votre propre base de données. Toutes les demandes d’API sont faites sur HTTPS.
Conditions préalables
Pour utiliser cet endpoint, vous aurez besoin d’une clé API avec l’autorisation templates.email.create
.
Limite de débit
We apply the default Braze rate limit of 250,000 requests per hour to this endpoint, as documented in API rate limits.
Corps de la demande
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.
}
Paramètres de demande
Paramètre | Requis | Type de données | Description |
---|---|---|---|
template_name |
Requis | Chaîne de caractères | Nom de votre modèle d’e-mail |
subject |
Requis | Chaîne de caractères | Ligne Objet du modèle d’e-mail. |
body |
Requis | Chaîne de caractères | Corps du modèle d’e-mail pouvant inclure du HTML. |
plaintext_body |
Facultatif | Chaîne de caractères | Une version en texte brut du corps du modèle d’e-mail. |
preheader |
Facultatif | Chaîne de caractères | Accroche d’e-mail utilisée pour générer des aperçus chez certains clients. |
tags |
Facultatif | Chaîne de caractères | Les étiquettes doivent déjà exister. |
should_inline_css |
Facultatif | Valeur booléenne | Active ou désactive la fonction inline_css par modèle. S’il n’est pas fourni, Braze utilisera le paramètre par défaut pour le groupe d’applications. true ou false est attendu. |
Exemple de demande
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"]
}'
Erreurs possibles
Le tableau suivant répertorie les erreurs renvoyées possibles et les étapes de résolution des problèmes associées, le cas échéant.
Erreur | Résolution des problèmes |
---|---|
Le nom du modèle est obligatoire | Saisissez un nom de modèle. |
Les balises doivent être un tableau | Les balises doivent être un tableau de chaînes de caractères, par exemple ["marketing", "promotional", "transactional"] . |
Toutes les balises doivent être des chaînes de caractères | Assurez-vous que vos balises sont comprises entre des guillemets ("" ). |
Certaines balises sont introuvables | Pour ajouter une balise lors de la création d’un modèle d’e-mail, la balise doit déjà exister dans Braze. |
L’e-mail doit comporter des noms de bloc de contenu valides | L’e-mail peut contenir des blocs de contenu qui n’existent pas dans cet environnement. |
Valeur non valide pour should_inline_css . true ou false était attendu |
Ce paramètre accepte uniquement les valeurs booléennes (vrai ou faux). Assurez-vous que la valeur de should_inline_css n’est pas comprise entre des guillemets ("" ), sinon la valeur est envoyée comme chaîne de caractères. |