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

post

/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:

See me in Postman

Se você quiser ver exemplos ou testar este endpoint para Grupos de Inscrição de SMS:

See me in Postman

Se você quiser ver exemplos ou testar este endpoint para Grupos de WhatsApp:

See me in Postman

Pré-requisitos

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

Limite de taxa

This endpoint has a rate limit of 5,000 requests per minute shared across the /subscription/status/set and /v2/subscription/status/set endpoint as documented in API rate limits.

Corpo da solicitação

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

{
  "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.

tip:

Ao criar novos usuários através do /users/track endpoint, você pode definir grupos de inscrições dentro do objeto de atributos 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 (com um máximo de 50).

note:

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]"]
    }
  ]
}

E-mail

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

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

QUÃO ÚTIL FOI ESTA PÁGINA?

Editar esta página no GitHub

New Stuff!