Skip to content

Répertorier les Groupes d’abonnement d’un utilisateur

get

/subscription/user/status

Utilisez cet endpoint pour répertorier et obtenir les Groupes d’abonnement avec l’historique d’un utilisateur donné.

Si vous souhaitez voir des exemples ou tester cet endpoint pour les Groupes d’abonnement e-mail :

See me in Postman

Si vous souhaitez voir des exemples ou tester cet endpoint pour les Groupes d’abonnement SMS :

See me in Postman

Si vous souhaitez voir des exemples ou tester cet endpoint pour les groupes WhatsApp :

See me in Postman

Conditions préalables

Pour utiliser cet endpoint, vous aurez besoin d’une clé API avec l’autorisation subscription.groups.get.

Limite de débit

La limite de débit par défaut de Braze de 250 000 requêtes par heure s’applique à cet endpoint, comme documenté dans Limites de débit de l’API.

Paramètres de requête

Paramètre Requis Type de données Description
external_id Requis Chaîne de caractères L’external_id de l’utilisateur (doit inclure au moins un et au maximum 50 external_ids).
email Requis* Chaîne de caractères L’adresse e-mail de l’utilisateur, qui peut être transmise sous forme de tableau de chaînes de caractères. Doit inclure au moins une adresse e-mail (maximum 50).
phone Requis* Chaîne de caractères au format E.164 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 maximale) est de 100.
offset Facultatif Entier Nombre de modèles à ignorer avant de renvoyer le reste des modèles correspondant aux critères de recherche.

Exemple de requête

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'

Exemple de réponse

Seuls les groupes d’abonnement dont le statut d’abonnement a été mis à jour dans l’historique de l’utilisateur seront inclus dans une réponse réussie. Cela signifie que les groupes d’abonnement nouvellement créés ne seront pas répertoriés.

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43

{
    "users": [
        {
            "email": "[email protected]",
            "phone": "50505050",
            "external_id": "20500",
            "subscription_groups": [
                {
                  "id": "ec2fcc919fca",
                  "name": "ActivationGroup",
                  "channel": "email",
                  "status": "Subscribed"
                },
                {
                  "id": "7d7af9dd5556",
                  "name": "ReactivationGroup",
                  "channel": "email",
                  "status": "Subscribed"
                },
                {
                  "id": "a5e84fd16220",
                  "name": "MarketingGroup",
                  "channel": "sms",
                  "status": "Unsubscribed"
                },
                {
                  "id": "64d8cad9176c",
                  "name": "TransactionalGroup",
                  "channel": "sms",
                  "status": "Unsubscribed"
                },
                {
                  "id": "b2134cd63942",
                  "name": "BankerMarketingGroup",
                  "channel": "sms",
                  "status": "Subscribed"
                }
            ]
        }
    ],
    "total_count": 1,
    "message": "success"
}
New Stuff!