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

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

É possível acessar o site subscription_group_id de um grupo de inscrições navegando até a página Grupo de inscrições.

Para ver exemplos ou testar este endpoint para Grupos de Inscrição por E-mail:

Para ver exemplos ou testar este endpoint para Grupos de Inscrição por SMS:

Para ver exemplos ou testar este endpoint para Grupos de WhatsApp:

Pré-requisitos

Para usar este endpoint, você precisa de uma chave de API com a permissão subscription.status.set.

Diferenças em relação ao V1

O endpoint V2 difere do endpoint V1 das seguintes maneiras:

• Vários grupos de inscrições: O V2 permite que você atualize vários grupos de inscrições em uma única solicitação de API, enquanto o V1 suporta apenas um grupo de inscrições por solicitação.
• Atualizar tanto e-mail quanto SMS em uma chamada: Ao usar external_ids, você pode atualizar tanto os grupos de inscrições por e-mail quanto por SMS para os mesmos usuários em uma única chamada de API. Com o V1, você deve fazer chamadas de API separadas para grupos de inscrições por e-mail e SMS.
• Usando identificadores de e-mail ou telefone: Se você usar emails ou phones em vez de external_ids, não poderá atualizar tanto os grupos de inscrições por e-mail quanto por SMS na mesma solicitação. Você deve fazer chamadas de API separadas—uma para grupos de inscrições por e-mail e uma para grupos de inscrições por SMS.

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),
    }
  ]
}

Parâmetros de solicitação

Exemplos de solicitações

O seguinte exemplo usa external_ids para atualizar tanto os grupos de inscrições de e-mail quanto os de SMS em uma única chamada de API. Isso só é possível ao usar external_ids—você não pode atualizar tanto os grupos de inscrições de e-mail quanto os de SMS em uma chamada ao usar emails ou phones.

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

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