Delete Scheduled API Triggered Campaigns

post

/campaigns/trigger/schedule/delete

The delete schedule endpoint allows you to cancel a message that you previously scheduled API Triggered Campaigns 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
{
  "campaign_id": (required, string) the Campaign Identifier,
  "schedule_id": (required, string) the schedule_id to delete (obtained from the response to create schedule)
}

Request Parameters

Parameter Required Data Type Description
campaign_id Required String See Campaign Identifier
schedule_id Required String The schedule_id to delete (obtained from the response to create schedule)

Request Components

Example Request

1
2
3
4
5
6
7
8
curl --location --request POST 'https://rest.iad-01.braze.com/campaigns/trigger/schedule/delete' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer YOUR_REST_API_KEY' \
--data-raw '{
  "campaign_id": "123456789",
  "schedule_id": "123456789"
}
'
WAS THIS PAGE HELPFUL?
New Stuff!