Z-API
Send WhatsApp Message
This endpoint allows sending a text message and/or attachments to a destination WhatsApp number, using a configured Z-API instance. The message is also registered in the conversation associated with the agent and contact.
POST
/
zapi
/
{instanceId}
/
{contactPhone}
/
message
Example JS Code to Send WhatsApp Message
Authorizations
Authorization
string
headerrequiredBearer authentication header of the form Bearer <token>
, where <token>
is your auth token.
Path Parameters
instanceId
string
requiredZ-API instance ID (externalId of the ServiceProvider of type 'zapi').
contactPhone
string
requiredRecipient's WhatsApp number.
Body
application/json
message
string
Textual content of the message.
attachments
object[]
Optional list of attachments to be sent.
Response
200 - application/json
id
string
text
string
html
string | null
from
enum<string>
Available options:
human
, agent
conversationId
string
sources
object[] | null
usage
object | null
externalId
string | null
userId
string | null
contactId
string | null
visitorId
string | null
agentId
string | null
metadata
object | null
inputId
string | null
eval
enum<string> | null
Available options:
good
, bad
read
boolean
agentModel
string | null
usageCredits
number | null
createdAt
string
updatedAt
string
Was this page helpful?