Skip to main content
POST
Send text

Overview

Method for sending simple text messages. Supports WhatsApp formatting, emojis, and line breaks. To add line breaks in the message, use any of these formats: \n, \r, \r\n or %0a.

Authorizations

Authorization
string
header
required

Secret Key generated in the Omni Z-API Security panel

Body

application/json
phone
string
required

Recipient phone number (country code + area code + number)

Example:

"5511999999999"

message
string
required

Message text

Example:

"Welcome to *Omni Z-API*!"

delayMessage
integer

Delay in seconds before sending (1-15)

Required range: 1 <= x <= 15
delayTyping
integer

Seconds to display "typing" status (1-15)

Required range: 1 <= x <= 15
editMessageId
string

ID of a previously sent message to edit

Response

Message sent successfully

zaapId
string

Internal identifier

messageId
string

WhatsApp message ID

id
string

Same value as messageId (compatibility)