Actualizar lienzos programados desencadenados por la API

Utiliza este punto final para actualizar los Lienzos programados desencadenados por la API que se crearon en el panel.

Esto te permite decidir qué acción debe desencadenar el envío del mensaje. Puedes introducir trigger_properties, que se incluirá como plantilla en el propio mensaje.

Ten en cuenta que para enviar mensajes con este punto final, debes tener un ID de Canvas, creado cuando construyes un Canvas.

Cualquier horario sobrescribirá completamente el que hayas proporcionado en la solicitud de crear horario o en anteriores solicitudes de actualizar horario.

• Por ejemplo, si originalmente proporciona "schedule" : {"time" : "2015-02-20T13:14:47", "in_local_time" : true} y luego en su actualización proporciona "schedule" : {"time" : "2015-02-20T14:14:47"}, su mensaje ahora se enviará a la hora proporcionada en UTC, no en la hora local del usuario.
• Los desencadenantes programados que se actualicen muy cerca de la hora a la que debían enviarse, o durante la misma, se actualizarán con el máximo esfuerzo, por lo que los cambios de último segundo podrían aplicarse a todos, a algunos o a ninguno de sus usuarios objetivo.

Requisitos previos

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

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
5
6
7
{
  "canvas_id": (required, string) see Canvas identifier,
  "schedule_id": (required, string) the `schedule_id` to update (obtained from the response to create schedule),
  "schedule": {
    // required, see create schedule documentation
  }
}

Parámetros de la solicitud

Ejemplo de solicitud

1
2
3
4
5
6
7
8
9
10
11
curl --location --request POST 'https://rest.iad-01.braze.com/canvas/trigger/schedule/update' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer YOUR-REST-API-KEY' \
--data-raw '{
  "canvas_id": "canvas_identifier",
  "schedule_id": "schedule_identifier",
  "schedule": {
    "time": "2017-05-24T21:30:00Z",
    "in_local_time": true
  }
}'