Listar os grupos de inscrições do usuário

Use esse ponto de extremidade para listar e obter os grupos de inscrições de um determinado usuário.

Se você quiser ver exemplos ou testar esse endpoint para grupos de inscrições para 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.groups.get.

Limite de taxa

Aplicamos o limite de frequência padrão da Braze de 250.000 solicitações por hora a esse endpoint, conforme documentado em Limites de frequência da API.

Parâmetros de solicitação

Exemplo de solicitação

• vários usuários
• sms e whatsapp
• e-mail

1
2
curl --location -g --request GET 'https://rest.iad-01.braze.com/subscription/user/status?external_id={{external_id}}&limit=100&offset=1&phone=+11112223333' \
--header 'Authorization: Bearer YOUR-REST-API-KEY'

1
2
curl --location -g --request GET 'https://rest.iad-01.braze.com/subscription/user/status?external_id={{external_id}}&[email protected]&limit=100&offset=0' \
--header 'Authorization: Bearer YOUR-REST-API-KEY'

Exemplo de resposta

1
2
3
4
5
6
7
8
9
10
11
12
13
{
  "success": true,
  "subscription_groups": [
    {
      "subscription_group_id": "group_id_1",
      "subscription_status": "subscribed"
    },
    {
      "subscription_group_id": "group_id_2",
      "subscription_status": "unsubscribed"
    }
  ]
}