Skip to content

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

get

/email/unsubscribes

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 a Braze e outros sistemas de e-mail ou seu próprio banco de dados.

See me in Postman

Pré-requisitos

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

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
(ver nota)		 String no formato YYYY-MM-DD Data de início do intervalo para recuperar cancelamentos de inscrição; deve ser anterior a end_date. A API trata essa data como meia-noite no horário UTC.
end_date Opcional
(ver nota)		 String no formato YYYY-MM-DD Data final do intervalo para recuperar cancelamentos de inscrição. A API trata essa data como meia-noite no horário UTC.
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.
sort_direction Opcional String Passe o valor asc para classificar os cancelamentos de inscrição do mais antigo para o mais recente. Passe desc para classificar do mais recente para o mais antigo. Se sort_direction não estiver incluído, a ordem padrão será do mais recente para o mais antigo.
email Opcional
(ver nota)		 String Se fornecido, retornaremos se o usuário cancelou ou não a inscrição.

Se o seu intervalo de datas tiver mais do que limit cancelamentos de inscrição, será necessário fazer várias chamadas à API, aumentando o offset a cada vez 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

{
  "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"
}
New Stuff!