Actualización de campañas programadas activadas por API
Utilice este punto final para actualizar las campañas programadas activadas por API creadas en el panel de control, permitiéndole decidir qué acción debe activar el envío del mensaje.
Puede introducir trigger_properties
, que se incluirá como plantilla en el propio mensaje.
Tenga en cuenta que para enviar mensajes con este punto final, debe tener un ID de campaña, creado al crear una campaña activada por API.
Cualquier programación sobrescribirá completamente la que hayas proporcionado en la solicitud de crear programación o en las solicitudes de actualización de programación anteriores. Por ejemplo, si originalmente configuraste el horario a "schedule" : {"time" : "2015-02-20T13:14:47", "in_local_time" : true}
y más tarde lo actualizas a "schedule" : {"time" : "2015-02-20T14:14:47"}
, el mensaje se enviará ahora a la hora especificada 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 para que los cambios de último momento puedan aplicarse a todos, a algunos o a ninguno de tus usuarios objetivo. Las actualizaciones no se aplican si la programación original utilizaba la hora local y la hora original ya ha pasado en cualquier zona horaria.
Requisitos previos
Para utilizar este punto final, necesitarás una clave de API con el permiso campaigns.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
{
"campaign_id": (required, string) see campaign 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
Parámetro | Obligatoria | Tipo de datos | Descripción |
---|---|---|---|
campaign_id |
Obligatoria | Cadena | Ver identificador de campaña |
schedule_id |
Obligatoria | Cadena | El schedule_id a actualizar (obtenido de la respuesta para crear un horario). |
schedule |
Obligatoria | Objeto | Ver objeto de programación. |
Ejemplo de solicitud
1
2
3
4
5
6
7
8
9
10
11
curl --location --request POST 'https://rest.iad-01.braze.com/campaigns/trigger/schedule/update' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer YOUR-REST-API-KEY' \
--data-raw '{
"campaign_id": "campaign_identifier",
"schedule_id": "schedule_identifier",
"schedule": {
"time": "2017-05-24T21:30:00Z",
"in_local_time": true
}
}'