Supprimer des Canvas planifiés déclenchés par API

L’endpoint de suppression de la planification vous permet d’annuler un message que vous avez précédemment planifié dans des Canvas déclenchés par API avant qu’il ne soit envoyé.

Les messages planifiés ou les déclencheurs qui sont supprimés à proximité ou pendant la période où ils étaient censés être envoyés sont mis à jour au mieux, de sorte que Braze peut appliquer des suppressions de dernière seconde à tous, à certains ou à aucun de vos utilisateurs ciblés.

Conditions préalables

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

Limite de débit

La limite de débit par défaut de Braze de 250 000 requêtes par heure s’applique à 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
{
  "canvas_id": (required, string) the Canvas identifier,
  "schedule_id": (required, string) the `schedule_id` to delete (obtained from the response to create schedule)
}

Paramètres de demande

Exemple de demande

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