Consulta à lista de endereços de e-mail que cancelaram inscrição

Use esse endpoint para retornar os e-mails mais recentes que cancelaram inscrição durante o período de start_date a end_date. Para obter um histórico completo do estado da inscrição, use o Currents para rastrear esses dados.

Você pode usar esse endpoint para configurar uma sincronização bidirecional entre o Braze e outros sistemas de e-mail ou seu próprio banco de dados.

Pré-requisitos

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

Limite de taxa

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

Parâmetros de solicitação

Se o seu intervalo de datas tiver mais do que limit número de cancelamentos de inscrição, será necessário fazer várias chamadas à API, aumentando sempre o offset até que uma chamada retorne menos do que limit ou zero resultados.

Exemplo de solicitação

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'

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
18
19
Content-Type: application/json
Authorization: Bearer YOUR-REST-API-KEY
{
  "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"
}