v1

latestOpenAPI 3.1.02026-07-17220542.8 KB
Templates

Merge templates

The API endpoint allows you to merge multiple templates with documents and fields into a new combined template.

post/templates/merge

Request body

template_idsinteger[] required

An array of template ids to merge into a new template.

namestring

Template name. Existing name with (Merged) suffix will be used if not specified.

folder_namestring

The name of the folder in which the merged template should be placed.

external_idstring

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

shared_linkboolean

Set to true to make the template available via a shared link. This will allow anyone with the link to create a submission from this template.

rolesstring[]

An array of submitter role names to be used in the merged template.

Example request

{
  "template_ids": [
    321,
    432
  ],
  "name": "Merged Template",
  "roles": [
    "Agent",
    "Customer"
  ]
}

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.