Update scheduled API-triggered campaigns

Use this endpoint to update scheduled API-triggered campaigns created in the dashboard, allowing you to decide what action should trigger the message to be sent.

You can pass in trigger_properties that will be templated into the message itself.

Note that to send messages with this endpoint, you must have a campaign ID, created when you build an API-Triggered Campaign.

Any schedule will completely overwrite the one you provided in the create schedule request or previous update schedule requests. For example, if you originally set the schedule to "schedule" : {"time" : "2015-02-20T13:14:47", "in_local_time" : true} and then later update it to "schedule" : {"time" : "2015-02-20T14:14:47"}, the message will now be sent at the specified time in UTC, not in the user’s local time.

Scheduled triggers that are updated very close to or during the time they were supposed to be sent will be updated with best efforts so that last-second changes can be applied to all, some, or none of your targeted users. Updates aren’t applied if the original schedule used local time and the original time has already passed in any time zone.

Prerequisites

To use this endpoint, you’ll need an API key with the campaigns.trigger.schedule.update permission.

Rate limit

We apply the default Braze rate limit of 250,000 requests per hour to this endpoint, as documented in API rate limits.

Request body

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

Request parameters

Example request

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