POST
/
messages
/
interactive
/
location-request

Sends a message asking the user to share their current location. This is supported on WhatsApp only.

Request Body

  • agentId: The ID of the agent.
  • conversationId: The ID of the conversation.
  • body_text: Text explaining why the location is needed.

Example

{
  "agentId": "agent-123",
  "conversationId": "conv-456",
  "body_text": "Please share your location so we can find the nearest store."
}

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.

body_text
string
required

Text explaining why the location is needed.