Répertorier les groupes d’abonnement de l’utilisateur
/subscription/user/status
Utilisez cet endpoint pour répertorier et obtenir les groupes d’abonnement d’un utilisateur donné.
Si vous souhaitez voir des exemples ou tester cet endpoint pour les groupes d’abonnement e-mail:
Si vous souhaitez voir des exemples ou tester cet endpoint pour les groupes d’abonnement SMS:
Si vous souhaitez voir des exemples ou tester cet endpoint pour WhatsApp Groups :
Conditions préalables
Pour utiliser cet endpoint, vous aurez besoin d’une clé API avec l’autorisation subscription.groups.get.
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.
Paramètres de demande
| Paramètre | Requis | Type de données | Description |
|---|---|---|---|
external_id |
Requis | Chaîne de caractères | L’external_id de l’utilisateur (maximum 50 external_ids, minimum 1). |
email |
Obligatoire* | Chaîne de caractères | L’adresse e-mail de l’utilisateur peut être transmise comme un tableau de chaînes de caractères. Doit inclure au moins une adresse e-mail (maximum 50). |
phone |
Obligatoire* | Chaîne de caractères dans E.164 format | Le numéro de téléphone de l’utilisateur. Doit inclure au moins un numéro de téléphone (maximum 50). |
limit |
Facultatif | Entier | La limite du nombre maximum de résultats renvoyés. La limit par défaut (et au maximum) est de 100. |
offset |
Facultatif | Entier | Nombre de modèles à ignorer avant de renvoyer le reste des modèles qui correspondent aux critères de recherche. |
S’il existe plusieurs utilisateurs (plusieurs external_ids) qui partagent la même adresse e-mail, tous les utilisateurs seront renvoyés en tant qu’utilisateurs distincts (même s’ils ont la même adresse e-mail ou le même groupe d’abonnement).
Exemple de demande
https://rest.iad-03.braze.com/subscription/user/status?external_id[]=1&external_id[]=2
1
2
curl --location -g --request GET 'https://rest.iad-01.braze.com/subscription/user/status?external_id={{external_id}}&limit=100&offset=1&phone=+11112223333' \
--header 'Authorization: Bearer YOUR-REST-API-KEY'
1
2
curl --location -g --request GET 'https://rest.iad-01.braze.com/subscription/user/status?external_id={{external_id}}&email=example@braze.com&limit=100&offset=0' \
--header 'Authorization: Bearer YOUR-REST-API-KEY'
Exemple de réponse
1
2
3
4
5
6
7
8
9
10
11
12
13
{
"success": true,
"subscription_groups": [
{
"subscription_group_id": "group_id_1",
"subscription_status": "subscribed"
},
{
"subscription_group_id": "group_id_2",
"subscription_status": "unsubscribed"
}
]
}
Modifier cette page sur GitHub