WhatsApp Business API templates

Knowledge Base

Knowledge Base

WhatsApp Business API templates

WABA templates are a way to initiate a conversation with a client in the WhatsApp Business API channel.

👉 What is a WABA template, what does a WABA template consist of and how to create it in the Wazzup account

To get a list of WABA templates that were created in Wazzup, send:

GET https://api.wazzup24.com/v3/templates/whatsapp

Request structure

GET /v3/templates/whatsapp
├── limit
└── offset

Request parameters

Name	Type	Description
limit	number	Records returned limit Default: 100
offset	number	From which template to send the list. Useful if you have previously requested a list, but since then the user has created new templates and you only need to get new templates Default: 0

Request example

curl --location --request GET 'https://api.wazzup24.com/v3/templates/whatsapp' \
--header 'Authorization: Bearer f6633fb8f4c648fasssf0e9f43a334c1b' \
--data-raw ''

Response structure

Response
├── templateGuid
├── accountId
├── title
├── name
├── waba
│   ├── wabaId
│   └── wabaName
├── channels[]
├── category
├── language
├── status
├── rejected_reason
├── namespace
└── components[]
    ├── type
    ├── format
    ├── text
    ├── example[]
    └── buttons[]
        ├── type
        ├── text
        └── url

Response parameters

Name	Type	Description
templateGuid	string	Template ID
accountId	number	Account ID
title	string	Template name in Wazzup account. It is used to find the template faster in the template list
name	string	Template name, that will be sent to Facebook
waba	object waba	Object filled with the information about Meta Business Account
channels	array	Channel list to which templates are connected
category	string	Template category
language	string	Template language
status	string	Moderation status
rejected_reason	string	The reason for the rejection if the status is rejected
namespace	string	Facebook namespace
components	Object (Array) components	List of template components

waba (object)

Name	Type	Description
wabaId	string	Meta Business Account ID
wabaName	string	Meta Business Account name

components (object)

Name	Type	Description
type	string	Template component type: HEADER, FOOTER, BUTTONS, BODY
format	string	Format. Only for component HEADER: IMAGE, DOCUMENT, VIDEO, TEXT
text	string	Component text, if there's any text
example	String (Array)	List of examples of filling variables for the corresponding template component
buttons	Object (Array) buttons	List of buttons, if they are in the template

buttons (object)

Name	Type	Description
type	string	Button type: URL, QUICK_REPLY, PHONE_NUMBER
text	string	Button text
url	string	The link that the button will follow if it is a button of the URL type

Answer examples

HTTP/1.1 200 OK
[
 {
  "templateGuid": "8d255e5d-aefd-44dc-8131-c3ad6c3ab28c",
  "accountId": 70789196,
  "title": "Template name",
  "channels": ["e9a268e4-44af-41cd-9b63-2524a4ad653e"],
  "order": 0,
  "category": "MARKETING",
  "language": "ru",
  "components": [
    {
     "text": "Hi, !",
     "type": "HEADER",
     "format": "TEXT",
     "example": {
     "header_text": ["header-example-1"]
      }
    },
    {
     "text": "We have some news",
     "type": "BODY",
     "example": {
      "body_text": [["body-example-1"]]
     }
 }
 ],
  "waba": {
   "wabaId": "194388939529290",
   "wabaName": "Wazzup LLC"
 },
 "name": "Template name",
 "namespace": "c8ae5f90_307a_ca4c_b8f6_d1e2a2573574",
 "publishedAt": null,
 "isTrickyTemplate": false,
 "trickyTemplatesPriority": null,
 "createdAt": "2023-12-31T23:55:42.504Z",
 "updatedAt": "2023-12-31T23:55:08.857Z",
 "componentsDefaults": {},
 "tags": null,
 "templateCode": "@template: fe03cddf-dec1-4c19-aede-e16190abca46 { [[headerVar1]]; [[bodyVar1]] }"
}