Get Message Templates

Retrieve approved templates for the account

GET /account/templates

Get Message Templates

cURL

curl --request GET \
  --url https://chat.zoko.io/v2/account/templates \
  --header 'apikey: <api-key>'

200

[
  {
    "channel": "whatsapp",
    "isRichTemplate": false,
    "templateType": "<string>",
    "templateId": "greeting_01",
    "templateLanguage": "en",
    "templateDesc": "Good morning {{1}}. How may I help you today?",
    "templateVariableCount": 1,
    "active": true
  }
]

Authorizations

apikey · string · header · required

Authentication is done via apikey provided for your account

Include the following in your request header

apikey: "your_apikey_here"

Response

200

application/json

Approved template list

channel · enum<string>

Available options: whatsapp

isRichTemplate · boolean

is the template a rich media template?

Example:

false

templateType · string

type of the template

Used as type in send message for templates. Values are template, richTemplate or buttonTemplate

templateId · string

template id approved by the respective channel.

Used as templateId in send message for templates

Example:

"greeting_01"

templateLanguage · string

template id approved by the respective channel.

Used as templateLanguage in send message for templates

Example:

"en"

templateDesc · string

template definition

Example:

"Good morning {{1}}. How may I help you today?"

templateVariableCount · integer

Number of placeholders for the template.

Array size of templateArgs in send message

Example:

1

active · boolean

is the template active for API use?

Example:

true