Request location - Omni Z-API

In development. This endpoint does not exist yet. The page is published so you can get to know the shape and plan the integration — the body below is what will apply when it ships.

Overview

Sends a message with the Send location button. The customer taps it and WhatsApp returns their point to your webhook. It is the opposite of sending a location: here the customer sends the point. The content.type field will be LOCATION_REQUEST.

Request body

{
  "recipient": { "identifier": "5511999999999" },
  "content": {
    "type": "LOCATION_REQUEST",
    "message": "To calculate shipping, tap below and send your location."
  }
}

Rules

Rule	Value
Text	up to 1024 characters
Button label	fixed by WhatsApp, translated to the customer’s language

The answer arrives as a regular location message, with latitude, longitude and, when the customer allows it, name and address.