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".
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.
object
required
Location coordinates.

Response

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

Important Notes

Coordinate Precision: Make sure coordinates are accurate and in decimal format. Use negative values for south latitude and west longitude.

Use Cases

  • Sharing store locations with customers
  • Providing directions to events or venues
  • Sharing pickup or delivery locations
  • Showing nearby points of interest