Send a message

post

https://api.splio.com/messaging/v1/{universe_id}/messages

Send emails to recipients

Body Params

channel

string

enum

required

Today, only the email channel is upported.

Allowed:

idempotency_key

string

This key must be used if you want to avoid duplicates. When receiving 2 calls with the same idempotency key, we refuse the second call. Can also be used by the sender to identify a specific message.

properties

object

required

recipients

array of objects

required

Recipients type must be coherent within a same call. The first recipient type matched is considered as the one used for all the recipients.

recipients*

transactional

boolean

When 'true', the message will be considered as transactional. It means that it will bypass some optins and blacklists. Warning: in the case of a marketing message, you cannot communicate with a contact which is not optin, and so not use this option.

metadata

object

Those metadata are used to aggregate the events for statistics purposes

variables

object

Those variables will be applied to all the messages in this sending. They are used to personalize the messages but won't modify the contacts in database.

Responses

Language

Credentials

Bearer

token

URL

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200MessageEvent sending request approved

400Wrong payload