Il est possible d'obtenir les tags et familles de tags de manière programmatique via API grâce à l'endpoint /v1/settings/tag-families.
Récupérer les tags et familles de tags
Utiliser la méthode GET avec l'endpoint /v1/settings/tag-families pour obtenir tous les tags et familles de tags.
En réponse de l'appel API est envoyée la liste des différentes familles de tags ainsi que les tags qu'elles contiennent.
Pour chaque famille de tag, plusieurs éléments sont renseignés :
-
Id: Identifiant de la famille de tag -
Name: Nom de la famille de tag -
Required: Indique si la famille de tag est obligatoire ou optionnelle lors de la création de campagne -
Type: indique si la famile de tag autorise une seule et unique valeur ou bien plusieurs valeurs sont autorisées
Pour chaque tag présent au sein d'une famille de tag, plusieurs éléments sont renseignées :
-
Id: Identifant du tag -
Name: Nom du tag -
Channels: Canaux pour lesquels le tag est activé (email, sms, notification push)
Bon à savoir : Les tags qui ne sont pas activé pour au moins un canal ne sont pas listés dans la réponse de l'appel API.
Si la liste de tags et famille de tags est trop importante, il est utile d'utiliser les options de paginations dans l'appel API pour aggrandir le nombre de résultats ou bien parvenir à une page spécifique de résultats.
L'identifiant du tag (champ id dans la réponse de l'endpoint /v1/settings/tag-families) vous sera demandé dans l'endpoint de création de campagne /v1/campaigns.
Conclusion
Il est possible à tout moment de récupérer les tags et familles de tags de manière programmatique via API.