Send geographical location
curl --request POST \
--url https://api.wppfy.com/send/location \
--header 'Content-Type: application/json' \
--header 'token: <api-key>' \
--data '
{
"number": "5511999999999",
"latitude": -23.5616,
"longitude": -46.6562,
"name": "MASP",
"address": "Av. Paulista, 1578 - Bela Vista, São Paulo - SP",
"replyid": "3EB0538DA65A59F6D8A251",
"mentions": "5511999999999,5511888888888",
"readchat": true,
"readmessages": true,
"delay": 1000,
"forward": true,
"track_source": "chatwoot",
"track_id": "msg_123456789",
"async": false
}
'import requests
url = "https://api.wppfy.com/send/location"
payload = {
"number": "5511999999999",
"latitude": -23.5616,
"longitude": -46.6562,
"name": "MASP",
"address": "Av. Paulista, 1578 - Bela Vista, São Paulo - SP",
"replyid": "3EB0538DA65A59F6D8A251",
"mentions": "5511999999999,5511888888888",
"readchat": True,
"readmessages": True,
"delay": 1000,
"forward": True,
"track_source": "chatwoot",
"track_id": "msg_123456789",
"async": False
}
headers = {
"token": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {token: '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
number: '5511999999999',
latitude: -23.5616,
longitude: -46.6562,
name: 'MASP',
address: 'Av. Paulista, 1578 - Bela Vista, São Paulo - SP',
replyid: '3EB0538DA65A59F6D8A251',
mentions: '5511999999999,5511888888888',
readchat: true,
readmessages: true,
delay: 1000,
forward: true,
track_source: 'chatwoot',
track_id: 'msg_123456789',
async: false
})
};
fetch('https://api.wppfy.com/send/location', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.wppfy.com/send/location",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'number' => '5511999999999',
'latitude' => -23.5616,
'longitude' => -46.6562,
'name' => 'MASP',
'address' => 'Av. Paulista, 1578 - Bela Vista, São Paulo - SP',
'replyid' => '3EB0538DA65A59F6D8A251',
'mentions' => '5511999999999,5511888888888',
'readchat' => true,
'readmessages' => true,
'delay' => 1000,
'forward' => true,
'track_source' => 'chatwoot',
'track_id' => 'msg_123456789',
'async' => false
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"token: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.wppfy.com/send/location"
payload := strings.NewReader("{\n \"number\": \"5511999999999\",\n \"latitude\": -23.5616,\n \"longitude\": -46.6562,\n \"name\": \"MASP\",\n \"address\": \"Av. Paulista, 1578 - Bela Vista, São Paulo - SP\",\n \"replyid\": \"3EB0538DA65A59F6D8A251\",\n \"mentions\": \"5511999999999,5511888888888\",\n \"readchat\": true,\n \"readmessages\": true,\n \"delay\": 1000,\n \"forward\": true,\n \"track_source\": \"chatwoot\",\n \"track_id\": \"msg_123456789\",\n \"async\": false\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("token", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.wppfy.com/send/location")
.header("token", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"number\": \"5511999999999\",\n \"latitude\": -23.5616,\n \"longitude\": -46.6562,\n \"name\": \"MASP\",\n \"address\": \"Av. Paulista, 1578 - Bela Vista, São Paulo - SP\",\n \"replyid\": \"3EB0538DA65A59F6D8A251\",\n \"mentions\": \"5511999999999,5511888888888\",\n \"readchat\": true,\n \"readmessages\": true,\n \"delay\": 1000,\n \"forward\": true,\n \"track_source\": \"chatwoot\",\n \"track_id\": \"msg_123456789\",\n \"async\": false\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.wppfy.com/send/location")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["token"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"number\": \"5511999999999\",\n \"latitude\": -23.5616,\n \"longitude\": -46.6562,\n \"name\": \"MASP\",\n \"address\": \"Av. Paulista, 1578 - Bela Vista, São Paulo - SP\",\n \"replyid\": \"3EB0538DA65A59F6D8A251\",\n \"mentions\": \"5511999999999,5511888888888\",\n \"readchat\": true,\n \"readmessages\": true,\n \"delay\": 1000,\n \"forward\": true,\n \"track_source\": \"chatwoot\",\n \"track_id\": \"msg_123456789\",\n \"async\": false\n}"
response = http.request(request)
puts response.read_body{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"messageid": "<string>",
"chatid": "<string>",
"sender": "<string>",
"senderName": "<string>",
"isGroup": false,
"fromMe": false,
"messageType": "<string>",
"source": "<string>",
"messageTimestamp": 0,
"status": "<string>",
"text": "",
"quoted": "",
"edited": "",
"reaction": "",
"vote": "",
"convertOptions": "",
"buttonOrListid": "",
"owner": "",
"error": "",
"content": {},
"wasSentByApi": true,
"pinned": true,
"sendFunction": "<string>",
"sendPayload": {},
"fileURL": "<string>",
"callPeer": {
"jid": "<string>",
"name": "<string>",
"imagePreviewUrl": "<string>"
},
"send_folder_id": "<string>",
"track_source": "<string>",
"track_id": "<string>",
"ai_metadata": {
"agent_id": "<string>",
"turn": "<string>",
"flow_id": "<string>",
"request": {
"messages": "<array>",
"tools": "<array>",
"options": {
"model": "<string>",
"temperature": 123,
"maxTokens": 123,
"topP": 123,
"frequencyPenalty": 123,
"presencePenalty": 123
}
},
"response": {
"choices": "<array>",
"toolResults": "<array>",
"error": "<string>"
},
"outcome": {
"status": "sent",
"texts": 123,
"audio": true,
"menus": 123,
"files": 123,
"handoff": "<string>",
"lead": [
"<string>"
],
"detail": "<string>"
}
},
"sender_pn": "<string>",
"sender_lid": "<string>",
"sender_image_preview_url": "<string>",
"response": {
"status": "success",
"message": "Location sent successfully"
}
}{
"error": "Invalid coordinates or missing number"
}{
"error": "Invalid token"
}{
"error": "Rate limit exceeded"
}{
"error": "Failed to send location"
}Send Message
Send geographical location
Sends a geographic location to a contact or group.
Specific Features
- Precise coordinates (latitude and longitude required)
- Place name for identification
- Full address for detailed display
- Interactive map in WhatsApp for navigation
- Custom pin with the place name
Common Fields
This endpoint supports all common optional fields documented in the “Send Message” tag, including:
delay, readchat, readmessages, replyid, mentions, forward, track_source, track_id, placeholders, and sending to groups.
Basic Example
{
"number": "5511999999999",
"name": "Maracanã",
"address": "Av. Pres. Castelo Branco - Maracanã, Rio de Janeiro - RJ",
"latitude": -22.912982815767986,
"longitude": -43.23028153499254
}
POST
/
send
/
location
Send geographical location
curl --request POST \
--url https://api.wppfy.com/send/location \
--header 'Content-Type: application/json' \
--header 'token: <api-key>' \
--data '
{
"number": "5511999999999",
"latitude": -23.5616,
"longitude": -46.6562,
"name": "MASP",
"address": "Av. Paulista, 1578 - Bela Vista, São Paulo - SP",
"replyid": "3EB0538DA65A59F6D8A251",
"mentions": "5511999999999,5511888888888",
"readchat": true,
"readmessages": true,
"delay": 1000,
"forward": true,
"track_source": "chatwoot",
"track_id": "msg_123456789",
"async": false
}
'import requests
url = "https://api.wppfy.com/send/location"
payload = {
"number": "5511999999999",
"latitude": -23.5616,
"longitude": -46.6562,
"name": "MASP",
"address": "Av. Paulista, 1578 - Bela Vista, São Paulo - SP",
"replyid": "3EB0538DA65A59F6D8A251",
"mentions": "5511999999999,5511888888888",
"readchat": True,
"readmessages": True,
"delay": 1000,
"forward": True,
"track_source": "chatwoot",
"track_id": "msg_123456789",
"async": False
}
headers = {
"token": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {token: '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
number: '5511999999999',
latitude: -23.5616,
longitude: -46.6562,
name: 'MASP',
address: 'Av. Paulista, 1578 - Bela Vista, São Paulo - SP',
replyid: '3EB0538DA65A59F6D8A251',
mentions: '5511999999999,5511888888888',
readchat: true,
readmessages: true,
delay: 1000,
forward: true,
track_source: 'chatwoot',
track_id: 'msg_123456789',
async: false
})
};
fetch('https://api.wppfy.com/send/location', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.wppfy.com/send/location",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'number' => '5511999999999',
'latitude' => -23.5616,
'longitude' => -46.6562,
'name' => 'MASP',
'address' => 'Av. Paulista, 1578 - Bela Vista, São Paulo - SP',
'replyid' => '3EB0538DA65A59F6D8A251',
'mentions' => '5511999999999,5511888888888',
'readchat' => true,
'readmessages' => true,
'delay' => 1000,
'forward' => true,
'track_source' => 'chatwoot',
'track_id' => 'msg_123456789',
'async' => false
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"token: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.wppfy.com/send/location"
payload := strings.NewReader("{\n \"number\": \"5511999999999\",\n \"latitude\": -23.5616,\n \"longitude\": -46.6562,\n \"name\": \"MASP\",\n \"address\": \"Av. Paulista, 1578 - Bela Vista, São Paulo - SP\",\n \"replyid\": \"3EB0538DA65A59F6D8A251\",\n \"mentions\": \"5511999999999,5511888888888\",\n \"readchat\": true,\n \"readmessages\": true,\n \"delay\": 1000,\n \"forward\": true,\n \"track_source\": \"chatwoot\",\n \"track_id\": \"msg_123456789\",\n \"async\": false\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("token", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.wppfy.com/send/location")
.header("token", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"number\": \"5511999999999\",\n \"latitude\": -23.5616,\n \"longitude\": -46.6562,\n \"name\": \"MASP\",\n \"address\": \"Av. Paulista, 1578 - Bela Vista, São Paulo - SP\",\n \"replyid\": \"3EB0538DA65A59F6D8A251\",\n \"mentions\": \"5511999999999,5511888888888\",\n \"readchat\": true,\n \"readmessages\": true,\n \"delay\": 1000,\n \"forward\": true,\n \"track_source\": \"chatwoot\",\n \"track_id\": \"msg_123456789\",\n \"async\": false\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.wppfy.com/send/location")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["token"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"number\": \"5511999999999\",\n \"latitude\": -23.5616,\n \"longitude\": -46.6562,\n \"name\": \"MASP\",\n \"address\": \"Av. Paulista, 1578 - Bela Vista, São Paulo - SP\",\n \"replyid\": \"3EB0538DA65A59F6D8A251\",\n \"mentions\": \"5511999999999,5511888888888\",\n \"readchat\": true,\n \"readmessages\": true,\n \"delay\": 1000,\n \"forward\": true,\n \"track_source\": \"chatwoot\",\n \"track_id\": \"msg_123456789\",\n \"async\": false\n}"
response = http.request(request)
puts response.read_body{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"messageid": "<string>",
"chatid": "<string>",
"sender": "<string>",
"senderName": "<string>",
"isGroup": false,
"fromMe": false,
"messageType": "<string>",
"source": "<string>",
"messageTimestamp": 0,
"status": "<string>",
"text": "",
"quoted": "",
"edited": "",
"reaction": "",
"vote": "",
"convertOptions": "",
"buttonOrListid": "",
"owner": "",
"error": "",
"content": {},
"wasSentByApi": true,
"pinned": true,
"sendFunction": "<string>",
"sendPayload": {},
"fileURL": "<string>",
"callPeer": {
"jid": "<string>",
"name": "<string>",
"imagePreviewUrl": "<string>"
},
"send_folder_id": "<string>",
"track_source": "<string>",
"track_id": "<string>",
"ai_metadata": {
"agent_id": "<string>",
"turn": "<string>",
"flow_id": "<string>",
"request": {
"messages": "<array>",
"tools": "<array>",
"options": {
"model": "<string>",
"temperature": 123,
"maxTokens": 123,
"topP": 123,
"frequencyPenalty": 123,
"presencePenalty": 123
}
},
"response": {
"choices": "<array>",
"toolResults": "<array>",
"error": "<string>"
},
"outcome": {
"status": "sent",
"texts": 123,
"audio": true,
"menus": 123,
"files": 123,
"handoff": "<string>",
"lead": [
"<string>"
],
"detail": "<string>"
}
},
"sender_pn": "<string>",
"sender_lid": "<string>",
"sender_image_preview_url": "<string>",
"response": {
"status": "success",
"message": "Location sent successfully"
}
}{
"error": "Invalid coordinates or missing number"
}{
"error": "Invalid token"
}{
"error": "Rate limit exceeded"
}{
"error": "Failed to send location"
}Authorizations
Body
application/json
ID of the chat the message will be sent to. Can be a phone number in international format, a group ID (@g.us), a user ID (with @s.whatsapp.net or @lid).
Example:
"5511999999999"
Latitude (-90 to 90)
Example:
-23.5616
Longitude (-180 to 180)
Example:
-46.6562
Location name
Example:
"MASP"
Location address
Example:
"Av. Paulista, 1578 - Bela Vista, São Paulo - SP"
ID of the message to reply to
Example:
"3EB0538DA65A59F6D8A251"
Numbers to mention (comma separated)
Example:
"5511999999999,5511888888888"
Marks chat as read after sending
Example:
true
Marks latest received messages as read
Example:
true
Delay in milliseconds before sending; during delay 'Typing...' will appear
Example:
1000
Marks the message as forwarded on WhatsApp
Example:
true
Message tracking source
Example:
"chatwoot"
ID for message tracking (accepts duplicate values)
Example:
"msg_123456789"
If true, sends the message asynchronously via the internal queue
Example:
false
Response
Location sent successfully
Represents a message exchanged in the system
Internal unique message ID (format r + 7 random hex characters)
Original message ID at the provider
Related conversation ID
Message sender ID
Sender's display name
Indicates whether it is a group message
Indicates whether the message was sent by the user
Message content type
Message source platform
Original message timestamp in milliseconds
Message lifecycle status.
Common examples: Queued, Canceled, Failed, Sent, Delivered, Read.
In group messages, it follows the most advanced participant: Delivered when at least one received it, Read when at least one read it, and Played when at least one listened to it.
Original message text
ID of the quoted/replied message
Message edit history
ID of the reacted message
Poll and list voting data
Conversion of message options, list, poll and buttons
ID of the selected button or list item
Message owner
Error message if sending failed
Raw message content (serialized JSON or text)
Indicates whether the message was sent via API
Message pinned in the conversation (pin and unpin also arrive in messages_update, types Pinned and Unpinned)
Function used to send the message (when sent via API)
Payload used in the send when available. Base64 media data is omitted.
Message file URL or reference
Known contact associated with a call, when available in messageType: call.
Show child attributes
Show child attributes
Folder associated with the send (when applicable)
Tracking source
Tracking ID (may repeat)
Record of an AI round. The full one (request to the model, response, and outcome) is stored once, on the contact's last message that the round replied to, even when nothing went out (error, discarded response). Each message sent by the AI carries only agent_id and turn (the id of that contact message).
Show child attributes
Show child attributes
Sender's resolved PN JID (when available)
Sender's original LID (when available)
Temporary preview URL of the sender, when known. Hydration in this version fills in messages received in groups; the field may be omitted. It does not trigger a photo query to WhatsApp during listing.
Show child attributes
Show child attributes