Address

This page describes how to send address messages on the WhatsApp Business Platform.

This feature is only available for businesses based in India and their India customers.

Address Message Request

POST https://waba-v2.360dialog.io/messages

Address messages provide a structured way for WhatsApp users to share a delivery or shipping address with a business directly within a conversation.

Address messages are interactive messages composed of four main components: header, body, footer, and action. Within the action component, the business defines the action name address_message together with the required parameters.

Headers

Name	Value
Content-Type	application/json
Authorization	D360-API-KEY

Body Example

{
  "messaging_product": "whatsapp",
  "recipient_type": "individual",
  "to": "<PHONE_NUMBER>",
  "type": "interactive",
  "interactive": {
    "type": "address_message",
    "body": {
      "text": "Thanks for your order! Tell us what address you’d like this order delivered to."
    },
    "action": {
      "name": "address_message",
      "parameters": {
        "country": "<COUNTRY_ISO_CODE>"
      }
    }
  }
}

Response

200

{
  "contacts": [
    {
      "input": "text",
      "wa_id": "text"
    }
  ],
  "messages": [
    {
      "id": "text",
      "message_status": "accepted"
    }
  ],
  "messaging_product": "text"
}

400

Error Handling

If the phone number’s country code does not match the selected country, the address message cannot be requested. For example, an address message cannot be sent to a recipient whose country is set to India but whose phone number uses the country code +65.

After the address message is sent, the business must wait for the recipient to complete and submit the address form. The submitted address details are delivered through the configured webhook endpoint.

Address Message Steps

1. The business sends an address message to the recipient using the action name address_message.

2. The recipient interacts with the message by selecting the call-to-action (CTA), which opens the address message screen. The recipient completes the address form and submits it.

3. After the form is submitted, a webhook notification is sent to the configured endpoint containing the address details provided by the recipient.

The address message flow consists of the following steps: