Skip to content

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

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.

Parâmetros de solicitação

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","example1@email.com"]
    },
    {
      "subscription_group_id":"subscription_group_identifier",
      "subscription_state":"subscribed",
      "external_ids":["example-user","example1@email.com"]
    }
  ]
}

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":["example1@email.com","example2@email.com"]
    }
  ]
}
'

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"]
    }
  ]
}
'
Github   Editar esta página no GitHub
QUÃO ÚTIL FOI ESTA PÁGINA?
New Stuff!