Répertorier le statut du groupe d’abonnement de l’utilisateur

Utilisez cet endpoint pour obtenir le statut d’abonnement d’un utilisateur dans un groupe d’abonnement.

Ces groupes seront disponibles sur la page des groupes d’abonnement. La réponse de cet endpoint inclura l’ID externe et le statut abonné, désabonné, ou inconnu pour le groupe d’abonnement spécifique demandé dans l’appel d’API. Cette option permet de mettre à jour le statut du groupe d’abonnement dans les appels d’API ultérieurs ou de l’afficher sur une page Web hébergée.

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.status.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

*Chaque utilisateur doit disposer d’une des options suivantes : external_id, email ou phone.

• Pour les groupes d’abonnement aux SMS et à WhatsApp, un external_id ou un phone est nécessaire. Lorsque les deux sont soumis, seul l’external_id est utilisé pour l’interrogation et le numéro de téléphone est appliqué à cet utilisateur.
• Pour les groupes d’abonnement aux e-mails, external_id ou email est nécessaire. Lorsque les deux sont soumis, seul l’external_id est utilisé pour la requête et l’adresse e-mail est appliquée à cet utilisateur.

Exemple de demande

• utilisateurs multiples
• sms et whatsapp
• e-mail

1
https://rest.iad-03.braze.com/subscription/status/get?subscription_group_id={{subscription_group_id}}&external_id[]=1&external_id[]=2

1
2
curl --location -g --request GET 'https://rest.iad-01.braze.com/subscription/status/get?subscription_group_id={{subscription_group_id}}&phone=+11112223333' \
--header 'Authorization: Bearer YOUR-REST-API-KEY'

1
2
curl --location -g --request GET 'https://rest.iad-01.braze.com/subscription/status/get?subscription_group_id={{subscription_group_id}}&email=example@braze.com' \
--header 'Authorization: Bearer YOUR-REST-API-KEY'

Réponse

Toutes les réponses réussies renverront Subscribed, Unsubscribed, ou Unknown selon le statut et l’historique de l’utilisateur avec le groupe d’abonnement.

1
2
3
4
5
6
7
8
9
Content-Type: application/json
Authorization: Bearer YOUR-REST-API-KEY
{
  "status": {
    "1": "Unsubscribed",
    "2": "Subscribed"
  },
  "message": "success"
}