Skip to content

Modifier le statut d’abonnement aux e-mails

post

/email/status

Utilisez cet endpoint pour définir l’état d’abonnement aux e-mails de vos utilisateurs.

Les utilisateurs peuvent avoir le statut opted_in, unsubscribed ou subscribed (sans confirmation d’abonnement ou de désabonnement spécifique).

Vous pouvez définir l’état d’abonnement aux e-mails pour une adresse e-mail qui n’est pas encore associée à l’un de vos utilisateurs dans Braze. Lorsque cette adresse e-mail est ensuite associée à un utilisateur, l’état d’abonnement aux e-mails que vous avez importé sera automatiquement appliqué.

Conditions préalables

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

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.

Corps de la requête

1
2
Content-Type: application/json
Authorization: Bearer YOUR-REST-API-KEY
1
2
3
4
{
  "email": "[email protected]",
  "subscription_state": "subscribed"
}

Paramètres de requête

Paramètre Requis Type de données Description
email Requis Chaîne de caractères ou tableau Adresse e-mail sous forme de chaîne de caractères à modifier, ou un tableau contenant jusqu’à 50 adresses e-mail à modifier.
subscription_state Requis Chaîne de caractères « subscribed », « unsubscribed » ou « opted_in ».

Exemple de requête

1
2
3
4
5
6
7
curl --location --request POST 'https://rest.iad-01.braze.com/email/status' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer YOUR-API-KEY-HERE' \
--data-raw '{
  "email": "[email protected]",
  "subscription_state": "subscribed"
}'
New Stuff!