Sign in

v1

latestOpenAPI 3.1.02026-07-17220542.8 KB
Templates

Update template documents

The API endpoint allows you to add, remove or replace documents in the template with provided PDF/DOCX file or HTML content.

put/templates/{id}/documents

Path parameters

idinteger required

The unique identifier of the document template.

Request body

mergeboolean

Set to true to merge all existing and new documents into a single PDF document in the template.

Example request

{
  "documents": [
    {
      "name": "Test Template"
    }
  ]
}

Response

OK

idinteger required

Unique identifier of the document template.

slugstring required

Unique slug of the document template.

namestring required

The name of the template.

preferencesobject required

Template preferences.

author_idinteger required

Unique identifier of the author of the template.

archived_atstring nullable required

Date and time when the template was archived.

created_atstring required

The date and time when the template was created.

updated_atstring required

The date and time when the template was last updated.

source'native' | 'api' | 'embed' required

Source of the template.

external_idstring nullable required

Your application-specific unique string key to identify this template within your app.

folder_idinteger required

Unique identifier of the folder where the template is located.

folder_namestring required

Folder name where the template is located.

shared_linkboolean

Indicates if the template is accessible by link.