Interactive Messages
Location Request
Sends a message asking the user to share their current location. Supported on WhatsApp only.
POST
/
messages
/
interactive
/
location-request
Sends a message asking the user to share their current location. When the user taps the button, a location sharing screen appears. This is supported on WhatsApp only.
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.body_text: Text explaining why the location is needed (max 1024 chars). Supports URLs.
Example
Error Responses
| HTTP Status | Meaning |
|---|---|
| 400 | Invalid request body |
| 401 | Invalid or missing API key |
| 403 | Agent does not belong to your organization |
| 404 | Conversation or agent not found |
| 500 | WhatsApp API error |
Authorizations
Authorization
string
headerrequiredBearer authentication header of the form Bearer <token>, where <token> is your auth token.
Body
application/json
agentId
string
requiredThe ID of the agent.
conversationId
string
requiredThe ID of the conversation.
body_text
string
requiredText explaining why the location is needed.
Was this page helpful?

