Skip to main content
POST
https://api-ai.zixflow.com
/
api
/
ingestion
/
whatsapp
/
v1
/
message
/
interactive
/
address
/
send
Send WhatsApp Interactive Address Message
curl --request POST \
  --url https://api-ai.zixflow.com/api/ingestion/whatsapp/v1/message/interactive/address/send \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <x-api-key>' \
  --header 'x-workspace-id: <x-workspace-id>' \
  --data '
{
  "recipient": "<string>",
  "phone_id": "<string>",
  "interactive": {
    "type": "<string>",
    "header": {},
    "body": {},
    "footer": {},
    "action": {}
  },
  "post_back_url": "<string>",
  "post_back_data": "<string>"
}
'
{
  "status": true,
  "message": "WhatsApp interactive address message sent successfully"
}

​
Description

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

​
Headers

​
x-api-key
string
required
Your API key for authentication.
​
x-workspace-id
string
required
Your workspace ID for authentication.

​
Body

​
recipient
string
required
The phone number of the recipient in international format (e.g., “919876543210”).
​
phone_id
string
required
The unique identifier associated with the sender’s phone number given by WhatsApp.
​
interactive
object
required
Interactive address message object containing header, body, footer, and action.
​
post_back_url
string
Optional URL to receive post-back notifications about the message status.
​
post_back_data
string
Optional data to include in post-back notifications.

​
Response

​
status
boolean
Indicates whether the call was successful. true if successful, false if not.
​
message
string
Success or error response message.
{
  "status": true,
  "message": "WhatsApp interactive address message sent successfully"
}