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

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.

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

Important

Vous devez fournir un end_date, ainsi qu’un email ou un start_date. Si vous fournissez les trois, à savoir start_date, end_date et email, nous donnerons la priorité aux e-mails communiqués et ignorerons la plage de dates.

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"
}