get https://{subdomain}.kommo.com/api/v4/chats/templates
The method allows you to get a list of templates in your account.
Limitations
The method is available with administrator rights.
The method returns only the templates that were created by the current integration.
Data type header on success
Content-Type: application/hal+json
Data type header on error
Content-Type: application/problem+json
Response parameters
| Parameter | Data Type | Description |
|---|---|---|
id | int | Template ID |
account_id | int | ID of the account the template belongs to |
name | string | Template name |
content | string | Template body (the message that is sent to the user) |
is_editable | bool | It defines whether users can edit the template via Kommo interface. |
type | string | Template type |
buttons | array | Array of button objects |
buttons[] | obj | A button object |
buttons[][type] | string | Button type. Available options are inline (plain text button) and url (link button) |
buttons[][text] | string | Text on the button |
buttons[][url] | string | URL of the button of the url type |
attachment | object|null | Object of the file added to the template |
attachment[id] | string | UUID of the file attached to the template |
attachment[name] | string | File name (it will be passed to a messenger) |
attachment[type] | string | Type of the file (picture, file, document, video) |
attachment[is_external] | bool | Indicator that the file is from a file service. For all templates added from spring 2022 returns true. |
created_at | int | Indicates when the template was added in Unix Timestamp |
updated_at | int | Indicates when the template was updated last time in Unix Timestamp |
external_id | string | External template ID. Template ID in your system. |
review_status | string|null | WhatsApp template status: approved/review/paused/rejected. It requires GET parameter with. |
is_on_review | null|bool | Indicates whether the template is being reviewed? It requires GET parameter with. |
waba_footer | string | Whatsapp template footer |
waba_category | string | WhatsApp template category. The following categories are available: UTILITY/AUTHENTICATION/MARKETING |
waba_language | string | Language of the Whatsapp template |
waba_examples | obj | Examples of replacing WhatsApp template markup elements. Example "waba_examples":{"{{lead.name}}":"qwerty"} |
waba_header | string | WhatsApp template header with a limit of up to 60 characters. |
waba_header_type | string | WhatsApp template header type. Available options: text (WhatsApp template with a header), media (WhatsApp template with a media header, there must be a file attached). |
_embedded | obj | An object containing information related to the request |
_embedded.reviews | array | WhatsApp template statuses array. It requires GET parameter with. |
_embedded.reviews[][id] | int | WhatsApp template status ID. It requires GET parameter with. |
_embedded.reviews[][source_id] | int | WhatsApp template status source ID. It requires GET parameter with. |
_embedded.reviews[][reject_reason] | string | The reason the WhatsApp template was rejcted. It requires GET parameter with. |
_embedded.reviews[][status] | string | WhatsApp template status. It requires GET parameter with. |