POST
/
messages
/
phone-number
{
  "messageId": "123e4567-e89b-12d3-a456-426614174000",
  "status": "queued",
  "channel": "whatsapp",
  "contactId": "7c11e821-c839-4c3d-8a89-1f78b71a0c38"
}

Authorizations

x-api-key
string
header
required

Body

application/json
Message details including customer ID, phone number, and template ID

Request model for sending a message to a phone number using a template

customerId
string
required

Unique identifier of the customer

phoneNumber
string
required

Phone number in E.164 format

templateId
string
required

Unique identifier of the message template

Response

200
application/json
Message successfully queued for delivery
messageId
string
status
enum<string>
Available options:
queued,
sending,
delivered
channel
enum<string>
Available options:
sms,
whatsapp
contactId
string

ID of the created or existing contact