Mise à jour des Canvases déclenchées par l’API planifiée

Utilisez cet endpoint pour mettre à jour des Canvas déclenchés par API planifiés qui ont été créés dans le tableau de bord.

Vous pouvez ainsi décider de l’action qui déclenche l’envoi du message. Vous pouvez intégrer trigger_properties que Braze modélise dans le message lui-même.

Notez que pour envoyer des messages avec ce point de terminaison, vous devez avoir un ID Canvas, créé lorsque vous construisez un Canvas.

Toute planification écrasera complètement celle que vous avez établie dans la demande de création de planification ou dans les demandes de mise à jour de planification précédentes.

• Par exemple, si vous indiquez initialement "schedule" : {"time" : "2015-02-20T13:14:47", "in_local_time" : true} puis "schedule" : {"time" : "2015-02-20T14:14:47"} dans votre mise à jour, Braze envoie votre message à l’heure indiquée en UTC, et non à l’heure locale de l’utilisateur.
• Les déclencheurs planifiés que vous mettez à jour à proximité ou pendant l’heure à laquelle ils étaient censés être envoyés sont mis à jour dans la mesure du possible, de sorte que Braze peut appliquer des modifications de dernière seconde à tous les utilisateurs ciblés, à certains d’entre eux ou à aucun d’entre eux.

Conditions préalables

Pour utiliser cet endpoint, vous aurez besoin d’une clé API avec l’autorisation canvas.trigger.schedule.update.

Limite de débit

Nous appliquons la limitation du débit Braze par défaut de 250 000 requêtes par heure à cet endpoint, comme documenté dans Limites de débit de l’API.

Corps de la demande

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
  }
}

Paramètres de demande

Exemple de demande

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
  }
}'