Skip to main content
POST
Send a program a template message to send at a specific time

Headers

x-api-key
string
required

API key needed to authorize the request

Body

application/json

The payload to send with the template message.

scheduledDate
string
required

The date and time of the message in ISO 8601 format

templateId
string<uuid>
required

The template id of the message (uuid)

contactIdentifier
string
required

The phone number of the contact

channel
enum<string>
required

The channel of the message

Available options:
whatsapp,
web-whatsapp
content
default:[]

Array of strings representing the variables of the message. AI will use the content to generate the variables

contactName
string

The name of the contact

Minimum string length: 1
channelId
string

The channel id of the message (uuid)

isSmart
boolean

If true, the message will be sent as a smart message (AI will use the content to generate the variables)

fromPhoneNumber
string

The phone number of the sender

stageId
string<uuid>

The stage id to assign the contact to (uuid)

meta_data
object

Additional contact metadata (key-value pairs that will be stored as contact custom fields)

Response

201 - undefined