Skip to content

Lista de grupos de suscripción del usuario

get

/subscription/user/status

Utiliza este punto de conexión para listar y obtener los grupos de suscripción con el historial de un determinado usuario.

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

See me in Postman

Si quieres ver ejemplos o probar este punto de conexión para grupos de suscripción SMS:

See me in Postman

Si quieres ver ejemplos o probar este punto de conexión para grupos de WhatsApp:

See me in Postman

Requisitos previos

Para utilizar este punto de conexión, 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 de conexión, como se documenta en Límites de velocidad de la API.

Parámetros de la solicitud

Parámetro Obligatorio Tipo de datos Descripción
external_id Obligatorio Cadena El external_id del usuario (debe incluir al menos uno y como máximo 50 external_ids).
email Obligatorio* Cadena La dirección de correo electrónico del usuario, puede pasarse como una matriz de cadenas. Debe incluir al menos una dirección de correo electrónico (con un máximo de 50).
phone Obligatorio* Cadena en formato E.164 El número de teléfono del usuario. Debe incluir al menos un número de teléfono (con un máximo de 50).
limit Opcional Entero El límite del número máximo de resultados devueltos. El limit predeterminado (y máximo) es 100.
offset Opcional Entero Número de plantillas que saltar antes de devolver el resto de plantillas que se ajustan a los criterios de búsqueda.

Ejemplo de solicitud

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

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'

Ejemplo de respuesta

Solo se incluirán en una respuesta correcta los grupos de suscripción que hayan tenido una actualización del estado de suscripción en el historial de un usuario. Esto significa que los grupos de suscripción recién creados no aparecerán en la lista.

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43

{
    "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"
}
New Stuff!