POST
/
messages
/
interactive
/
send-location

Sends a specific location on a map (latitude/longitude coordinates). This is supported on WhatsApp, Z-API, and ZapperHUB channels.

Authentication: Requires a valid API key or session. Pass as Authorization: Bearer <api_key>.

Request Body

Required Parameters

  • agentId: The ID of the agent.
  • conversationId: The ID of the conversation.
  • latitude: Latitude of the location (decimal degrees).
  • longitude: Longitude of the location (decimal degrees).
  • name: Name of the place.
  • address: Address of the place.

Example

{
  "agentId": "agent-123",
  "conversationId": "conv-456",
  "latitude": "-23.5505",
  "longitude": "-46.6333",
  "name": "São Paulo",
  "address": "Praça da Sé, São Paulo - SP"
}

Error Responses

HTTP StatusMeaning
400Invalid request body
401Invalid or missing API key
403Agent does not belong to your organization
404Conversation or agent not found
500WhatsApp API error

Authorizations

Authorization
string
headerrequired

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
agentId
string
required

The ID of the agent.

conversationId
string
required

The ID of the conversation.

latitude
string
required

Latitude of the location.

longitude
string
required

Longitude of the location.

name
string
required

Name of the place.

address
string
required

Address of the place.