Lista los grupos de suscripción del usuario

Utiliza este punto final para listar y obtener los grupos de suscripción de un determinado usuario.

Si quieres ver ejemplos o probar este punto final para Grupos de suscripción por correo electrónico:

Si quieres ver ejemplos o probar este punto final para Grupos de Suscripción SMS:

Si quieres ver ejemplos o probar este punto final para Grupos de WhatsApp:

Requisitos previos

Para utilizar este punto final, necesitarás una clave de API con el permiso subscription.groups.get.

Límite de velocidad

Aplicamos el límite de velocidad predeterminado de Braze de 250 000 solicitudes por hora a este punto final, como se documenta en Límites de velocidad de la API.

Parámetros de la solicitud

Ejemplo de solicitud

• múltiples usuarios
• sms y whatsapp
• correo electrónico

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'

Ejemplo de respuesta

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