HomeTutorialsAPI ReferenceStatus
API Reference

Create Message

post
https://{APP_DOMAIN}/api/3.2/messages

Creates and sends or schedules an email or SMS message. For email, provide content, template, subject, sender, and segments. For SMS, provide content, numbers, and messaging service. Use splits for A/B testing.

Body Params

Body Params

integer
required

The id of the type of message to send -- email-free-style, email-article, email-renewal, email-promo, or sms-message

boolean
required
string

A future date for a scheduled message. Eg. 1970-01-01T00:00:00-00:00

string

The type of the message test or live

string

The content to send

integer

The id of the template. This only applies for email message type and is required only when there is no split.

numbers
array of integers

Required if is_test attribute is true and the message type is SMS

numbers
integer
required

Publication ID the message belongs to

string

The associated Resource ID if the message type is email-article

boolean

Whether to publish the associated Resource when the message is sent.

string

The binding on which to send the message

included_segments
array of integers

The segments to send the message to.

included_segments
excluded_segments
array of integers

The segments to exclude the message from.

excluded_segments
string

An array of emails to send a test mailing to.

subject
array of integers

The subject of a message being sent.

subject
string

The id of the sender in which a message should come from.

string

The reply sender in which the message should be sent from.

string

The preview line that will be displayed in a message.

tag_ids
array of integers

Array of tag ids to associate with Message

tag_ids
Response

Updated 22 days ago

Language
Credentials
Bearer
JWT
URL
Response 
 Choose an example:
application/json
Updated 22 days ago