Skip to main content

​
Location request messages

Updated: Nov 3, 2025 Location request messages display body text and a send location button. When a WhatsApp user taps the button, a location sharing screen appears which the user can then use to share their location. Once the user shares their location, a messages webhook is triggered, containing the user’s location details.

​
Request syntax

Use the POST /<WHATSAPP_BUSINESS_PHONE_NUMBER_ID>/messages endpoint to send a location request message to a WhatsApp user. 
curl 'https://graph.facebook.com/&lt;API_VERSION&gt;/&lt;WHATSAPP_BUSINESS_PHONE_NUMBER_ID&gt;/messages' \
-H 'Content-Type: application/json' \
-H 'Authorization: Bearer &lt;ACCESS_TOKEN&gt;' \
-d '
\{
  "messaging_product": "whatsapp",
  "recipient_type": "individual",
  "type": "interactive",
  "to": "&lt;WHATSAPP_USER_PHONE_NUMBER&gt;",
  "interactive": {
    "type": "location_request_message",
    "body": {
      "text": "&lt;BODY_TEXT&gt;"
    },
    "action": {
      "name": "send_location"
    }
  }
}'

​
Request parameters

PlaceholderDescriptionExample Value
&lt;ACCESS_TOKEN&gt;
String		Required.
System token or business token.		EAAAN6tcBzAUBOZC82CW7iR2LiaZBwUHS4Y7FDtQxRUPy1PHZClDGZBZCgWdrTisgMjpFKiZAi1FBBQNO2IqZBAzdZAA16lmUs0XgRcCf6z1LLxQCgLXDEpg80d41UZBt1FKJZCqJFcTYXJvSMeHLvOdZwFyZBrV9ZPHZASSqxDZBUZASyFdzjiy2A1sippEsF4DVV5W2IlkOSr2LrMLuYoNMYBy8xQczzOKDOMccqHEZD
&lt;API_VERSION&gt;
String		Optional.
Graph API version.		v24.0
&lt;BODY_TEXT&gt;
String		Required.
Message body text. Supports URLs.
Maximum 1024 characters.		Let's start with your pickup. You can either manually *enter an address* or *share your current location*.
&lt;WHATSAPP_BUSINESS_PHONE_NUMBER_ID&gt;
String		Required.
WhatsApp business phone number ID.		106540352242922
&lt;WHATSAPP_USER_PHONE_NUMBER&gt;
String		Required.
WhatsApp user phone number.		+16505551234

​
Webhook syntax

When a WhatsApp user shares their location in response to your message, a messages webhook is triggered containing the user’s location details. 
\{
  "object": "whatsapp_business_account",
  "entry": [\
    {\
      "id": "&lt;WHATSAPP_BUSINESS_ACCOUNT_ID&gt;",\
      "changes": [\
        {\
          "value": {\
            "messaging_product": "whatsapp",\
            "metadata": {\
              "display_phone_number": "&lt;WHATSAPP_BUSINESS_DISPLAY_PHONE_NUMBER&gt;",\
              "phone_number_id": "&lt;WHATSAPP_BUSINESS_PHONE_NUMBER_ID&gt;"\
            },\
            "contacts": [\
              {\
                "profile": {\
                  "name": "&lt;WHATSAPP_USER_NAME&gt;"\
                },\
                "wa_id": "&lt;WHATSAPP_USER_ID&gt;"\
              }\
            ],\
            "messages": [\
              {\
                "context": {\
                  "from": "&lt;WHATSAPP_BUSINESS_PHONE_NUMBER&gt;",\
                  "id": "&lt;WHATSAPP_CONTEXT_MESSAGE_ID&gt;"\
                },\
                "from": "&lt;WHATSAPP_USER_ID&gt;",\
                "id": "&lt;WHATSAPP_MESSAGE_ID&gt;",\
                "timestamp": "&lt;TIMESTAMP&gt;",\
                "location": {\
                  "address": "&lt;LOCATION_ADDRESS&gt;",\
                  "latitude": &lt;LOCATION_LATITUDE&gt;,\
                  "longitude": &lt;LOCATION_LONGITUDE&gt;,\
                  "name": "&lt;LOCATION_NAME&gt;"\
                },\
                "type": "location"\
              }\
            ]\
          },\
          "field": "messages"\
        }\
      ]\
    }\
  ]
}

​
Webhook parameters

PlaceholderDescriptionExample Value
&lt;LOCATION_ADDRESS&gt;
String		Location address.
This parameter will only appear if the WhatsApp user chooses to share it.		1071 5th Ave, New York, NY 10128
&lt;LOCATION_LATITUDE&gt;
Number		Location latitude in decimal degrees.40.782910059774
&lt;LOCATION_LONGITUDE&gt;
Number		Location longitude in decimal degrees.-73.959075808525
&lt;LOCATION_NAME&gt;
String		Location name.
This parameter will only appear if the WhatsApp user chooses to share it.		Solomon R. Guggenheim Museum
&lt;TIMESTAMP&gt;
String		UNIX timestamp indicating when our servers processed the WhatsApp user’s message.1702920965
&lt;WHATSAPP_BUSINESS_ACCOUNT_ID&gt;
String		WhatsApp Business Account ID.102290129340398
&lt;WHATSAPP_BUSINESS_DISPLAY_PHONE_NUMBER&gt;
String		WhatsApp business phone number’s display number.15550783881
&lt;WHATSAPP_BUSINESS_PHONE_NUMBER&gt;
String		WhatsApp business phone number.15550783881
&lt;WHATSAPP_BUSINESS_PHONE_NUMBER_ID&gt;
String		WhatsApp business phone number ID.106540352242922
&lt;WHATSAPP_CONTEXT_MESSAGE_ID&gt;
String		WhatsApp message ID of message that the user is responding to.wamid.HBgLMTY0NjcwNDM1OTUVAgARGBI1QjJGRjI1RDY0RkE4Nzg4QzcA
&lt;WHATSAPP_MESSAGE_ID&gt;
String		WhatsApp message ID of the user’s message.wamid.HBgLMTY0NjcwNDM1OTUVAgASGBQzQTRCRDcwNzgzMTRDNTAwRTgwRQA=
&lt;WHATSAPP_USER_ID&gt;
String		WhatsApp user’s WhatsApp ID.16505551234
&lt;WHATSAPP_USER_NAME&gt;
String		WhatsApp user’s name.Pablo Morales

​
Example request

curl 'https://graph.facebook.com/v24.0/106540352242922/messages' \
-H 'Content-Type: application/json' \
-H 'Authorization: Bearer EAAJB...' \
-d '
\{
  "messaging_product": "whatsapp",
  "recipient_type": "individual",
  "type": "interactive",
  "to": "+16505551234",
  "interactive": {
    "type": "location_request_message",
    "body": {
      "text": "Let'\''s start with your pickup. You can either manually *enter an address* or *share your current location*."
    },
    "action": {
      "name": "send_location"
    }
  }
}'

​
Example response

\{
  "messaging_product": "whatsapp",
  "contacts": [\
    {\
      "input": "+16505551234",\
      "wa_id": "16505551234"\
    }\
  ],
  "messages": [\
    {\
      "id": "wamid.HBgLMTY0NjcwNDM1OTUVAgARGBJCNUQ5RUNBNTk3OEQ2M0ZEQzgA"\
    }\
  ]
}

​
Example webhook

\{
  "object": "whatsapp_business_account",
  "entry": [\
    {\
      "id": "102290129340398",\
      "changes": [\
        {\
          "value": {\
            "messaging_product": "whatsapp",\
            "metadata": {\
              "display_phone_number": "15550783881",\
              "phone_number_id": "106540352242922"\
            },\
            "contacts": [\
              {\
                "profile": {\
                  "name": "Pablo Morales"\
                },\
                "wa_id": "16505551234"\
              }\
            ],\
            "messages": [\
              {\
                "context": {\
                  "from": "15550783881",\
                  "id": "wamid.HBgLMTY0NjcwNDM1OTUVAgARGBI1QjJGRjI1RDY0RkE4Nzg4QzcA"\
                },\
                "from": "16505551234",\
                "id": "wamid.HBgLMTY0NjcwNDM1OTUVAgASGBQzQTRCRDcwNzgzMTRDNTAwRTgwRQA=",\
                "timestamp": "1702920965",\
                "location": {\
                  "address": "1071 5th Ave, New York, NY 10128",\
                  "latitude": 40.782910059774,\
                  "longitude": -73.959075808525,\
                  "name": "Solomon R. Guggenheim Museum"\
                },\
                "type": "location"\
              }\
            ]\
          },\
          "field": "messages"\
        }\
      ]\
    }\
  ]
}
Did you find this page helpful? Thumbs up icon Thumbs down icon ON THIS PAGE Request syntax Request parameters Webhook syntax Webhook parameters Example request Example response Example webhook