Skip to content

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

get

/email/unsubscribes

Utiliza este endpoint para devolver los últimos correos electrónicos que han cancelado su suscripción 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 endpoint para configurar una sincronización bidireccional entre Braze y otros sistemas de correo electrónico o tu propia base de datos.

See me in Postman

Requisitos previos

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

Parámetros de la solicitud

Parámetro Obligatorio Tipo de datos Descripción
start_date Opcional
(ver nota)		 Cadena en formato AAAA-MM-DD Fecha de inicio del intervalo para recuperar las cancelaciones de suscripción; debe ser anterior a end_date. La API la trata como medianoche en hora UTC.
end_date Opcional
(ver nota)		 Cadena en formato AAAA-MM-DD Fecha de finalización del intervalo para recuperar las cancelaciones de suscripción. La API la trata como medianoche en hora UTC.
limit Opcional Entero Campo opcional para limitar el número de resultados devueltos. El valor predeterminado es 100, el máximo es 500.
offset Opcional Entero Punto de inicio opcional de la lista desde el que recuperar.
sort_direction Opcional Cadena Introduce el valor asc para ordenar las cancelaciones de suscripción de la más antigua a la más reciente. Introduce desc para ordenar de más reciente a más antigua. Si no se incluye sort_direction, el orden predeterminado es de más reciente a más antigua.
email Opcional
(ver nota)		 Cadena Si se proporciona, devolveremos si el usuario ha cancelado su suscripción o no.

Si tu intervalo de fechas tiene más cancelaciones de suscripción que el número indicado en limit, 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

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