Types

DocumentTemplate

An org-managed document (subscription) template: the uploaded PDF or DOCX, its processing state and how many field placements it has.

idrequired
string (uuid)
The template's id.
namerequired
string | null
The template's display name, or null when it has never been named. Search matches it and the original filename.
typerequired
string
What the template is for. Only subscription_document exists.One of: subscription_document
kindrequired
string
The kind of file the template holds. It is fixed when the template is created.One of: docx, pdf
original_filenamerequired
string
The name of the file as it was uploaded.
validatedrequired
boolean
Whether processing has finished: page sizes read from a PDF, or variables read from a DOCX. A new template is not validated until then.
variable_countrequired
integer
How many variables were found in a DOCX template. Zero for a PDF.
variablesrequired
string[]
The variable names found in a DOCX template. Empty for a PDF.
page_metadatarequired
object[]
The size of each page of a PDF template. Empty for a DOCX template and until a PDF has been processed.
positions_countrequired
integer
How many field placements the template has. Read them at GET /document-templates/{id}/positions.
mapped_field_refs
string[]
The distinct form field references that have at least one placement. DocuSign and auxiliary placements are left out.
validated_atrequired
string | null (date-time)
When processing finished, or null while it has not.
created_atrequired
string | null (date-time)
When the template was uploaded.
updated_atrequired
string | null (date-time)
When the template last changed.

Used by (5)