Skip to main content
POST
/
message
/
sendLocation
/
{instance}
Send Location
curl --request POST \
  --url https://{server-url}/message/sendLocation/{instance} \
  --header 'Content-Type: application/json' \
  --header 'apikey: <api-key>' \
  --data '
{
  "number": "<string>",
  "name": "<string>",
  "address": "<string>",
  "latitude": 123,
  "longitude": 123,
  "delay": 123,
  "linkPreview": true,
  "mentionsEveryOne": true,
  "mentioned": [
    "{{remoteJID}}"
  ],
  "quoted": {
    "key": {
      "id": "<string>"
    },
    "message": {
      "conversation": "<string>"
    }
  }
}
'
{
  "key": {
    "remoteJid": "[email protected]",
    "fromMe": true,
    "id": "BAE51B6FF4470AF9"
  },
  "message": {
    "locationMessage": {
      "degreesLatitude": -19.93359,
      "degreesLongitude": -43.93851,
      "name": "Palácio da Liberdade",
      "address": "Praça da Liberdade, Belo Horizonte, MG 30140-050",
      "contextInfo": {}
    }
  },
  "messageTimestamp": "1717779606",
  "status": "PENDING"
}

Authorizations

​
apikey
string
header
required

Your authorization key header

Path Parameters

​
instance
string
required

Name of the instance

Body

application/json
​
number
string
required

Number to receive the message (with country code)

​
name
string
required

Name the city

​
address
string
required

Location address

​
latitude
number
required

Latitude location

​
longitude
number
required

Longitude location

​
delay
integer

Presence time in milliseconds before sending message

​
linkPreview
boolean

Shows a preview of the target website if there's a link within the message

​
mentionsEveryOne
boolean

Mentioned everyone when the message send

​
mentioned
enum<string>[]

Numbers to mention

Available options:
{{remoteJID}}
​
quoted
object

Response

201 - application/json

Created

​
key
object

The key of the message, which identifies the message in the chat.

​
message
object

The message content, which may include various types of messages like text, images, location, etc.

​
messageTimestamp
string

The timestamp of the message, represented as a string.

​
status
string

The status of the message, such as sent, received, or pending.