Atualizar o status do grupo de inscrições do usuário (V2)
/v2/subscription/status/set
Use este endpoint para atualizar em lote o estado de inscrição de até 50 usuários no dashboard do Braze.
Você pode acessar o subscription_group_id de um grupo de inscrições navegando até a página Grupo de Inscrições.
Se você quiser ver exemplos ou testar este endpoint para Grupos de Inscrição de E-mail:
Se você quiser ver exemplos ou testar este endpoint para Grupos de Inscrição de SMS:
Se você quiser ver exemplos ou testar este endpoint para Grupos do WhatsApp:
Pré-requisitos
Para usar esse endpoint, você precisará de uma chave de API com a permissão subscription.status.set.
Limite de taxa
Esse endpoint tem um limite de frequência de 5.000 solicitações por minuto compartilhado entre os endpoints /subscription/status/set e /v2/subscription/status/set, conforme documentado em Limites de frequência da API.
Corpo da solicitação
1
2
Content-Type: application/json
Authorization: Bearer YOUR-REST-API-KEY
1
2
3
4
5
6
7
8
9
10
11
{
"subscription_groups":[
{
"subscription_group_id": (required, string),
"subscription_state": (required, string)
"external_ids": (required*, array of strings),
"emails": (required*, array of strings),
"phones": (required*, array of strings in E.164 format),
}
]
}
* Você não pode incluir ambos os parâmetros emails e phones. Além disso, emails, phones e external_ids podem ser enviados individualmente.
Ao criar novos usuários usando o endpoint /users/track , é possível definir grupos de inscrições no objeto de atribuições do usuário, o que permite criar um usuário e definir o estado do grupo de inscrições em uma única chamada de API.
Parâmetros de solicitação
| Parâmetro | Obrigatória | Tipo de dados | Descrição |
|---|---|---|---|
subscription_group_id |
Obrigatória | String | O id do seu grupo de inscrições. |
subscription_state |
Obrigatória | String | Os valores disponíveis são unsubscribed (não está no grupo de inscrições) ou subscribed (está no grupo de inscrições). |
external_ids |
Obrigatório* | Array de strings | O external_id do usuário ou usuários pode incluir até 50 ids. |
emails |
Obrigatório* | string ou array de strings | O endereço de e-mail do usuário pode ser passado como um vetor de strings. Deve incluir pelo menos um endereço de e-mail (com um máximo de 50). Se vários usuários ( external_id) no mesmo espaço de trabalho compartilharem o mesmo e-mail, todos os usuários que compartilham o e-mail são atualizados com as mudanças do grupo de inscrições. |
phones |
Obrigatório* | string em E.164 formato | Os números de telefone do usuário podem ser passados como um vetor de strings. Deve incluir pelo menos um número de telefone (até 50). Se vários usuários ( external_id) no mesmo espaço de trabalho compartilharem o mesmo número de telefone, todos os usuários que compartilham o número de telefone serão atualizados com as mesmas alterações no grupo de inscrições. |
use_double_opt_in_logic |
Opcional | Booleano | Se esse parâmetro for omitido ou definido como false, os usuários não serão inseridos no fluxo de trabalho de aceitação dupla de SMS. |
Você não pode incluir ambos os parâmetros emails e phones. Além disso, emails, phones e external_ids podem ser enviados individualmente.
Exemplos de solicitações
O exemplo a seguir usa external_id para fazer uma chamada de API para e-mail e SMS.
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
curl --location --request POST 'https://rest.iad-01.braze.com/v2/subscription/status/set' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer YOUR-REST-API-KEY' \
--data-raw '{
"subscription_groups":[
{
"subscription_group_id":"subscription_group_identifier",
"subscription_state":"subscribed",
"external_ids":["example-user","[email protected]"]
},
{
"subscription_group_id":"subscription_group_identifier",
"subscription_state":"subscribed",
"external_ids":["example-user","[email protected]"]
}
]
}
1
2
3
4
5
6
7
8
9
10
11
12
13
curl --location --request POST 'https://rest.iad-01.braze.com/v2/subscription/status/set' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer YOUR-REST-API-KEY' \
--data-raw '{
"subscription_groups":[
{
"subscription_group_id":"subscription_group_identifier",
"subscription_state":"subscribed",
"emails":["[email protected]","[email protected]"]
}
]
}
'
SMS e WhatsApp
1
2
3
4
5
6
7
8
9
10
11
12
13
curl --location --request POST 'https://rest.iad-01.braze.com/v2/subscription/status/set' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer YOUR-REST-API-KEY' \
--data-raw '{
"subscription_groups":[
{
"subscription_group_id":"subscription_group_identifier",
"subscription_state":"subscribed",
"phones":["+12223334444","+15556667777"]
}
]
}
'
Editar esta página no GitHub