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

We apply the default Braze rate limit of 250,000 requests per hour to this endpoint, as documented in API rate limits.

Paramètres de demande

Si votre plage de dates dépasse le nombre limit d’échecs d’envoi définitifs, vous devrez effectuer plusieurs appels d’API, en augmentant à chaque fois le offset jusqu’à ce qu’un appel renvoie un résultat 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 demande

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&email=example@braze.com' \
--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
18
19
Content-Type: application/json
Authorization: Bearer YOUR-REST-API-KEY
{
  "emails": [
    {
      "email": (string) an email that has hard bounced,
      "unsubscribed_at": (string) the time the email hard bounced in ISO 8601
    },
    {
      "email": (string) an email that has hard bounced,
      "unsubscribed_at": (string) the time the email hard bounced in ISO 8601
    },
    {
      "email": (string) an email that has hard bounced,
      "unsubscribed_at": (string) the time the email hard bounced in ISO 8601
    }
  ],
  "message": "success"
}