Skip to main content

Template (TEMPLATE)

Template message. Typically used for marketing / notification push content.

data schema

{
template: {
id: string;
body: string;
name: string;
footer: string | null;
status: string;
buttons: Array<{
id: string;
text: string;
type: string;
}>;
fileUrl: string | null;
category: string;
fileType: string | null;
language: string;
chatAppId: string;
createdAt: string;
updatedAt: string;
isUsedInPanel: boolean;
externalTemplateId: string;
};
}
FieldTypeDescription
templateobjectTemplate object

template fields

FieldTypeDescription
idstringTemplate ID
namestringTemplate name
bodystringMain text
footerstring | nullFooter
buttonsarrayButton list (id, text, type)
statusstringStatus (e.g. APPROVED)
categorystringCategory (e.g. MARKETING)
languagestringLanguage code (e.g. TR)
fileUrl / fileTypestring | nullOptional media
chatAppIdstringRelated chat app
externalTemplateIdstringExternal template ID
createdAt / updatedAtstringTimestamps
isUsedInPanelbooleanPanel usage

Example

{
"id": "c4b461e8-c6e6-4265-88fd-e1e1b4a680fb",
"createdAt": "2026-04-27T10:44:34.010Z",
"type": "TEMPLATE",
"nameOfSender": "Support Bot",
"isFromSupport": true,
"data": {
"template": {
"id": "c432e921-e302-42ab-9ab6-3061e614a6de",
"body": "Çocuklara özel tiyatro gösterisi bugün saat 15.00'da. Tüm çocuklarımızı ve ailelerini bekleriz",
"name": "Kids Club",
"footer": null,
"status": "APPROVED",
"buttons": [
{
"id": "button_7a59a7",
"text": "Geliyoruz:)",
"type": "QUICK_REPLY"
}
],
"fileUrl": null,
"category": "MARKETING",
"fileType": null,
"language": "TR",
"chatAppId": "3d0a6c4f-2988-4229-b0b3-8cdcab1228c9",
"createdAt": "2026-04-15T10:31:02.499Z",
"updatedAt": "2026-04-16T06:56:53.700Z",
"isUsedInPanel": true,
"externalTemplateId": "e1b52ef1-210d-4018-a41b-82bad6a9bf4e"
}
}
}

UI recommendation

  • Show the template.body text; add footer if present.
  • Render the buttons list as clickable quick replies (text is the visible label, id is the technical ID).
  • If fileUrl is set, show the related media.