Skip to content

Listar status do grupo de inscrições do usuário

get

/subscription/status/get

Use este endpoint para obter o estado de inscrição de um usuário em um grupo de inscrições.

Esses grupos estarão disponíveis na página do Grupo de inscrições. A resposta deste endpoint incluirá o ID externo e o status subscribed, unsubscribed ou unknown para o grupo de inscrições específico solicitado na chamada de API. Isso pode ser usado para atualizar o estado do grupo de inscrições em chamadas subsequentes de API ou para ser exibido em uma página da web hospedada.

Se você quiser ver exemplos ou testar este endpoint para grupos de inscrições para e-mail:

See me in Postman

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

See me in Postman

Se você quiser ver exemplos ou testar este endpoint para grupos do WhatsApp:

See me in Postman

Pré-requisitos

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

Limite de taxa

Aplicamos o limite de taxa padrão da Braze de 250.000 solicitações por hora a esse endpoint, conforme documentado em Limites de taxa da 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.
external_id Obrigatória* String O external_id do usuário (deve incluir pelo menos um e no máximo 50 external_ids).

Quando um external_id e email/phone são enviados juntos, apenas os external_id(s) fornecidos serão aplicados à consulta de resultado.
email Obrigatória* String O endereço de e-mail do usuário. Pode ser passado como um array de strings com no máximo 50.

Enviar tanto um endereço de e-mail quanto um número de telefone (sem external_id) resultará em um erro.
phone Obrigatória* String no formato E.164 O número de telefone do usuário. Se o e-mail não estiver incluído, você deve incluir pelo menos um número de telefone (com no máximo 50).

Enviar tanto um endereço de e-mail quanto um número de telefone (sem external_id) resultará em um erro.

*Um entre external_id, email ou phone é obrigatório para cada usuário.

  • Para grupos de inscrições de SMS e WhatsApp, é necessário external_id ou phone. Quando ambos são enviados, apenas o external_id é usado para a consulta e o número de telefone é aplicado a esse usuário.
  • Para grupos de inscrições para e-mail, é necessário external_id ou email. Quando ambos são enviados, apenas o external_id é usado para a consulta e o endereço de e-mail é aplicado a esse usuário.

Exemplo de solicitação

1

https://rest.iad-03.braze.com/subscription/status/get?subscription_group_id={{subscription_group_id}}&external_id[]=1&external_id[]=2

1
2

curl --location -g --request GET 'https://rest.iad-01.braze.com/subscription/status/get?subscription_group_id={{subscription_group_id}}&phone=+11112223333' \
--header 'Authorization: Bearer YOUR-REST-API-KEY'

Resposta

Todas as respostas bem-sucedidas retornarão Subscribed, Unsubscribed ou Unknown dependendo do status e do histórico do usuário com o grupo de inscrições.

1
2
3
4
5
6
7

{
  "status": {
    "1": "Unsubscribed",
    "2": "Subscribed"
  },
  "message": "success"
}
New Stuff!