Consultar lista de direcciones de correo electrónico dadas de baja

Utiliza este endpoint para devolver los últimos correos electrónicos que se han dado de baja durante el periodo de tiempo comprendido entre start_date y end_date. Para obtener un historial completo del estado de la suscripción, utiliza Currents para hacer un seguimiento de estos datos.

Puedes utilizar este punto final para configurar una sincronización bidireccional entre Braze y otros sistemas de correo electrónico o tu propia base de datos.

Requisitos previos

Para utilizar este punto final, necesitarás una clave de API con el permiso email.unsubscribe.

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

Si tu intervalo de fechas tiene más de limit número de cancelaciones de suscripción, tendrás que hacer varias llamadas a la API, aumentando cada vez el offset hasta que una llamada devuelva menos de limit o cero resultados.

Ejemplo de solicitud

1
2
curl --location --request GET 'https://rest.iad-01.braze.com/email/unsubscribes?start_date=2020-01-01&end_date=2020-02-01&limit=1&offset=1&sort_direction=desc&[email protected]' \
--header 'Authorization: Bearer YOUR-API-KEY-HERE'

Respuesta

Las entradas aparecen en orden descendente.

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
Content-Type: application/json
Authorization: Bearer YOUR-REST-API-KEY
{
  "emails": [
    {
      "email": (string) an email that has been unsubscribed,
      "unsubscribed_at": (string) the time the email was unsubscribed in ISO 8601
    },
    {
      "email": (string) an email that has been unsubscribed,
      "unsubscribed_at": (string) the time the email was unsubscribed in ISO 8601
    },
    {
      "email": (string) an email that has been unsubscribed,
      "unsubscribed_at": (string) the time the email was unsubscribed in ISO 8601
    }
  ],
  "message": "success"
}