Créer un bloc de contenu
post
/content_blocks/create
Utilisez cet endpoint pour créer un bloc de contenu.
Conditions préalables
Pour utiliser cet endpoint, vous aurez besoin d’une clé API avec l’autorisation content_blocks.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
{
"name": (required, string) Must be less than 100 characters,
"description": (optional, string) The description of the Content Block. Must be less than 250 character,
"content": (required, string) HTML or text content within Content Block,
"state": (optional, string) Choose `active` or `draft`. Defaults to `active` if not specified,
"tags": (optional, array of strings) Tags must already exist
}
Paramètres de demande
Paramètre | Requis | Type de données | Description |
---|---|---|---|
name |
Requis | Chaîne de caractères | Nom du bloc de contenu. Doit contenir moins de 100 caractères. |
description |
Facultatif | Chaîne de caractères | Description du bloc de contenu. Doit contenir moins de 250 caractères. |
content |
Requis | Chaîne de caractères | HTML ou contenu texte dans le bloc de contenu. |
state |
Facultatif | Chaîne de caractères | Choisir active ou draft . Défini par défaut sur active si cela n’est pas spécifié. |
tags |
Facultatif | Tableau de chaînes de caractères | Les étiquettes doivent déjà exister. |
Exemple de demande
1
2
3
4
5
6
7
8
9
10
curl --location --request POST 'https://rest.iad-01.braze.com/content_blocks/create' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer YOUR_REST_API_KEY' \
--data-raw '{
"name": "content_block",
"description": "This is my Content Block",
"content": "HTML content within block",
"state": "draft",
"tags": ["marketing"]
}'
Réponse
1
2
3
4
5
6
7
8
Content-Type: application/json
Authorization: Bearer YOUR_REST_API_KEY
{
"content_block_id": (string) Your newly generated block id,
"liquid_tag": (string) The generated block tag from the Content Block name,
"created_at": (string) The time the Content Block was created in ISO 8601,
"message": "success"
}
Résolution des problèmes
Le tableau suivant répertorie les erreurs renvoyées possibles et les étapes de résolution des problèmes associées.
Erreur | Résolution des problèmes | |
---|---|---|
Content cannot be blank |
||
Content must be a string |
Assurez-vous que votre contenu est compris entre des guillemets ("" ). |
|
Content must be smaller than 50kb |
Le contenu de votre bloc de contenu doit être inférieur à 50 Ko. | |
Content contains malformed liquid |
Le langage Liquid fourni n’est pas valide ou pas analysable. Réessayez avec un langage Liquid valide ou contactez-nous pour obtenir de l’aide. | |
Content Block cannot be referenced within itself |
||
Content Block description cannot be blank |
||
Content Block description must be a string |
Assurez-vous que la description de votre bloc de contenu est comprise entre des guillemets ("" ). |
|
Content Block description must be shorter than 250 characters |
||
Content Block name cannot be blank |
||
Content Block name must be shorter than 100 characters |
||
Content Block name can only contain alphanumeric characters |
Les noms de bloc de contenu peuvent comprendre l’un des caractères suivants : les lettres (majuscules ou minuscules) de A à Z , les chiffres de 0 à 9 , les tirets - , et les traits de soulignement _ . Il ne peut pas contenir de caractères non alphanumériques comme des émojis, ! , @ , ~ , & et d’autres caractères « spéciaux ». |
|
Content Block with this name already exists |
Essayez un autre nom. | |
Content Block state must be either active or draft |
||
Tags must be an array |
Les balises doivent être un tableau de chaînes de caractères, par exemple ["marketing", "promotional", "transactional"] . |
|
All tags must be strings |
Assurez-vous que vos balises sont comprises entre des guillemets ("" ). |
|
Some tags could not be found |
Pour ajouter une balise lors de la création d’un bloc de contenu, la balise doit déjà exister dans Braze. |
New Stuff!