Mettre à jour le statut du groupe d’abonnement de l’utilisateur (V2)

post

/v2/subscription/status/set

Utilisez cet endpoint pour mettre à jour en masse le statut d’abonnement jusqu’à 50 utilisateurs sur le tableau de bord de Braze.

Vous pouvez accéder au site subscription_group_id d’un groupe d’ abonnement en accédant à la page Groupe d’abonnements.

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 WhatsApp Groups :

See me in Postman

Pré-requis

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

Limite de débit

This endpoint has a rate limit of 5,000 requests per minute shared across the /subscription/status/set and /v2/subscription/status/set endpoint as documented in API rate limits.

Corps de la demande

Content-Type: application/json
Authorization: Bearer YOUR-REST-API-KEY

{
  "subscription_groups":[
    {
      "subscription_group_id": (required, string),
      "subscription_state": (required, string)
      "external_ids": (required*, array of strings),
      "emails": (required*, array of strings),
      "phones": (required*, array of strings in E.164 format),
    }
  ]
}

* Notez que vous ne pouvez pas inclure à la fois les paramètres emails et phones. De plus, emails, phones et external_ids peuvent tous être envoyés individuellement.

tip:

Lorsque vous créez de nouveaux utilisateurs à l’aide de l’endpoint/users/track , vous pouvez définir des groupes d’abonnement dans l’objet des attributs de l’utilisateur, ce qui vous permet de créer un utilisateur et de définir l’état du groupe d’abonnement en un seul appel d’API.

Paramètres de demande

Paramètre Requis Type de données Description

subscription_group_id Requis Chaîne de caractères L’id de votre groupe d’abonnement.

subscription_state Requis Chaîne de caractères Les valeurs disponibles sont unsubscribed (pas dans le groupe d’abonnement) ou subscribed (dans le groupe d’abonnement).

external_ids Obligatoire* Tableau de chaînes de caractères L’external_id de l’utilisateur ou des utilisateurs (50 ids max).

emails Obligatoire* Chaîne de caractères ou tableau de chaînes 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).

Si plusieurs utilisateurs (external_id) du même espace de travail partagent la même adresse e-mail, tous les utilisateurs qui partagent l’adresse e-mail sont mis à jour avec les modifications apportées au groupe d’abonnement.

phones Obligatoire* Chaîne de caractères dans E.164 format Les numéros de téléphone de l’utilisateur, peuvent être transmis comme un tableau de chaînes de caractères. Doit inclure au moins un numéro de téléphone (maximum 50).

note:

Notez que vous ne pouvez pas inclure à la fois les paramètres emails et phones. De plus, emails, phones et external_ids peuvent tous être envoyés individuellement.

Exemple de requêtes

L’exemple suivant utilise external_id pour effectuer un appel API pour les e-mails et SMS.

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
curl --location --request POST 'https://rest.iad-01.braze.com/v2/subscription/status/set' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer YOUR-REST-API-KEY' \
--data-raw '{
  "subscription_groups":[
    {
      "subscription_group_id":"subscription_group_identifier",
      "subscription_state":"subscribed",
      "external_ids":["example-user","[email protected]"]
    },
    {
      "subscription_group_id":"subscription_group_identifier",
      "subscription_state":"subscribed",
      "external_ids":["example-user","[email protected]"]
    }
  ]
}

E-mail

1
2
3
4
5
6
7
8
9
10
11
12
13
curl --location --request POST 'https://rest.iad-01.braze.com/v2/subscription/status/set' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer YOUR-REST-API-KEY' \
--data-raw '{
  "subscription_groups":[
    {
      "subscription_group_id":"subscription_group_identifier",
      "subscription_state":"subscribed",
      "emails":["[email protected]","[email protected]"]
    }
  ]
}
'

SMS et WhatsApp

curl --location --request POST 'https://rest.iad-01.braze.com/v2/subscription/status/set' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer YOUR-REST-API-KEY' \
--data-raw '{
  "subscription_groups":[
    {
      "subscription_group_id":"subscription_group_identifier",
      "subscription_state":"subscribed",
      "phones":["+12223334444","+15556667777"]
    }
  ]
}
'

Modifier cette page sur GitHub

CETTE PAGE A-T-ELLE ÉTÉ UTILE?

Modifier cette page sur GitHub

New Stuff!