Skip to content

Location request messages

Updated: May 21, 2026

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.

Three WhatsApp screens: location request message with body text and Send location button, location sharing screen, and shared location response.

Once the user shares their location, a messages webhook is triggered, containing the user's location details.

Request syntax

Use the Messages API to send a location request message to a WhatsApp user.

curl 'https://graph.facebook.com/<API_VERSION>/<WHATSAPP_BUSINESS_PHONE_NUMBER_ID>/messages' \  
-H 'Content-Type: application/json' \  
-H 'Authorization: Bearer <ACCESS_TOKEN>' \  
-d '  
{  
  "messaging_product": "whatsapp",  
  "recipient_type": "individual",  
  "type": "interactive",  
  "to": "<WHATSAPP_USER_PHONE_NUMBER>",  
  "interactive": {  
    "type": "location_request_message",  
    "body": {  
      "text": "<BODY_TEXT>"  
    },  
    "action": {  
      "name": "send_location"  
    }  
  }  
}'

Request parameters

PlaceholderDescriptionExample Value
<ACCESS_TOKEN> StringRequired. System token or business token.EAAA...
<API_VERSION> StringOptional. Graph API version.v25.0
<BODY_TEXT> StringRequired. 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*.
<WHATSAPP_BUSINESS_PHONE_NUMBER_ID> StringRequired. WhatsApp business phone number ID.106540352242922
<WHATSAPP_USER_PHONE_NUMBER> StringRequired. 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": "<WHATSAPP_BUSINESS_ACCOUNT_ID>",  
      "changes": [  
        {  
          "value": {  
            "messaging_product": "whatsapp",  
            "metadata": {  
              "display_phone_number": "<WHATSAPP_BUSINESS_DISPLAY_PHONE_NUMBER>",  
              "phone_number_id": "<WHATSAPP_BUSINESS_PHONE_NUMBER_ID>"  
            },  
            "contacts": [  
              {  
                "profile": {  
                  "name": "<WHATSAPP_USER_NAME>"  
                },  
                "wa_id": "<WHATSAPP_USER_ID>"  
              }  
            ],  
            "messages": [  
              {  
                "context": {  
                  "from": "<WHATSAPP_BUSINESS_PHONE_NUMBER>",  
                  "id": "<WHATSAPP_CONTEXT_MESSAGE_ID>"  
                },  
                "from": "<WHATSAPP_USER_ID>",  
                "id": "<WHATSAPP_MESSAGE_ID>",  
                "timestamp": "<TIMESTAMP>",  
                "location": {  
                  "address": "<LOCATION_ADDRESS>",  
                  "latitude": <LOCATION_LATITUDE>,  
                  "longitude": <LOCATION_LONGITUDE>,  
                  "name": "<LOCATION_NAME>"  
                },  
                "type": "location"  
              }  
            ]  
          },  
          "field": "messages"  
        }  
      ]  
    }  
  ]  
}

Webhook parameters

PlaceholderDescriptionExample Value
<LOCATION_ADDRESS> StringLocation address. This parameter appears only if the WhatsApp user chooses to share it.1071 5th Ave, New York, NY 10128
<LOCATION_LATITUDE> NumberLocation latitude in decimal degrees.40.782910059774
<LOCATION_LONGITUDE> NumberLocation longitude in decimal degrees.-73.959075808525
<LOCATION_NAME> StringLocation name. This parameter appears only if the WhatsApp user chooses to share it.Solomon R. Guggenheim Museum
<TIMESTAMP> StringUNIX timestamp indicating when our servers processed the WhatsApp user's message.1702920965
<WHATSAPP_BUSINESS_ACCOUNT_ID> StringWhatsApp Business account ID.102290129340398
<WHATSAPP_BUSINESS_DISPLAY_PHONE_NUMBER> StringWhatsApp Business phone number's display number.15550783881
<WHATSAPP_BUSINESS_PHONE_NUMBER> StringWhatsApp Business phone number.15550783881
<WHATSAPP_BUSINESS_PHONE_NUMBER_ID> StringWhatsApp Business phone number ID.106540352242922
<WHATSAPP_CONTEXT_MESSAGE_ID> StringWhatsApp message ID of message that the user is responding to.wamid.HBgLMTY0NjcwNDM1OTUVAgARGBI1QjJGRjI1RDY0RkE4Nzg4QzcA
<WHATSAPP_MESSAGE_ID> StringWhatsApp message ID of the user's message.wamid.HBgLMTY0NjcwNDM1OTUVAgASGBQzQTRCRDcwNzgzMTRDNTAwRTgwRQA=
<WHATSAPP_USER_ID> StringWhatsApp user's WhatsApp ID.16505551234
<WHATSAPP_USER_NAME> StringWhatsApp user's name.Pablo Morales

Example request

curl 'https://graph.facebook.com/v25.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"  
        }  
      ]  
    }  
  ]  
}

Unofficial mirror for reference/search purposes. All content originates from developers.facebook.com — see the source link at the top of each page. Machine-readable indexes: llms.txt · llms-full.txt · About