Skip to content

Consulta de e-mails hard bounce

get

/email/hard_bounces

Use esse endpoint para obter uma lista de endereços de e-mail que sofreram “hard bounce” nas suas mensagens de e-mail dentro de um determinado período de tempo.

See me in Postman

Pré-requisitos

Para usar esse endpoint, você precisará de uma chave de API com a permissão email.hard_bounces.

Limite de taxa

Aplicamos o limite de taxa padrão da Braze de 250.000 solicitações por hora a esse endpoint, conforme documentado em Limites de taxa da API.

Parâmetros de solicitação

Parâmetro Obrigatória Tipo de dados Descrição
start_date Opcional* String no formato YYYY-MM-DD *É necessário start_date ou email. Essa é a data de início do intervalo para recuperar hard bounces e deve ser anterior a end_date. Isso é tratado como meia-noite no horário UTC pela API.
end_date Obrigatória String no formato YYYY-MM-DD Data final do intervalo para recuperar hard bounces. Isso é tratado como meia-noite no horário UTC pela API.
limit Opcional Inteiro Campo opcional para limitar o número de resultados retornados. O padrão é 100, o máximo é 500.
offset Opcional Inteiro Ponto inicial opcional na lista a ser recuperado.
email Opcional* String *É necessário start_date ou email. Se fornecido, retornaremos se o usuário sofreu hard bounce ou não. Verifique se as strings de e-mail estão formatadas corretamente.

Se o seu intervalo de datas tiver mais do que o número limit de hard bounces, será necessário fazer várias chamadas à API, aumentando a cada vez o offset até que uma chamada retorne menos do que limit ou zero resultados. A inclusão dos parâmetros offset e limit com email pode retornar uma resposta vazia.

Exemplo de solicitação

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'

Resposta

As entradas são listadas em ordem decrescente.

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!