Skip to main content
GET
/
api
/
v1
/
campaign
/
whatsapp
/
variable-keys
curl --location --request GET 'https://api.zixflow.com/api/v1/campaign/whatsapp/variable-keys?templateName=welcome_message&language=en' \
--header 'Authorization: Bearer {{zixflow_api_key}}'

{
  "status": true,
  "message": "Success",
  "data": [
    {
      "label": "Header Image",
      "keyName": "image",
      "type": "IMAGE_URL"
    },
    {
      "label": "Body 1",
      "keyName": "body_1",
      "type": "TEXT"
    }
  ]
}

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.

​
Query Params

​
phoneId
string
required
This is the unique identifier associated with the sender’s phone number given by WhatsApp. Find the Phone ID on the Zixflow WhatsApp Settings page next to the number. Whatsapp Settings
​
templateName
string
required
Refers to the name of the template to be used for the message, e.g., “welcome_message.”
​
language
string
required
Specifies the language for the message, e.g., “en” for English.

​
Response

​
status
boolean
Indicates whether the call was successful. true if successful, false if not.
​
message
string
success or error response message
​
data
array_object
The contents of uploaded file
curl --location --request GET 'https://api.zixflow.com/api/v1/campaign/whatsapp/variable-keys?templateName=welcome_message&language=en' \
--header 'Authorization: Bearer {{zixflow_api_key}}'

{
  "status": true,
  "message": "Success",
  "data": [
    {
      "label": "Header Image",
      "keyName": "image",
      "type": "IMAGE_URL"
    },
    {
      "label": "Body 1",
      "keyName": "body_1",
      "type": "TEXT"
    }
  ]
}