Skip to main content
POST
Available only on WhatsApp

Path parameters

string
required
Unique identifier of the bot sending the message.

Body parameters

string
required
Message type. Must be "location_request".
string
required
Message recipient. Accepts a phone number in E.164 format without the leading + (e.g. 593999999999) or a BSUID (e.g. US.13491208655302741918) for users who have enabled phone number privacy in WhatsApp. See Identifying the recipient.
string
required
Text shown with the share-location button.

Response

boolean
true if the message was sent successfully.
string
Identifier of the sent message.

Best Practices

Privacy: Always explain why you need the user’s location. Be transparent about how location information will be used and respect user privacy.

Use Cases

  • Finding nearby stores or services
  • Requesting delivery location
  • Providing personalized directions
  • Location-based services