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

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

Puedes acceder al subscription_group_id de un grupo de suscripción navegando a la página Grupo de suscripción.

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

Para ver ejemplos o probar este punto de conexión para grupos de suscripción por SMS:

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

Requisitos previos

Para utilizar este punto de conexión, necesitas una clave de API con el permiso subscription.status.set.

Diferencias con respecto a la versión 1

El punto de conexión V2 difiere del punto de conexión V1 en los siguientes aspectos:

• Múltiples grupos de suscripción: La versión 2 te permite actualizar varios grupos de suscripción en una sola solicitud de API, mientras que la versión 1 solo admite un grupo de suscripción por solicitud.
• Actualiza tanto el correo electrónico como el SMS en una sola llamada: Al utilizar external_ids, puedes actualizar los grupos de suscripción por correo electrónico y SMS para los mismos usuarios en una sola llamada a la API. Con la versión V1, debes realizar llamadas API independientes para los grupos de suscripción por correo electrónico y SMS.
• Uso de identificadores de correo electrónico o teléfono: Si utilizas emails o phones en lugar de external_ids, no podrás actualizar los grupos de suscripción por correo electrónico y SMS en la misma solicitud. Debes realizar llamadas API separadas: una para los grupos de suscripción por correo electrónico y otra para los grupos de suscripción por SMS.

Límite de velocidad

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

Cuerpo de la solicitud

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

1
2
3
4
5
6
7
8
9
10
11
12
{
  "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),
      "use_double_opt_in_logic": (optional, boolean)
    }
  ]
}

Parámetros de la solicitud

Ejemplos de solicitudes

El siguiente ejemplo utiliza external_ids para actualizar los grupos de suscripción por correo electrónico y SMS en una sola llamada a la API. Esto solo es posible cuando se utiliza external_ids; no se pueden actualizar los grupos de suscripción por correo electrónico y SMS en una sola llamada cuando se utiliza emails o phones.

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

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",
      "phones":["+12223334444","+15556667777"]
    }
  ]
}
'