Skip to main content
GET
https://api.zixflow.com
/
api
/
v1
/
campaign
/
whatsapp
/
templates
/
{phoneId}
Get List Of Templates
curl --request GET \
  --url https://api.zixflow.com/api/v1/campaign/whatsapp/templates/{phoneId} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "limit": 123,
  "offset": 123
}
'
{
  "status": true,
  "message": "Success",
  "data": [
    {
      "language": "en",
      "name": "unsubscribe_response",
      "category": "MARKETING",
      "components": [
        {
          "type": "HEADER",
          "format": "TEXT",
          "text": "Unsubscribe"
        },
        {
          "type": "BODY",
          "text": "We're sorry to see you go 💔\n\nYou've been unsubscribed from receiving messages from us.\n\nIf you'd like to again start getting messages, reply with *START*"
        }
      ],
      "status": "APPROVED"
    }
  ]
}

​
Path 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

​
Query Params

​
limit
number
required
The number of templates to be returned, set to 10 in this instance. This parameter restricts the response to a specific quantity of templates.
​
offset
number
required
The starting point from which the templates are to be fetched within the entire dataset. In this case, it is set to 0, indicating that retrieval should commence from the beginning of the dataset.

​
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
{
  "status": true,
  "message": "Success",
  "data": [
    {
      "language": "en",
      "name": "unsubscribe_response",
      "category": "MARKETING",
      "components": [
        {
          "type": "HEADER",
          "format": "TEXT",
          "text": "Unsubscribe"
        },
        {
          "type": "BODY",
          "text": "We're sorry to see you go 💔\n\nYou've been unsubscribed from receiving messages from us.\n\nIf you'd like to again start getting messages, reply with *START*"
        }
      ],
      "status": "APPROVED"
    }
  ]
}