Send a transactional message - Prelude Documentation

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json

template_id

string

required

The template identifier.

string

required

The recipient's phone number.

callback_url

string

The callback URL.

correlation_id

string

A unique, user-defined identifier that will be included in webhook events.

expires_at

string

The message expiration date.

from

string

The Sender ID.

locale

string

A BCP-47 formatted locale string with the language the text message will be sent to. If there's no locale set, the language will be determined by the country code of the phone number. If the language specified doesn't exist, the default set on the template will be used.

variables

object

The variables to be replaced in the template.

Response

200 - application/json

created_at

string

required

The message creation date.

expires_at

string

required

The message expiration date.

string

required

The message identifier.

template_id

string

required

The template identifier.

string

required

The recipient's phone number.

variables

object

required

The variables to be replaced in the template.

callback_url

string

The callback URL.

correlation_id

string

A unique, user-defined identifier that will be included in webhook events.

from

string

The Sender ID.