Skip to main content
POST
Send location
Being implemented. On WhatsApp Web, the place name is not passed on: the name field is not sent to WhatsApp yet. The fix is in progress.

Overview

Sends a location message to a contact. The content.type field must be LOCATION and the coordinates are provided in the attachments array using latitude and longitude. The name and address fields are optional and allow displaying the place name and address directly in the message. Send latitude and longitude as text, like the example: "-23.0696347".
The API does not validate the latitude and longitude fields. Requests without these values will be accepted, but the message will not display the location correctly on WhatsApp. Always provide both fields.
Details of the Meta Cloud API rule in conversation window. See what each channel accepts for every channel.
If the channel is disconnected, the API refuses the send with 422 and subCode CHANNEL_DISCONNECTED, and the message is not sent. See Send errors.

Authorizations

Authorization
string
header
required

Secret Key generated in the Omni Z-API Security panel

Path Parameters

channelId
string
required

Channel ID

Example:

"YOUR_CHANNEL_ID"

Body

application/json
recipient
object
required

Recipient data

content
object
required
sender
object

Sender data (optional)

Response

Message sent successfully

messageId
string

Sent message ID — 32-character uppercase hexadecimal string