# Send Address Message

**POST** `/{phone_number_id}/messages`

Product: [WhatsApp](https://devdocs.pinnacle.in/docs/whatsapp.md)  
Version: [3.0](https://devdocs.pinnacle.in/docs/whatsapp/3-0.md)

This API is used to send the address message to the end user.

## Request

URL: `https://partnersv1.pinbot.ai/v3/{phone_number_id}/messages`

Authentication location: `header`

Authentication name: `apikey`

### Request schema


```json
{
  "type": "object",
  "properties": {
    "raw_example": {
      "type": "string"
    }
  }
}
```

### Request example


```json
{
  "raw_example": "{\n\"messaging_product\": \"whatsapp\",\n\"recipient_type\": \"individual\",\n\"to\": \"91XXXXXXXXXX\",\n\"type\": \"interactive\",\n\"interactive\": {\n\"type\": \"address_message\",\n\"body\": {\n\"text\": \"Thanks for your order! Tell us what address you'd like this order\ndelivered to.\"\n},\n\"action\": {\n\"name\": \"address_message\",\n\"parameters\": {\n\"country\" :\"COUNTRY_ISO_CODE\"\n}\n\n}\n}\n}"
}
```

## Response schema


```json
{
  "type": "object",
  "properties": {
    "raw_example": {
      "type": "string"
    }
  }
}
```

## Response examples


```json
{
  "200": {
    "raw_example": "{\n\"messaging_product\": \"whatsapp\",\n\"contacts\": [\n{\n\"input\": \"9175XXXXXXXX\",\n\"wa_id\": \"9175XXXXXXXX\"\n}\n],\n\"messages\": [\n{\n\"id\":\n\"wamid.HBgMOTE3OTcyODkyNzEyFQIAERgSQUM3MzRCRjdFREYzOENDNTgwAA=\n=\"\n}\n]\n}\nCurrently address messages are supported in the following two countries: India and\nSingapore. Below table outlines which fields are supported in which country specifically.\n\nField name Display label Input type Supported Limitations\ncountries\nname Name text India, None\nSingapore\nphone_number Phone Number tel India, Valid phone\nSingapore numbers only\nin_pin_code Pin Code text India Max length: 6\nsg_post_code Post Code number Singapore Max length: 6\nhouse_number Flat/House text India None\nNumber\nfloor_number Floor Number text India None\ntower_number Tower Number text India None\nbuilding_name Building/Apart text India None\nment Name\naddress Address text India, None\nSingapore\nlandmark_area Landmark/Area text India None\nunit_number Unit number text Singapore None\ncity City text India, None\nSingapore\nstate State text India None\n\nSENDING CUSTOM PARAMETERS WHILE SENDING MESSAGES\nSample Request:\n{\n\"messaging_product\": \"whatsapp\",\n\"preview_url\": false,\n\"recipient_type\": \"individual\",\n\"to\": \"{{Recipient-Phone-Number}}\",\n\"type\": \"text\",\n\"text\": {\n\"body\": \"Sample-text\"\n},\n\"biz_opaque_callback_data\": {\n\"source\": \"api\",\n\"date\": \"2024-03-01\",\n\"uuid\": \"fuif-0deu-dgyu-5674-jcur-jdu9-89eu\"\n}\n}\nParameter Description:\nName Value\nbiz_opaque_callback_data Optional\nAn arbitrary string, useful for tracking.\nFor example, you could pass the message\ntemplate ID in this field to track your customer's\njourney starting from the first message you send.\n\nYou could then track the ROI of different message\ntemplate types to determine the most effective one.\nAny app subscribed to the messages webhook field\non the WhatsApp Business Account can get this\nstring, as it is included in statuses object within\nwebhook payloads.\nCloud API does not process this field, it just returns\nit as part of sent/delivered/read message\nwebhooks.\nMaximum 512 characters.\nThis custom parameter - biz_opaque_callback_data will be returned in the webhook\ncallback payload from Meta.\n{\"object\":\"whatsapp_business_account\",\"entry\":[{\"id\":\"112365665238904\",\"changes\":[{\"v\nalue\":{\"messaging_product\":\"whatsapp\",\"metadata\":{\"display_phone_number\":\"91XXXX\nXXXXXX\",\"phone_number_id\":\"10XXXXXXXXXXXXXX\"},\"statuses\":[{\"id\":\"wamid.HBgM\nOTE3NTA3MDY2MzMxFQIAERgSQzZGNUVFOTgxMUUyMkI3MzVBAA==\",\"status\":\"d\nelivered\",\"timestamp\":\"1709295133\",\"recipient_id\":\"91XXXXXXXXXX\",\"biz_opaque_call\nback_data\":\"{\\\"source\\\":\\\"api\\\",\\\"date\\\":\\\"2024-03-01\\\", \\\"uuid\\\":\n\\\"fuif-0deu-dgyu-5674-jcur-jdu9-89eu\\\"}\",\"conversation\":{\"id\":\"a34a10abd87c7badad4d1f\nc5bafadd71\",\"origin\":{\"type\":\"marketing\"}},\"pricing\":{\"billable\":true,\"pricing_model\":\"CBP\"\n,\"category\":\"marketing\"}}]},\"field\":\"messages\"}]}]}\n"
  }
}
```

## Status codes


```json
[
  {
    "code": 200,
    "description": "The request was successful."
  },
  {
    "code": 400,
    "description": "Bad request or invalid parameters."
  },
  {
    "code": 401,
    "description": "API key is missing or invalid."
  },
  {
    "code": 403,
    "description": "The request is not authorized for this resource."
  },
  {
    "code": 404,
    "description": "The requested resource was not found."
  },
  {
    "code": 500,
    "description": "The server encountered an error."
  }
]
```