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

get

/subscription/user/status

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

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 do WhatsApp:

See me in Postman

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

Parâmetro Obrigatória Tipo de dados Descrição

external_id Obrigatória String O external_id do usuário (deve incluir no mínimo um e no máximo 50 external_ids).

email Obrigatório* String O endereço de e-mail do usuário pode ser passado como uma matriz de strings. Deve incluir pelo menos um endereço de e-mail (com um máximo de 50).

phone Obrigatório* string no E.164 formato O número de telefone do usuário. Deve incluir pelo menos um número de telefone (com um máximo de 50).

limit Opcional Inteiro O limite do número máximo de resultados retornados. O limit padrão (e máximo) é 100.

offset Opcional Inteiro Número de modelos a serem ignorados antes de retornar o restante dos modelos que atendem aos critérios de pesquisa.

tip:

Se houver vários usuários (vários external_ids) que compartilham o mesmo endereço de e-mail, todos os usuários serão retornados como um usuário separado (mesmo que tenham o mesmo endereço de e-mail ou grupo de inscrições).

Exemplo de solicitação

https://rest.iad-03.braze.com/subscription/user/status?external_id[]=1&external_id[]=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

Somente os grupos de inscrições que tiveram uma atualização de status de inscrição no histórico de um usuário serão incluídos em uma resposta bem-sucedida. Isso significa que os grupos de inscrições recém-criados não serão listados.

{
    "users": [
        {
            "email": "[email protected]",
            "phone": "50505050",
            "external_id": "20500",
            "subscription_groups": [
                {
                  "id": "ec2fcc919fca",
                  "name": "ActivationGroup",
                  "channel": "email",
                  "status": "Subscribed"
                },
                {
                  "id": "7d7af9dd5556",
                  "name": "ReactivationGroup",
                  "channel": "email",
                  "status": "Subscribed"
                },
                {
                  "id": "a5e84fd16220",
                  "name": "MarketingGroup",
                  "channel": "sms",
                  "status": "Unsubscribed"
                },
                {
                  "id": "64d8cad9176c",
                  "name": "TransactionalGroup",
                  "channel": "sms",
                  "status": "Unsubscribed"
                },
                {
                  "id": "b2134cd63942",
                  "name": "BankerMarketingGroup",
                  "channel": "sms",
                  "status": "Subscribed"
                }
            ]
        }
    ],
    "total_count": 1,
    "message": "success"
}

Editar esta página no GitHub

New Stuff!