Create Scheduled Messages
POST https://{{instance_url}}/messages/schedule/create
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.
Request Parameters
| Parameter | Required | Data Type | Description |
|---|---|---|---|
broadcast | Optional | Boolean | See broadcast -- defaults to false on 8/31/17, must be set to true if recipientsobject is omitted |
external_user_ids | Optional | Array of strings | See external user identifier |
user_aliases | Optional | Array of user alias objects | See user alias object |
audience | Optional | Connected audience object | See connected audience |
segment_id | Optional | String | See segment identifier |
campaign_id | Required | String | See campaign identifier |
recipients | Optional | Array of recipient objects | See recipients object |
send_id | Optional | String | See send identifier |
override_messaging_limits | Optional | Boolean | Ignore global rate limits for campaigns, defaults to false |
recipient_subscription_state | Optional | String | Use 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'), the latter being useful for transactional email messaging. Defaults to 'subscribed' |
schedule | Required | Schedule object | See schedule object |
messages | Optional | Messaging object | See messaging object |
Request Components
- Broadcast
- User Alias Object
- Connected Audience
- Segment Identifier
- Campaign Identifier
- Schedule Object
- API Parameters