Send a new message

post

https://{region}-api.dotdigital.com/cpaas/messages

Body Params

The message details and options

metadata

object

Custom metadata relating to the message. Profile data can be substituted anywhere by using the syntax {{profile.fieldName}} - example: {{profile.forename}}

object

required

Set of identifiers for the message recipient.

title

string

The title to use to describe the message (if supported by the channel). Profile data can be substituted anywhere by using the syntax {{profile.fieldName}} - example: Hello {{profile.forename}}

body

string

This is the default text based body to be used, if no body override is declared for a channel. Profile data can be substituted anywhere by using the syntax {{profile.fieldName}} - example: Hello {{profile.forename}}

templateId

string

This is the template id to be used to generate messageParts for this message

customBody

object

Custom body for specific channels. All values specified will be copied onto the payload at the point of sending. Profile data can be substituted anywhere by using the syntax {{profile.fieldName}} - example: {{profile.forename}}

overrides

object

Details of any overrides allowed for the message send on any of the channels

channelOptions

object

Configuration switches for specific channels. If a channel has a customBody as well as values in here, it will return a validation failure. Profile data can be substituted anywhere by using the syntax {{profile.fieldName}} - example: Hello {{profile.forename}}

conversationId

string

Optional conversationId, used to correlate messages within the platform and on any external channels, if supported.

expiresOn

date-time

Date/Time (in UTC, ISO 8601 format) that the should expire (if supported by the selected channel).

rules

array of strings

required

The channels to attempt for this message, in order of priority

rules*

messageParts

array of objects

(Additional) parts to be sent with the message, as native components where supported, or attachments / links.

messageParts

requireOptIn

boolean

If requireOptIn is set to true, the message will be rejected if the target profile has not opted-in to any of the specified channels

Responses

400

Validation issues were found

201The message was accepted