Centre d’aide

Messages et modèles publiés

Consultez l’introduction à l’API pour l’authentification, les conventions, la pagination, les limites de requêtes et les erreurs.

Les deux listes sont toujours paginées : per_page vaut 10 par défaut. Utilisez page pour continuer.

Dans Activity Messenger, une infolettre peut être publiée à partir d’un modèle ou d’un message envoyé. Un modèle publié peut être modifié, contrairement à un message publié. Pour en savoir plus, consultez les infolettres. Utilisez ces points de terminaison pour récupérer tous les messages et modèles publiés.

GET /api/v1/organization/{organization}/published_messages

Récupère la liste de tous les messages envoyés et publiés, triés par date de publication, du plus récent au plus ancien.

GET /api/v1/organization/{organization}/published_templates

Récupère la liste de tous les modèles publiés, triés par date de publication, du plus récent au plus ancien.

Chaque élément expose les champs décrits ci-dessous.

Chaque élément comprend id, name, subject, url, short_url, published_at, created_at, updated_at, les champs de style et blocks.

L’attribut url pointe vers la page Web du message ou du modèle. Le HTML est simple et ne contient ni JavaScript ni fichiers CSS externes.

Les attributs background_color et background_image définissent la couleur de fond à l’extérieur du modèle (généralement gris foncé), ou une image.

L’attribut content_background_color définit la couleur de fond du contenu. L’attribut button_color définit la couleur par défaut des boutons; chaque bloc peut la remplacer.

L’attribut blocks contient la liste des blocs verticaux qui composent le message ou le modèle. Vous pouvez les utiliser pour reconstruire le modèle avec vos propres styles CSS et votre balisage HTML. Voici les blocs actuellement pris en charge et leurs attributs :

• hero : image principale. Attributs : image_url, image_alt.
• one-column : une colonne de texte avec un bouton facultatif. Attributs : text, button_url, button_text, button_color, button_target (https par défaut, ou mailto).
• image-column : deux colonnes, avec une image à gauche et du texte à droite, accompagné d’un bouton facultatif. Attributs : image_url, image_alt, image_cta_url (URL à ouvrir lorsque la personne clique sur l’image), text, button_url, button_text, button_color, button_target (https par défaut, ou mailto).
• column-image : deux colonnes, avec du texte et un bouton facultatif à gauche, et une image à droite. Attributs : image_url, image_alt, image_cta_url (URL à ouvrir au clic sur l’image), text, button_url, button_text, button_color, button_target (https par défaut, ou mailto).
• spacer : espace horizontal. L’attribut meta contient les styles CSS permettant de créer cet espacement.
• video : aperçu vidéo principal avec un lien ouvrant la vidéo dans un autre onglet du navigateur. Attributs : image_url (image d’aperçu), image_alt, image_cta_url (URL de la vidéo).
• video-column : deux colonnes, avec un aperçu vidéo à gauche et du texte accompagné d’un bouton facultatif à droite. Attributs : image_url (aperçu vidéo), image_alt, image_cta_url (URL de la vidéo), text, button_url, button_text, button_color, button_target (https par défaut, ou mailto).
• two-columns : deux colonnes de texte, chacune avec une image et un bouton facultatifs. Pour la colonne de gauche, utilisez image_url, image_alt, image_cta_url (URL à ouvrir au clic sur l’image), text, button_url, button_text, button_color, button_target (https par défaut, ou mailto). Pour la colonne de droite, utilisez les attributs portant le suffixe 2.