BrazeEx.Api.MessagingScheduleMesages (braze_ex v1.0.4)

API calls for all endpoints tagged MessagingScheduleMesages.

Link to this section Summary

Functions

Schedule API Triggered Campaigns

Use this endpoint to trigger API-triggered campaigns, which are created on the dashboard and initiated via the API. You can pass in trigger_properties that will be templated into the message itself.

Delete Scheduled API Triggered Campaigns

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

Update Scheduled API Triggered Campaigns

Use this endpoint to update scheduled API Triggered Campaigns, which are created on the Dashboard and initiated via the API. You can pass in trigger_properties that will be templated into the message itself.

Schedule API Triggered Canvases

Use this endpoint to trigger API Triggered Canvases, which are created on the Dashboard and initiated via the API. You can pass in canvas_entry_properties that will be templated into the messages sent by the first steps of the Canvas.

Delete Scheduled API-Triggered Canvases

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

Update Scheduled API Triggered Canvases

Use this endpoint to update scheduled API-Triggered Canvases, which are created on the dashboard and initiated via the API. You can pass in trigger_properties that will be templated into the message itself.

Create Scheduled Messages

Use this endpoint to send messages directly from the API.

Delete Scheduled Messages

The delete scheduled messages endpoint allows you to cancel a message that you previously scheduled before it has been sent.

Update Scheduled Messages

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

Get Upcoming Scheduled Campaigns and Canvases

You can view a JSON list of upcoming and scheduled Campaigns and Canvases using the following information and parameters. The endpoint will return information about scheduled Campaigns and entry Canvases between now and the designated end_time (ISO 8601 format) 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.

Link to this section Functions

Link to this function

campaigns_trigger_schedule_create_post(connection, opts \\ [])

@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 trigger API-triggered campaigns, which are created on the dashboard and initiated via the API. You can pass in trigger_properties that will be templated into the message itself.

This endpoint allows you to send campaign messages (up to 90 days in advance) via API-triggered delivery, allowing you to decide what action should trigger the message to be sent. Note that to send messages with this endpoint, you must have a Campaign ID, created when you build an API-Triggered Campaign.

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

ParameterRequiredData TypeDescription
campaign_idRequiredStringSee campaign identifier
send_idOptionalStringSee send identifier.
recipientsOptionalArray of recipient objectsSee recipients object.
audienceOptionalConnected audience objectSee connected audience.
broadcastOptionalBooleanSee broadcast. This parameter defaults to false (as of August 31, 2017). <br><br> If recipients is omitted, broadcast must be set to true. However, use caution when setting broadcast: true, as unintentionally setting this flag may cause you to send your message to a larger than expected audience.
trigger_propertiesOptionalObjectPersonalization key-value pairs for all users in this send. See trigger properties.
scheduleRequiredSchedule objectSee schedule object.

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
Link to this function

campaigns_trigger_schedule_delete_post(connection, opts \\ [])

@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 Campaigns 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.

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

ParameterRequiredData TypeDescription
campaign_idRequiredStringSee campaign identifier.
schedule_idRequiredStringThe schedule_id to delete (obtained from the response to create schedule).

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
Link to this function

campaigns_trigger_schedule_update_post(connection, opts \\ [])

@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, which are created on the Dashboard and initiated via the API. You can pass in trigger_properties that will be templated into the message itself.

This endpoint allows you to send Campaign messages via API Triggered delivery, allowing you to decide what action should trigger the message to be sent. Please 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.

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

ParameterRequiredData TypeDescription
campaign_idRequiredStringSee campaign identifier
schedule_idOptionalStringThe schedule_id to update (obtained from the response to create schedule).
scheduleRequiredObjectSee schedule object.

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
Link to this function

canvas_trigger_schedule_create_post(connection, opts \\ [])

@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 trigger API Triggered Canvases, which are created on the Dashboard and initiated via the API. You can pass in canvas_entry_properties that will be templated into the messages sent by the first steps of the Canvas.

This endpoint allows you to schedule Canvas messages (up to 90 days in advance) via API Triggered delivery, allowing you to decide what action should trigger the message to be sent. Please note that to send messages with this endpoint, you must have a Canvas ID, created when you build a Canvas.

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

ParameterRequiredData TypeDescription
canvas_idRequiredStringSee Canvas identifier.
send_idOptionalStringSee send identifier.
recipientsOptionalArray of recipient objectsSee recipients object.
audienceOptionalConnected audience objectSee connected audience.
broadcastOptionalBooleanSee broadcast. This parameter defaults to false (as of August 31, 2017). <br><br> If recipients is omitted, broadcast must be set to true. However, use caution when setting broadcast: true, as unintentionally setting this flag may cause you to send your message to a larger than expected audience.
trigger_propertiesOptionalObjectPersonalization key-value pairs for all users in this send. See trigger properties.
scheduleRequiredSchedule objectSee schedule object.

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
Link to this function

canvas_trigger_schedule_delete_post(connection, opts \\ [])

@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

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.

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.

ParameterRequiredData TypeDescription
canvas_idRequiredStringSee Canvas identifier.
schedule_idRequiredStringThe schedule_id to delete (obtained from the response to create schedule).

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
Link to this function

canvas_trigger_schedule_update_post(connection, opts \\ [])

@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, which are created on the dashboard and initiated via the API. You can pass in trigger_properties that will be templated into the message itself.

This endpoint allows you to update scheduled Canvas messages via API-Triggered delivery, allowing you to decide what action should trigger the message to be sent. Please 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.

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

ParameterRequiredData TypeDescription
canvas_idRequiredStringSee Canvas identifier.
schedule_idOptionalStringThe schedule_id to update (obtained from the response to create schedule).
scheduleRequiredObjectSee schedule object.

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
Link to this function

messages_schedule_create_post(connection, opts \\ [])

@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 send messages directly from the API.

The create schedule endpoint allows you to schedule a Campaign, Canvas, or other message to be sent at a designated time (up to 90 days in the future) 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.

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

ParameterRequiredData TypeDescription
broadcastOptionalBooleanSee broadcast. This parameter defaults to false (as of August 31, 2017). <br> <br>If recipients is omitted, broadcast must be set to true. However, use caution when setting broadcast: true, as unintentionally setting this flag may cause you to send your message to a larger than expected audience.
external_user_idsOptionalArray of stringsSee external user identifier.
user_aliasesOptionalArray of user alias objectsSee user alias object.
audienceOptionalConnected audience objectSee connected audience.
segment_idOptionalStringSee segment identifier.
campaign_idRequiredStringSee campaign identifier.
recipientsOptionalArray of recipients objectsSee recipients object.
send_idOptionalStringSee send identifier.
override_messaging_limitsOptionalBooleanIgnore global rate limits for campaigns, defaults to false
recipient_subscription_stateOptionalStringUse this to send messages to only users who have opted in (opted_in), only users who have subscribed or are opted in (subscribed) or to all users, including unsubscribed users (all). <br> <br>Using all users is useful for transactional email messaging. Defaults to subscribed.
scheduleRequiredSchedule objectSee schedule object
messagesOptionalMessaging objectSee available messaging objects.

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
Link to this function

messages_schedule_delete_post(connection, opts \\ [])

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

delete-scheduled-messages

Delete Scheduled Messages

The delete scheduled messages endpoint allows you to cancel a message that you previously scheduled before it has been sent.

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

ParameterRequiredData TypeDescription
schedule_idRequiredStringThe schedule_id to delete (obtained from the response to create schedule).

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
Link to this function

messages_schedule_update_post(connection, opts \\ [])

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

update-scheduled-messages

Update Scheduled Messages

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

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

ParameterRequiredData TypeDescription
schedule_idRequiredStringThe schedule_id to update (obtained from the response to create schedule).
scheduleOptionalObjectSee schedule object.
messagesOptionalObjectSee available message objects.

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
Link to this function

messages_scheduled_broadcasts_get(connection, opts \\ [])

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

get-upcoming-scheduled-campaigns-and-canvases

Get Upcoming Scheduled Campaigns and Canvases

You can view a JSON list of upcoming and scheduled Campaigns and Canvases using the following information and parameters. The endpoint will return information about scheduled Campaigns and entry Canvases between now and the designated end_time (ISO 8601 format) 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.

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": [
    # Example Canvas
    {
      "name" => String,
      "id" => String,
      "type" => "Canvas",
      "tags" => [String tag names],
      "next_send_time" => "YYYY-MM-DD HH:mm:ss" (may also include time zone if not local/intelligent delivery)
      "schedule_type" => one of "local_time_zones", "intelligent_delivery", or the name of your company's time zone
    },
    # Example Campaign
    {
      "name" => String,
      "id" => String,
      "type" => "Campaign",
      "tags" => [String tag names],
      "next_send_time" => "YYYY-MM-DD HH:mm:ss" (may also include time zone if not local/intelligent delivery)
      "schedule_type" => one of "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