Skip to main content
POST

Authorizations

Authorization
string
header
required

Your workspace API key, created in Settings → API keys, sent as Authorization: Bearer <key>. New keys start with watx_live_; keys issued before the rename start with converse360_live_ and still work.

Body

application/json
to
string
required

The recipient's phone number in E.164 form, for example +919876543210. A number without a country code is read using the workspace's default country.

Example:

"+919876543210"

type
enum<string>
default:text

What kind of message to send.

Available options:
text,
template,
image,
video,
document,
audio
text
string

The message body for type: "text", or the caption for an image, video or document. A caption is capped at 1024 characters.

media_url
string<uri>

Public URL of the file. Required for image, video, document and audio.

filename
string

The file name shown in the chat for a document.

name
string

A name for the contact. Used when this number is new, and updates the name if it differs from the one on file.

template
object

Required for type: "template".

reply_to_message_id
string<uuid>

Quote an earlier message. It must belong to the same conversation.

Response

The message was accepted by WhatsApp and stored.

data
object