@spec campaigns_trigger_schedule_create_post(
  Tesla.Env.client(),
  keyword()
) :: {:ok, nil} | {:error, Tesla.Env.t()}

schedule-api-triggered-campaigns

Schedule API Triggered Campaigns

Use this endpoint to send dashboard created campaign messages via API-triggered delivery, 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.

prerequisites

Prerequisites

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

rate-limit

Rate limit

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

Braze endpoints support batching API requests. A single request to the messaging endpoints can reach any of the following:

• Up to 50 specific external_ids, each with individual message parameters
• A segment of any size created in the Braze dashboard, specified by its segment_id
• An ad-hoc audience segment of any size, defined in the request as a Connected Audience object

request-parameters

Request parameters

response

Response

example-success-response

Example success response

Content-Type: application/json
Authorization: Bearer YOUR-API-KEY-HERE
{
{
  "dispatch_id": "dispatch_identifier",
  "schedule_id": "schedule_identifier",
  "message": "success"
}

parameters

Parameters

• connection (BrazeEx.Connection): Connection to server
• opts (keyword): Optional parameters
  • :"Content-Type" (String.t):
  • :Authorization (String.t):
  • :body (String.t):

returns

Returns

• {:ok, nil} on success
• {:error, Tesla.Env.t} on failure

@spec campaigns_trigger_schedule_delete_post(
  Tesla.Env.client(),
  keyword()
) :: {:ok, nil} | {:error, Tesla.Env.t()}

delete-scheduled-api-triggered-campaigns

Delete Scheduled API Triggered Campaigns

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

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.

prerequisites

Prerequisites

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

rate-limit

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

Request parameters

parameters

Parameters

• connection (BrazeEx.Connection): Connection to server
• opts (keyword): Optional parameters
  • :"Content-Type" (String.t):
  • :Authorization (String.t):
  • :body (String.t):

returns

Returns

• {:ok, nil} on success
• {:error, Tesla.Env.t} on failure

@spec campaigns_trigger_schedule_update_post(
  Tesla.Env.client(),
  keyword()
) :: {:ok, nil} | {:error, Tesla.Env.t()}

update-scheduled-api-triggered-campaigns

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 that you provided in the create schedule request or in previous update schedule requests. For example, if you originally provide "schedule" : {"time" : "2015-02-20T13:14:47", "in_local_time" : true} and then in your update you provide "schedule" : {"time" : "2015-02-20T14:14:47"}, your message will now be sent at the provided 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 last-second changes could be applied to all, some, or none of your targeted users.

prerequisites

Prerequisites

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

rate-limit

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

Request parameters

example-request

Example request

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

parameters

Parameters

• connection (BrazeEx.Connection): Connection to server
• opts (keyword): Optional parameters
  • :"Content-Type" (String.t):
  • :Authorization (String.t):
  • :body (String.t):

returns

Returns

• {:ok, nil} on success
• {:error, Tesla.Env.t} on failure

@spec canvas_trigger_schedule_create_post(
  Tesla.Env.client(),
  keyword()
) :: {:ok, nil} | {:error, Tesla.Env.t()}

schedule-api-triggered-canvases

Schedule API Triggered Canvases

Use this endpoint to schedule Canvas messages via API-triggered delivery, allowing you to decide what action should trigger the message to be sent.

You can pass in canvas_entry_properties that will be templated into the messages sent by the first steps of the Canvas.

Note that to send messages with this endpoint, you must have a Canvas ID created when you build a Canvas.

prerequisites

Prerequisites

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

rate-limit

Rate limit

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

Braze endpoints support batching API requests. A single request to the messaging endpoints can reach any of the following:

• Up to 50 specific external_ids, each with individual message parameters
• A segment of any size created in the Braze dashboard, specified by its segment_id
• An ad-hoc audience segment of any size, defined in the request as a Connected Audience object

request-parameters

Request parameters

parameters

Parameters

• connection (BrazeEx.Connection): Connection to server
• opts (keyword): Optional parameters
  • :"Content-Type" (String.t):
  • :Authorization (String.t):
  • :body (String.t):

returns

Returns

• {:ok, nil} on success
• {:error, Tesla.Env.t} on failure

@spec canvas_trigger_schedule_delete_post(
  Tesla.Env.client(),
  keyword()
) :: {:ok, nil} | {:error, Tesla.Env.t()}

delete-scheduled-api-triggered-canvases

Delete Scheduled API-Triggered Canvases

Use this endpoint to cancel a Canvas message that you previously scheduled via API-triggered before it has been sent.

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.

prerequisites

Prerequisites

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

rate-limit

Rate limit

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

parameters

Parameters

• connection (BrazeEx.Connection): Connection to server
• opts (keyword): Optional parameters
  • :"Content-Type" (String.t):
  • :Authorization (String.t):
  • :body (map()):

returns

Returns

• {:ok, nil} on success
• {:error, Tesla.Env.t} on failure

@spec canvas_trigger_schedule_update_post(
  Tesla.Env.client(),
  keyword()
) :: {:ok, nil} | {:error, Tesla.Env.t()}

update-scheduled-api-triggered-canvases

Update Scheduled API Triggered Canvases

Use this endpoint to update scheduled API-triggered Canvases that were created in the dashboard.

This allows 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 Canvas ID, created when you build a Canvas.

Any schedule will completely overwrite the one that you provided in the create schedule request or in previous update schedule requests. For example, if you originally provide "schedule" : {"time" : "2015-02-20T13:14:47", "in_local_time" : true} and then in your update you provide "schedule" : {"time" : "2015-02-20T14:14:47"}, your message will now be sent at the provided 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 last-second changes could be applied to all, some, or none of your targeted users.

prerequisites

Prerequisites

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

rate-limit

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

Request body

Content-Type: application/json
Authorization: Bearer YOUR-REST-API-KEY

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

request-parameters

Request parameters

parameters

Parameters

• connection (BrazeEx.Connection): Connection to server
• opts (keyword): Optional parameters
  • :"Content-Type" (String.t):
  • :Authorization (String.t):
  • :body (String.t):

returns

Returns

• {:ok, nil} on success
• {:error, Tesla.Env.t} on failure

@spec messages_schedule_create_post(
  Tesla.Env.client(),
  keyword()
) :: {:ok, nil} | {:error, Tesla.Env.t()}

create-scheduled-messages

Create Scheduled Messages

Use this endpoint to schedule a campaign, Canvas, or other message to be sent at a designated time and provides you with an identifier to reference that message for updates.

If you are targeting a segment, a record of your request will be stored in the Developer Console after all scheduled messages have been sent.

prerequisites

Prerequisites

To use this endpoint, you’ll need an API key with the messages.schedule.create permission.

rate-limit

Rate limit

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

Braze endpoints support batching API requests. A single request to the messaging endpoints can reach any of the following:

• Up to 50 specific external_ids, each with individual message parameters
• A segment of any size created in the Braze dashboard, specified by its segment_id
• An ad-hoc audience segment of any size, defined in the request as a Connected Audience object

request-parameters

Request parameters

response

Response

example-success-response

Example success response

{
  "dispatch_id": (string) the dispatch identifier,
  "schedule_id": (string) the schedule identifier,
  "message": "success"
}

parameters

Parameters

• connection (BrazeEx.Connection): Connection to server
• opts (keyword): Optional parameters
  • :body (map()):

returns

Returns

• {:ok, nil} on success
• {:error, Tesla.Env.t} on failure

@spec messages_schedule_delete_post(
  Tesla.Env.client(),
  keyword()
) :: {:ok, nil} | {:error, Tesla.Env.t()}

delete-scheduled-messages

Delete Scheduled Messages

Use this endpoint to cancel a message that you previously scheduled before it has been sent.

prerequisites

Prerequisites

To use this endpoint, you’ll need an API key with the messages.schedule.delete permission.

rate-limit

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

Request parameters

parameters

Parameters

• connection (BrazeEx.Connection): Connection to server
• opts (keyword): Optional parameters
  • :"Content-Type" (String.t):
  • :Authorization (String.t):
  • :body (String.t):

returns

Returns

• {:ok, nil} on success
• {:error, Tesla.Env.t} on failure

@spec messages_schedule_update_post(
  Tesla.Env.client(),
  keyword()
) :: {:ok, nil} | {:error, Tesla.Env.t()}

update-scheduled-messages

Update Scheduled Messages

Use this endpoint to update scheduled messages.

This endpoint accepts updates to either the schedule or messages parameter or both. Your request must contain at least one of those two keys.

prerequisites

Prerequisites

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

rate-limit

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

Request parameters

example-request

Example request

curl --location --request POST 'https://rest.iad-01.braze.com/messages/schedule/update' --header 'Content-Type: application/json' --header 'Authorization: Bearer YOUR-REST-API-KEY' --data-raw '{
"schedule_id": "schedule_identifier",
"schedule": {
  "time": "2017-05-24T20:30:36Z"
 },
"messages": {
  "apple_push": {
    "alert": "Updated Message!",
    "badge": 1
  },
  "android_push": {
    "title": "Updated title!",
    "alert": "Updated message!"
  },
  "sms": {  
    "subscription_group_id": "subscription_group_identifier",
    "message_variation_id": "message_variation_identifier",
    "body": "This is my SMS body.",
    "app_id": "app_identifier"
  }
}
}'

parameters

Parameters

• connection (BrazeEx.Connection): Connection to server
• opts (keyword): Optional parameters
  • :"Content-Type" (String.t):
  • :Authorization (String.t):
  • :body (String.t):

returns

Returns

• {:ok, nil} on success
• {:error, Tesla.Env.t} on failure

@spec messages_scheduled_broadcasts_get(
  Tesla.Env.client(),
  keyword()
) :: {:ok, nil} | {:error, Tesla.Env.t()}

list-upcoming-scheduled-campaigns-and-canvases

List Upcoming Scheduled Campaigns and Canvases

Use this endpoint to return a JSON list of information about scheduled campaigns and entry Canvases between now and a designated end_time specified in the request.

Daily, recurring messages will only appear once with their next occurrence. Results returned in this endpoint are only for campaigns and Canvases created and scheduled in Braze.

prerequisites

Prerequisites

To use this endpoint, you’ll need an API key with the messages.schedule_broadcasts permission.

rate-limit

Rate limit

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

response

Response

Content-Type: application/json
Authorization: Bearer YOUR-REST-API-KEY
{
"scheduled_broadcasts": [
  {
    "name" (string) the name of the scheduled boradcast,
    "id" (stings) the Canvas or campaign identifier,
    "type" (string) the broadcast type either Canvas or Campaign,
    "tags" (array) an array of tag names formatted as strings,
    "next_send_time" (string) The next send time formatted in ISO 8601, may also include time zone if not local/intelligent delivery,
    "schedule_type" (string) The schedule type, either local_time_zones, intelligent_delivery or the name of your company's time zone,
  },
]
}

parameters

Parameters

• connection (BrazeEx.Connection): Connection to server
• opts (keyword): Optional parameters
  • :Authorization (String.t):
  • :end_time (String.t): (Required) String in ISO 8601 format End date of the range to retrieve upcoming scheduled Campaigns and Canvases. This is treated as midnight in UTC time by the API.

returns

Returns

• {:ok, nil} on success
• {:error, Tesla.Env.t} on failure