Document templates

List, create, read, update and delete document templates, such as PDF document layouts.

Document templates are the settings records behind generated documents, each with a type such as PDF_DOCUMENT. You can list, create, read, update and delete them. This area has 5 endpoints, and all seven SDKs call every one.

At a glance

Endpoint	Method	Path	What it does
List document templates	GET	/settings/document_templates	Returns a page of document templates under data, with paging details under pagination.
Create a document template	POST	/settings/document_templates	Creates a document template and returns it under document_template.
Retrieve a document template	GET	/settings/document_templates/{document_template_id}	Returns one document template by its id, under document_template.
Delete a document template	DELETE	/settings/document_templates/{document_template_id}	Deletes a document template. The response has no body.
Update a document template	PATCH	/settings/document_templates/{document_template_id}	Changes the fields you send on a document template and returns it under document_template.

Before you call

Register your API credentials once when your app starts, as shown in Authentication. Every SDK sample on these pages then gets its client in one line. With cURL, send the access token in an Authorization header: Authorization: Bearer $ACCESS_TOKEN.

Things to know

• name and document_template_type are required on a create. For example "document_template_type": "PDF_DOCUMENT".
• A read reports the type in type. It also says whether the template is a system, custom, default or edited one.
• A document template id starts with dt_.
• Listings page by cursor. Records sit under data; pass pagination.next_cursor as cursor to read the next page, and stop when pagination.has_more is false.
• A delete returns 204 with no body. Reading the document template afterwards returns 404.