Actions51
- API Actions
- Chat Actions
- Contact Actions
- Group Actions
- Instance Actions
- Message Actions
- Message Queue Actions
- Product Actions
- Status Actions
Message → Send a Location
AI-generatedSummary
Send a location message to a contact or group.
Inputs
- phone (required) — Contact number (or group ID) in international format, digits only. Example: 5511999999999.
- delayMessage — Delay in seconds before sending the message. Z-API recommends between 1 and 15 seconds. If 0, uses the API default behavior.
- location — Location details to be sent as a message; includes latitude, longitude, optional title and address.
Output shape
a single object representing the API response
The response contains the result of the send-location call; fields vary by Z-API but typically indicate success.
Examples
Example 1: Send a store opening location to a customer.
Phone: 5511999999999; delayMessage: 2; location.latitude: -23.550520; location.longitude: -46.633308; location.title: Store; location.address: Av. Paulista, 1000
Example 2: Send a delayed location to a teammate.
Phone: 5511999999999; delayMessage: 5; location.latitude: -23.550520; location.longitude: -46.633308
Example 3: Send location without delay.
Phone: 5511999999999; location.latitude: -23.550520; location.longitude: -46.633308; location.title: Office