Esta página foi traduzida automaticamente e pode conter imprecisões. Para relatar um erro de tradução, use o componente de feedback na parte inferior do sumário, à direita da página.
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 na 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 será automaticamente definido.
Pré-requisitos
Para usar esse endpoint, você precisará de uma chave de API com a permissão email.status.
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.
Corpo da solicitação
1
2
Content-Type: application/json
Authorization: Bearer YOUR-REST-API-KEY
1
2
3
4
{
"email": "[email protected]",
"subscription_state": "subscribed"
}
Parâmetros de solicitação
| Parâmetro | Obrigatória | Tipo de dados | Descrição |
|---|---|---|---|
email |
Obrigatória | String ou matriz | Endereço de e-mail em string para modificar ou uma matriz de até 50 endereços de e-mail para modificar. |
subscription_state |
Obrigatória | String | “subscribed”, “unsubscribed” ou “opted_in”. |
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": "[email protected]",
"subscription_state": "subscribed"
}'
New Stuff!