Actualizar el estado del grupo de suscripción del usuario (V2)

post

/v2/subscription/status/set

Utilice este punto final para actualizar por lotes el estado de suscripción de hasta 50 usuarios en el panel Braze.

Puede acceder a la página subscription_group_id de un grupo de suscripción accediendo a la página Grupo de suscripciones.

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

See me in Postman

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

See me in Postman

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

See me in Postman

Requisitos previos

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

Límite de velocidad

Este punto final tiene un límite de velocidad de 5000 solicitudes por minuto compartido entre los puntos /subscription/status/set y /v2/subscription/status/set, tal y como se documenta en Límites de velocidad de la API.

Cuerpo de la solicitud

Content-Type: application/json
Authorization: Bearer YOUR-REST-API-KEY

{
  "subscription_groups":[
    {
      "subscription_group_id": (required, string),
      "subscription_state": (required, string)
      "external_ids": (required*, array of strings),
      "emails": (required*, array of strings),
      "phones": (required*, array of strings in E.164 format),
    }
  ]
}

* Tenga en cuenta que no puede incluir los parámetros emails y phones. Además, emails, phones y external_ids pueden enviarse individualmente.

tip:

Al crear nuevos usuarios utilizando el punto final/users/track , puedes establecer grupos de suscripción dentro del objeto de atributos de usuario, lo que te permite crear un usuario y establecer el estado del grupo de suscripción en una sola llamada a la API.

Parámetros de la solicitud

Parámetro Obligatoria Tipo de datos Descripción

subscription_group_id Obligatoria Cadena La dirección id de su grupo de suscripción.

subscription_state Obligatoria Cadena Los valores disponibles son unsubscribed (no en el grupo de suscripción) o subscribed (en el grupo de suscripción).

external_ids Requerido* Matriz de cadenas El external_id del usuario o usuarios, puede incluir hasta 50 ids.

emails Requerido* Cadena o matriz de cadenas La dirección de correo electrónico del usuario, se puede pasar como una matriz de cadenas. Debe incluir al menos una dirección de correo electrónico (con un máximo de 50).

Si varios usuarios (external_id) del mismo espacio de trabajo comparten la misma dirección de correo electrónico, todos los usuarios que comparten la dirección de correo electrónico se actualizan con los cambios del grupo de suscripción.

phones Requerido* Cadena en E.164 formato Los números de teléfono del usuario, se pueden pasar como una matriz de cadenas. Debe incluir al menos un número de teléfono (hasta 50).

Si varios usuarios (external_id) del mismo espacio de trabajo comparten el mismo número de teléfono, todos los usuarios que comparten el número de teléfono se actualizan con los mismos cambios de grupo de suscripción.

use_double_opt_in_logic Opcional Booleano Si este parámetro se omite o se establece en false, los usuarios no entrarán en el flujo de trabajo de doble adhesión voluntaria por SMS.

note:

Tenga en cuenta que no puede incluir los parámetros emails y phones. Además, emails, phones y external_ids pueden enviarse individualmente.

Ejemplos de solicitudes

En el siguiente ejemplo, se utiliza external_id para realizar una llamada API para correo electrónico y SMS.

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
curl --location --request POST 'https://rest.iad-01.braze.com/v2/subscription/status/set' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer YOUR-REST-API-KEY' \
--data-raw '{
  "subscription_groups":[
    {
      "subscription_group_id":"subscription_group_identifier",
      "subscription_state":"subscribed",
      "external_ids":["example-user","[email protected]"]
    },
    {
      "subscription_group_id":"subscription_group_identifier",
      "subscription_state":"subscribed",
      "external_ids":["example-user","[email protected]"]
    }
  ]
}

Correo electrónico

1
2
3
4
5
6
7
8
9
10
11
12
13
curl --location --request POST 'https://rest.iad-01.braze.com/v2/subscription/status/set' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer YOUR-REST-API-KEY' \
--data-raw '{
  "subscription_groups":[
    {
      "subscription_group_id":"subscription_group_identifier",
      "subscription_state":"subscribed",
      "emails":["[email protected]","[email protected]"]
    }
  ]
}
'

SMS y WhatsApp

curl --location --request POST 'https://rest.iad-01.braze.com/v2/subscription/status/set' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer YOUR-REST-API-KEY' \
--data-raw '{
  "subscription_groups":[
    {
      "subscription_group_id":"subscription_group_identifier",
      "subscription_state":"subscribed",
      "phones":["+12223334444","+15556667777"]
    }
  ]
}
'

Editar esta página en GitHub

¿QUÉ TAN ÚTIL FUE ESTA PÁGINA?

Editar esta página en GitHub

New Stuff!