Description
This endpoint allows you to send a geographic location (latitude and longitude) to individual contacts or groups on WhatsApp. Optionally, you can include a name/description for the location.Body
Body Parameters
Property | Type | Required | Description |
---|---|---|---|
sessionId | string | ✅ Yes | Authenticated session ID that will send the location |
jid | string | ✅ Yes | Recipient identifier (WhatsApp JID). Format: 5511999999999@s.whatsapp.net for contacts or 120363XXXXX@g.us for groups |
location | object | ✅ Yes | Object containing the location information |
location.latitude | number | ✅ Yes | Location latitude (example: -23.5505 ) |
location.longitude | number | ✅ Yes | Location longitude (example: -46.6333 ) |
location.name | string | ❌ No | Location name or description (example: Avenida Paulista, São Paulo ) |
Status Codes
200
- Location sent successfully400
- Invalid parameters401
- Unauthorized session404
- Session not found
Usage Example
Authorizations
Your Wappfy API key (get it at dash.wappfy.com.br)
Body
application/json
Chat ID (WhatsApp JID)
Example:
"5511999999999@c.us"
Location latitude
Example:
-23.5505
Location longitude
Example:
-46.6333
Location name or description
Example:
"Paulista Avenue, São Paulo"
Session name (instanceName)
Example:
"my-session"
Message ID you want to reply to
Example:
null
Response
201 - application/json
The response is of type object
.