Le groupe permet de siloter les différentes ressources disponibles pour les utilisateurs.
Comment récupérer par API la liste des groupes
Cet article détaille le fonctionnement de l'endpoint permettant de récupérer la liste de tous les groupes par API.
En faisant appel à l'endpoint GET /v1/settings/groups on récupère une liste de tous les groupes avec, pour chaque groupe :
- Un
id(un numéro d'identification unique) - Un
name(le nom du groupe)
Quelques exemples d'utilisations
L'identifiant de groupe est essentiel et sera requis dans diverses requêtes API. Il est utilisé notamment :
-
Dans l'URL des endpoints : Pour accéder à certains endpoints, notamment ceux des settings. par exemple :
- Lister les consentements activés sur un groupe sur l'endpoint
/settings/groups/{id}/optins - Lister les expéditeurs activés sur un groupe sur l'endpoint
/groups/{id}/senders
- Lister les consentements activés sur un groupe sur l'endpoint
-
Dans le corps des requêtes : Par exemple lors de la création d'une campagne par API
- Lors de la création d'une campagne sur l'endpoint
/campaigns - Lors de la création d'une liste sur l'endpoint
/lists - Lors de la création d'un contenu sur l'endpoint
/content
- Lors de la création d'une campagne sur l'endpoint
Conclusion
Le groupe est la clé auquel a accès chaque compte et chaque ressource.