Borrar Lienzos programados desencadenados por la API

El punto final para eliminar la programación te permite cancelar un mensaje que hayas programado antes a través de Canvas desencadenados por API antes de que se haya enviado.

Los mensajes programados o desencadenados que se borren muy cerca de la hora a la que debían enviarse, o durante la misma, se actualizarán con los mejores esfuerzos, por lo que los borrados de último segundo podrían aplicarse a todos, a algunos o a ninguno de tus usuarios objetivo.

Requisitos previos

Para utilizar este punto final, necesitarás una clave de API con el permiso canvas.trigger.schedule.delete.

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.

Cuerpo de la solicitud

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

1
2
3
4
{
  "canvas_id": (required, string) the Canvas identifier,
  "schedule_id": (required, string) the `schedule_id` to delete (obtained from the response to create schedule)
}

Parámetros de la solicitud

Ejemplo de solicitud

1
2
3
4
5
6
7
curl --location --request POST 'https://rest.iad-01.braze.com/canvas/trigger/schedule/delete' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer YOUR-REST-API-KEY' \
--data-raw '{
  "canvas_id": "canvas_identifier",
  "schedule_id": "schedule_identifier"
}'