Skip to main content
POST
Sends a location message (map pin) to a contact through a WABA channel. The contact will receive an interactive map pin in WhatsApp.

Headers

string
requerido
Your API key for authentication.

Body

string
requerido
UUID of the WABA channel to send from. Use List Channels to get available channel IDs.
string
requerido
UUID of the contact to message.
number
requerido
Latitude coordinate of the location (e.g. 19.4326).
number
requerido
Longitude coordinate of the location (e.g. -99.1332).
string
Name of the location (e.g. ContactShip HQ). Displayed as the pin title.
string
Address of the location (e.g. Paseo de la Reforma 505, CDMX). Displayed below the pin title.
string
UUID of an existing thread. If provided, channel_id and contact_id are inferred automatically.
boolean
predeterminado:"true"
Whether to save the message in the conversation thread.

Response

boolean
true if the location was sent successfully.
object

Error Codes

  • 400 Bad Request — Missing fields, invalid coordinates, or non-WABA channel
  • 401 Unauthorized — Invalid or missing API key
  • 403 Forbidden — Channel does not belong to your organization
  • 404 Not Found — Contact not found
  • 500 Internal Server Error — Meta API error

Code Examples