Skip to content

Requête de la liste des adresses e-mail désabonnées

get

/email/unsubscribes

Utilisez cet endpoint pour renvoyer les derniers e-mails désabonnés pendant la période allant de start_date à end_date. Pour un historique complet de l’état d’abonnement, utilisez Currents pour suivre ces données.

Vous pouvez utiliser cet endpoint pour configurer une synchronisation bidirectionnelle entre Braze et d’autres systèmes de messagerie ou votre propre base de données.

See me in Postman

Conditions préalables

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

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
start_date Facultatif
(voir la note)		 Chaîne de caractères au format AAAA-MM-JJ Date de début de la plage de récupération des désabonnements, qui doit être antérieure à end_date. L’API considère que cette date correspond à minuit (heure UTC).
end_date Facultatif
(voir la note)		 Chaîne de caractères au format AAAA-MM-JJ Date de fin de la plage de récupération des désabonnements. L’API considère que cette date correspond à minuit (heure UTC).
limit Facultatif Entier Champ facultatif pour limiter le nombre de résultats renvoyés. La valeur par défaut est 100, le maximum est 500.
offset Facultatif Entier Point de départ facultatif dans la liste à partir duquel récupérer les résultats.
sort_direction Facultatif Chaîne de caractères Indiquez la valeur asc pour trier les désabonnements du plus ancien au plus récent. Indiquez la valeur desc pour trier du plus récent au plus ancien. Si sort_direction n’est pas inclus, l’ordre par défaut est du plus récent au plus ancien.
email Facultatif
(voir la note)		 Chaîne de caractères Si ce paramètre est fourni, l’endpoint indiquera si l’utilisateur s’est désabonné ou non.

Si votre plage de dates contient plus de désabonnements que la valeur limit, vous devrez effectuer plusieurs appels API en augmentant à chaque fois le offset, jusqu’à ce qu’un appel renvoie un nombre de résultats inférieur à limit ou égal à zéro.

Exemple de requête

1
2

curl --location --request GET 'https://rest.iad-01.braze.com/email/unsubscribes?start_date=2020-01-01&end_date=2020-02-01&limit=1&offset=1&sort_direction=desc&[email protected]' \
--header 'Authorization: Bearer YOUR-API-KEY-HERE'

Réponse

Les entrées sont répertoriées par ordre décroissant.

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17

{
  "emails": [
    {
      "email": (string) an email that has been unsubscribed,
      "unsubscribed_at": (string) the time the email was unsubscribed in ISO 8601
    },
    {
      "email": (string) an email that has been unsubscribed,
      "unsubscribed_at": (string) the time the email was unsubscribed in ISO 8601
    },
    {
      "email": (string) an email that has been unsubscribed,
      "unsubscribed_at": (string) the time the email was unsubscribed in ISO 8601
    }
  ],
  "message": "success"
}
New Stuff!