# Template Structure API ### Template object (JSON) ``` { "access": "account", "archive": true, "categories": [ 0 ], "createdAt": "string", "data": "string", "dataCreatedAt": "string", "dataModifiedAt": "string", "description": "string", "modifiedAt": "string", "name": "string", "uuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "version": "3fa85f64-5717-4562-b3fc-2c963f66afa6" } ``` Template consists of two blocks: 1. **Template information block** 2. **‘data’ parameter** ### Template information block ``` { "access": "account", "archive": true, "categories": [ 0 ], "createdAt": "string", "dataCreatedAt": "string", "dataModifiedAt": "string", "description": "string", "modifiedAt": "string", "name": "string", "uuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "version": "3fa85f64-5717-4562-b3fc-2c963f66afa6" } ```
ArgumentFormatDescription
accessstring

Template access level:

Mailbox — available only for the mailbox where it was created.

Account — available for all account mailboxes where it was created.

Public — available system-wide by UUID.

archiveboolean

true — the template was deleted and moved to the archive.

false — the template is active and available.

categoriesInt(10)Digit that corresponds to the category ID where the template is located
createdAtstringTemplate creation date
dataCreatedAtstringTemplate version creation date
modifiedAtstringTemplate update date
dataModifiedAtstringTemplate version update date
namestringTemplate name
descriptionstringTemplate description
uuidbinary(16)Template UUID (Universally Unique Identifier)
versionbinary(16)Template version UUID (Universally Unique Identifier)
### ‘data’ parameter {% hint style="info" %} **‘data’ parameter** is a XML. {% endhint %} ``` ``` #### Info
ArgumentDescription
nameTemplate name
descriptionTemplate short description
subjectEnvelope subject. You can provide it in the template or in the envelope
messageEnvelope short message. You can provide it in the template or in the envelope
expireEnvelope expiration date — how many days after creation the envelope expires
#### Structured document info | Argument | Description | | ----------- | ------------------- | | document id | Document identifier | | title | Document name | **Body** This block contains static data such as text and tables, plus [dynamic fields](/docstudio-docs/docstudio-for-developers/api-documentation/template-api/template-dynamic-fields-api.md). #### External document info
ArgumentDescription
document typeDocument type. This attribute is provided only for an external document. It can be <type="singleAttachment">
document idDocument identifier
titleDocument name
**Body** This block contains an [attachment field](/docstudio-docs/docstudio-for-developers/api-documentation/template-api/template-dynamic-fields-api/file-field-api.md) by default. #### Signatures | Argument | Description | | ----------- | ------------------- | | name | Signature name | | role id | Role identifier | | document id | Document identifier | #### Flow | Argument | Description | | -------- | --------------------------------------------------- | | role id | Role identifier | | title | Role name in the flow | | type | Role type. Can be `sender`, `assignee`, or `signer` | | order | Role order number | --- # Agent Instructions: Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the current page URL with the `ask` query parameter: ``` GET https://support.docstudio.com/docstudio-docs/docstudio-for-developers/api-documentation/template-api/template-structure-api.md?ask= ``` The question should be specific, self-contained, and written in natural language. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.