Alterar o status da inscrição de e-mail

Use esse endpoint para definir o estado da inscrição de e-mail para seus usuários.

Os usuários podem ser opted_in, unsubscribed, ou subscribed (sem aceitação ou exclusão específica).

É possível definir o estado da inscrição de e-mail para um endereço de e-mail que ainda não esteja associado a nenhum de seus usuários no Braze. Quando esse endereço de e-mail for posteriormente associado a um usuário, o estado de inscrição de e-mail que você enviou ficará automaticamente definido.

Pré-requisitos

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

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.

Corpo da solicitação

1
2
Content-Type: application/json
Authorization: Bearer YOUR-REST-API-KEY

1
2
3
4
{
  "email": "example@braze.com",
  "subscription_state": "subscribed"
}

Parâmetros de solicitação

Exemplo de solicitação

1
2
3
4
5
6
7
curl --location --request POST 'https://rest.iad-01.braze.com/email/status' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer YOUR-API-KEY-HERE' \
--data-raw '{
  "email": "example@braze.com",
  "subscription_state": "subscribed"
}'