Zum Hauptinhalt springen

Template

idstringrequired

The template id: tpl_ and 32 hexadecimal digits.

Example: tpl_3c9a0e5b7d1f4a2c8e6b0d4f2a7c9e1b
slugstringrequired

The name a render uses as template, unique in the workspace.

Example: invoice-de
namestringrequired
Example: Rechnung (DE)
descriptionstringnullablerequired
kindTemplateKindrequired

pdf and image templates are HTML; docx and pptx templates are Word and PowerPoint files with tags in their text, rendered live from the Starter plan on (test renders on Free produce the marked PDF only).

Possible values: [pdf, image, docx, pptx]

engineEnginerequired

The template language: Jinja2 (Nunjucks), Liquid or Handlebars.

Possible values: [jinja2, liquid, handlebars]

tagsstring[]required
published_versionintegernullablerequired

The number of the published version; null before the first publish.

latest_versionintegerrequired

The number of the newest version, published or not; 0 only for a Word or PowerPoint template whose first file is still being stored.

Possible values: >= 0

created_atstring<date-time>required
updated_atstring<date-time>required
Template
{
"id": "tpl_3c9a0e5b7d1f4a2c8e6b0d4f2a7c9e1b",
"slug": "invoice-de",
"name": "Rechnung (DE)",
"description": "string",
"kind": "pdf",
"engine": "jinja2",
"tags": [
"string"
],
"published_version": 0,
"latest_version": 0,
"created_at": "2024-07-29T15:51:28.071Z",
"updated_at": "2024-07-29T15:51:28.071Z"
}