Skip to main content
POST
/
messages
/
text
curl --request POST \
  --url https://wsapi.chat/messages/text \
  --header 'Content-Type: application/json' \
  --header 'X-Api-Key: <api-key>' \
  --header 'X-Instance-Id: <x-instance-id>' \
  --data '
{
  "to": "1234567890@s.whatsapp.net",
  "text": "Hello world!"
}
'
{
  "id": "01234567890123456"
}

Authorizations

​
X-Api-Key
string
header
required

Instance or customer-level API key. Either the instance's own API key or the customer's API key is accepted. Must be paired with the X-Instance-Id header to identify the target instance.

Headers

​
X-Instance-Id
string
default:{{instanceId}}
required

The ID of the WhatsApp instance to use

Body

application/json
​
to
string
required

Recipient JID (user or group)

​
text
string
required

Message text

​
mentions
string[]

JIDs of mentioned users

​
replyTo
string

Message ID to reply to

​
replyToSenderId
string

Sender JID of the message being replied to

​
isForwarded
boolean

Mark message as forwarded

​
ephemeralExpiration
enum<string>

Disappearing message timer

Available options:
off,
24h,
7d,
90d

Response

Resource created

​
id
string

ID of the created resource