Send message or WhatsApp template (Unified API)

Authorizations

api_access_token

string

header

required

API Access Token (underscore format)

api_account_id

string

header

required

Account ID (underscore format for unified message endpoints)

Headers

api_account_id

string

Account ID header (Supports api_account_id or api-account-id)

Example:

"16"

api-account-id

string

Alternative hyphenated header for Account ID

Example:

"16"

Body

application/json

inbox_id

integer

required

ID of the inbox channel (e.g. WhatsApp channel)

Example:

1

phone_number

string

Recipient phone number with country code (e.g. +966...)

Example:

"+966555555555"

contact_id

integer

Optional contact ID if already known

Example:

160

content

string

Text content of the message

Example:

"Hello from Domix AI!"

message_type

enum<string>

default:outgoing

Available options:

outgoing,

template

Example:

"outgoing"

name

string

Customer name to associate with contact if created

Example:

"Ahmed Mohamed"

string<email>

Example:

"ahmed@example.com"

custom_attributes

object

Key-value custom attributes for contact

Example:

{ "client_id": "ABC-99" }

template_params

object

Parameters for WhatsApp approved template messages

Hide child attributes

template_params.name

string

Example:

"order_confirmation"

template_params.category

string

Example:

"MARKETING"

template_params.language

string

Example:

"ar"

template_params.components

object[]

Response

Message dispatched successfully

status

string

Example:

"ok"

conversation_display_id

integer

Example:

12

contact_id

integer

Example:

34

message_id

integer

Example:

56

Getting Started

API Reference

Send message or WhatsApp template (Unified API)

Authorizations

Headers

Body

Response