Delete Scheduled API-Triggered Canvases

post

/canvas/trigger/schedule/delete

The delete schedule endpoint allows you to cancel a message that you previously scheduled API-triggered Canvases before it has been sent.

Request Body

Scheduled messages or triggers that are deleted very close to or during the time they were supposed to be sent will be updated with best efforts, so last-second deletions could be applied to all, some, or none of your targeted users.

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

Request Parameters

Parameter Required Data Type Description
canvas_id Required String See Canvas identifier.
schedule_id Required String The schedule_id to delete (obtained from the response to create schedule).

Example Request

1
2
3
4
5
6
7
8
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"
}
'
WAS THIS PAGE HELPFUL?
New Stuff!