Atualizar o status do grupo de inscrições do usuário

Use esse endpoint para atualizar em lote o estado da inscrição de até 50 usuários no dashboard da Braze.

É possível 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 esse endpoint para grupos de inscrições para e-mail:

Se você quiser ver exemplos ou testar esse endpoint para grupos de inscrições SMS e RCS:

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 taxa de 5.000 solicitações por minuto compartilhado entre os endpoints /subscription/status/set e /v2/subscription/status/set, conforme documentado em Limites de taxa da API.

Corpo da solicitação

• sms and rcs
• email

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

1
2
3
4
5
6
7
8
{
   "subscription_group_id": (required, string) the id of your subscription group,
   "subscription_state": (required, string) available values are "unsubscribed" (not in subscription group) or "subscribed" (in subscription group),
   "external_id": (required*, array of strings) the external ID of the user or users, may include up to 50 IDs,
   "phone": (required*, array of strings in E.164 format) The phone number of the user (must include at least one phone number and at most 50 phone numbers),
   "use_double_opt_in_logic": (optional, boolean) defaults to `false`; when `subscription_state` is "subscribed", set to `true` to enter the user into the SMS double opt-in workflow,
   // SMS and RCS subscription group - you must include one of external_id or phone
 }

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

1
2
3
4
5
6
7
8
{
   "subscription_group_id": (required, string) the id of your subscription group,
   "subscription_state": (required, string) available values are "unsubscribed" (not in subscription group) or "subscribed" (in subscription group),
   "external_id": (required*, array of strings) the external ID of the user or users, may include up to 50 IDs,
   "email": (required*, array of strings) the email address of the user (must include at least one email and at most 50 emails),
   // Email subscription group - you must include one of external_id or email
   // Note that sending an email address that is linked to multiple profiles updates all relevant profiles
 }

Essa propriedade não deve ser usada para atualizar as informações de perfil de um usuário. Em vez disso, use a propriedade /users/track.

Parâmetros de solicitação

Exemplos de solicitações

E-mail

1
2
3
4
5
6
7
8
9
10
curl --location --request POST 'https://rest.iad-01.braze.com/subscription/status/set' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer YOUR-REST-API-KEY' \
--data-raw '{
  "subscription_group_id": "subscription_group_identifier",
  "subscription_state": "unsubscribed",
  "external_id": "external_identifier",
  "email": ["[email protected]", "[email protected]"]
}
'

SMS e RCS

1
2
3
4
5
6
7
8
9
10
curl --location --request POST 'https://rest.iad-01.braze.com/subscription/status/set' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer YOUR-REST-API-KEY' \
--data-raw '{
  "subscription_group_id": "subscription_group_identifier",
  "subscription_state": "unsubscribed",
  "external_id": "external_identifier",
  "phone": ["+12223334444", "+11112223333"]
}
'

Exemplo de resposta bem-sucedida

O código de status 201 poderia retornar o seguinte corpo de resposta.

1
2
3
{
    "message": "success"
}