Skip to main content
POST
Send location

Authorizations

apikey
string
header
required

Your Pilot Status API key (ps_...). Evolution GO also accepts Authorization: Bearer <key>.

Path Parameters

instance
string
required

The number's display name in the Pilot Status dashboard.

Body

application/json
number
string
required

Recipient phone in E.164 without +, or a JID.

Example:

"5511999999999"

latitude
number
required

Latitude of the location.

Example:

-23.55052

longitude
number
required

Longitude of the location.

Example:

-46.633308

name
string
required

Display name of the place.

Example:

"Pilot Status HQ"

address
string
required

Address of the place.

Example:

"Av. Paulista, 1000, São Paulo"

delay
integer

Delay before sending, in milliseconds.

quoted
object

Message to quote/reply to (key, message).

everyOne
boolean

Mention everyone in the group.

mentioned
string[]

Array of numeric strings to mention.

Response

Success — provider-native response body.

Sent location message. Returns the persisted Baileys messageRaw envelope.

key
object
pushName
string
status
enum<string>
Available options:
ERROR,
PENDING,
SERVER_ACK,
DELIVERY_ACK,
READ,
PLAYED
message
object
contextInfo
object | null
messageType
string
messageTimestamp
integer
instanceId
string
source
string