Skip to content

Extraire les e-mails ayant reçu un échec d’envoi définitif

get

/email/hard_bounces

Utilisez cet endpoint pour extraire une liste d’adresses e-mail ayant rejeté définitivement vos e-mails au cours d’une certaine période.

See me in Postman

Conditions préalables

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

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* Chaîne de caractères au format AAAA-MM-JJ *L’un des paramètres start_date ou email est requis. Il s’agit de la date de début de la plage de récupération des échecs d’envoi définitifs, qui doit être antérieure à end_date. L’API traite cette valeur comme minuit (UTC).
end_date Requis Chaîne de caractères au format AAAA-MM-JJ Date de fin de la période d’extraction des échecs d’envoi définitifs. L’API traite cette valeur comme minuit (UTC).
limit Facultatif Entier Champ facultatif permettant de 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.
email Facultatif* Chaîne de caractères *L’un des paramètres start_date ou email est requis. Si ce paramètre est fourni, nous indiquerons si l’utilisateur a fait l’objet d’un échec d’envoi définitif. Vérifiez que les chaînes d’e-mails sont correctement formatées.

Si votre plage de dates contient plus d’échecs d’envoi définitifs 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. L’inclusion des paramètres offset et limit avec email peut renvoyer une réponse vide.

Exemple de requête

1
2

curl --location --request GET 'https://rest.iad-01.braze.com/email/hard_bounces?start_date=2019-01-01&end_date=2019-02-01&limit=100&offset=1' \
--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 hard bounced,
      "hard_bounced_at": (string) the time the email hard bounced in ISO 8601
    },
    {
      "email": (string) an email that has hard bounced,
      "hard_bounced_at": (string) the time the email hard bounced in ISO 8601
    },
    {
      "email": (string) an email that has hard bounced,
      "hard_bounced_at": (string) the time the email hard bounced in ISO 8601
    }
  ],
  "message": "success"
}
New Stuff!