Actions90
- Business Profile Actions
- Call Actions
- Flow Actions
- Media Actions
- Message Actions
- Phone Number Actions
- QR Code Actions
- System Actions
- Template Actions
- User Actions
Message → Request Location
AI-generatedSummary
Request a recipient to share their live location via a WhatsApp message with customizable body text and optional metadata.
Inputs
- To (required) — Recipient phone number with country code (without plus sign), e.g., 966565430200.
- Body Text (required) — Message body text prompting the recipient to share their location, defaulting to "Please share your location."
- Options — Additional optional parameters including Reply To Message ID to create a quoted reply and Tracking Data for custom webhook tracking.
Output shape
A message send acknowledgment object reflecting the API response for the location request message.
The operation responds with data confirming the message has been sent; any trackingData supplied will be included in webhooks for tracking; errors will propagate if sending fails.
Examples
Example 1: Request location from a user with default prompt
To set the recipient phone number and send a location request message with default text.