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

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

Estes grupos estarão disponíveis na página do grupo de inscrições. A resposta deste endpoint incluirá o ID externo e “subscribed”, “unsubscribed” ou “unknown” para o grupo de inscrições específico solicitado na chamada da API. Isso pode ser usado para atualizar o estado do grupo de inscrições em chamadas subsequentes da 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ção de 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.status.get.

Limite de taxa

We apply the default Braze rate limit of 250,000 requests per hour to this endpoint, as documented in API rate limits.

Parâmetros de solicitação

Um de external_id ou email ou phone é necessário para cada usuário.

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

Exemplo de solicitação

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

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'

1
2
curl --location -g --request GET 'https://rest.iad-01.braze.com/subscription/status/get?subscription_group_id={{subscription_group_id}}&[email protected]' \
--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
8
9
Content-Type: application/json
Authorization: Bearer YOUR-REST-API-KEY
{
  "status": {
    "1": "Unsubscribed",
    "2": "Subscribed"
  },
  "message": "success"
}