> ## Documentation Index
> Fetch the complete documentation index at: https://docs.zixflow.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Send WhatsApp Interactive Address Message

> Send an interactive address message via WhatsApp

#### Description

This endpoint allows you to send an interactive address message via WhatsApp. Users can select an address from the interactive options provided.

#### Headers

<ParamField header="x-api-key" type="string" required placeholder="Enter your API key">
  Your API key for authentication.
</ParamField>

<ParamField header="x-workspace-id" type="string" required placeholder="Enter your workspace ID">
  Your workspace ID for authentication.
</ParamField>

#### Body

<ParamField body="recipient" type="string" required placeholder="Enter recipient phone number">
  The recipient's phone number in international format. Must include the country code without the leading plus sign (+) or any spaces, dashes, or other special characters. Format: country code followed by the phone number. Example: `919876543210` (India: country code `91` + number `9876543210`).
</ParamField>

<ParamField body="phone_id" type="string" required placeholder="Enter phone ID">
  The unique Phone ID associated with your WhatsApp Business account. You can find this on the Zixflow WhatsApp Settings page or by calling the Get WhatsApp Accounts endpoint.
</ParamField>

<ParamField body="interactive" type="object" required>
  Interactive address message object containing header, body, footer, and action.

  <Expandable title="interactive" defaultOpen="true">
    <ParamField body="type" type="string" required>
      Type of interactive message. Use "address" for address messages.
    </ParamField>

    <ParamField body="header" type="object">
      Optional header object with type and text/image/video/document.
    </ParamField>

    <ParamField body="body" type="object" required>
      Body object with text content.
    </ParamField>

    <ParamField body="footer" type="object">
      Optional footer object with text.
    </ParamField>

    <ParamField body="action" type="object" required>
      Action object containing address parameters and options.
    </ParamField>
  </Expandable>
</ParamField>

<ParamField body="post_back_url" type="string" placeholder="Enter post-back URL">
  (Optional) To receive post-back notifications about the sent message as it is delivered or failed. When a message status changes (delivered, failed, etc.), a notification will be sent to this URL. See [Postback Notifications](/api-reference/zixflow-ai/postback-notifications) for the payload format and field descriptions.
</ParamField>

<ParamField body="post_back_data" type="string" placeholder="Enter post-back data">
  (Optional) The data that will be sent back on the post\_back\_url with the notification. This can be used as an identifier for the sent message if the client wants to track or correlate messages with their own system. See [Postback Notifications](/api-reference/zixflow-ai/postback-notifications) for how it appears in the notification.
</ParamField>

#### Response

<ResponseField name="success" type="boolean">
  Indicates whether the request was successful. true if the request was accepted and queued, false otherwise.
</ResponseField>

<ResponseField name="message" type="string">
  Success message when the request succeeded, or error message when it failed.
</ResponseField>

<ResponseField name="request_id" type="string">
  Present only when success is true. Unique identifier for this request; use it for tracking and for correlating with postback notifications.
</ResponseField>

<ResponseExample>
  ```json 200-Success theme={null}
  {
    "success": true,
    "message": "WhatsApp request queued successfully",
    "request_id": "f8df74d1-11fa-4485-b164-b9a65358f4fc"
  }
  ```
</ResponseExample>
