Send a Location

In this code snippet you learn how to send a location to WhatsApp using the Messages API. This uses Nexmo's Custom object feature. Further information on the specific message format can be found in the WhatsApp developers Location message documentation.


Ensure the following variables are set to your required values using any convenient method:

Key Description
WHATSAPP_NUMBER The WhatsApp number that has been allocated to you by Nexmo.
TO_NUMBER The phone number you are sending the message to.

NOTE: Don't use a leading + or 00 when entering a phone number, start with the country code, for example, 447700900000.


Create an application
If you do not have an application you can create one. Make sure you also configure your webhooks.

Write the code

Add the following to

Copy to Clipboard
curl -X POST \ \
  -H 'Authorization: Bearer' $JWT \
  -H 'Content-Type: application/json' \
  -d '{
  "from": {
    "type": "whatsapp",
    "number": "'$WHATSAPP_NUMBER'"
  "to": {
    "type": "whatsapp",
    "number": "'$TO_NUMBER'"
  "message": {
    "content": {
      "type": "custom",
      "custom": {
        "type": "location",
        "location": {
          "longitude": -122.425332,
          "latitude": 37.758056,
          "name": "Facebook HQ",
          "address": "1 Hacker Way, Menlo Park, CA 94025"

View full source

Run your code

Save this file to your machine and run it:


Try it out

When you run the code a WhatsApp location message is sent to the destination number. The location appears as a pin on a map within the WhatsApp message window.

Further information