Ctrlk
For the complete documentation index, see llms.txt. This page is also available as Markdown.

Template Structure API

This document contains the template object structure, including the template information block and the XML stored in the data field.

Use this page to understand the template object returned by the API and the XML stored in the data field. Reuse the same template UUID, version, role IDs, document IDs, and field names in Create Template, Send Envelope, and Fill Envelope.

Overview

The template object has two parts:

  1. Template object fields.

  2. Template XML in the data field.

The template object fields describe the template metadata. The data field stores the full template XML structure.

Template object example

{
  "access": "account",
  "archive": false,
  "categories": [0],
  "createdAt": "2026-06-04T10:00:00.000Z",
  "data": "<template>...</template>",
  "dataCreatedAt": "2026-06-04T10:00:00.000Z",
  "dataModifiedAt": "2026-06-04T10:00:00.000Z",
  "description": "Template description",
  "modifiedAt": "2026-06-04T10:00:00.000Z",
  "name": "Template name",
  "uuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "version": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
}

Template object fields

Argument
Format
Description

access

string

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.

archive

boolean

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

false — the template is active and available.

categories

Int(10)

Digit that corresponds to the category ID where the template is located

createdAt

string

Template creation date

dataCreatedAt

string

Template version creation date

modifiedAt

string

Template update date

dataModifiedAt

string

Template version update date

name

string

Template name

description

string

Template description

uuid

binary(16)

Template UUID (Universally Unique Identifier)

version

binary(16)

Template version UUID (Universally Unique Identifier)

Treat archive, createdAt, modifiedAt, dataCreatedAt, and dataModifiedAt as response metadata. Do not build request logic around these values.

Reusable identifiers

Use these values later in envelope requests:

  • uuid — template UUID

  • version — template version UUID

  • role id — recipient role identifier

  • document id — document identifier inside the template

  • field name — field identifier used when sending values

data field

The data field contains template XML.

How template XML is organized

The template XML contains these main blocks:

  • info — template-level settings

  • documents — structured and external documents

  • signatures — signature placements

  • flow — recipient roles and their order

Info

Argument
Description

name

Template name

description

Template short description

subject

Envelope subject. You can provide it in the template or in the envelope

message

Envelope short message. You can provide it in the template or in the envelope

expire

Envelope 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.

External document info

Argument
Description

document type

Document type. This attribute is provided only for an external document. It can be <type="singleAttachment">

document id

Document identifier

title

Document name

Body

This block contains an attachment field 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

Related topics

PreviousTemplate APINextTemplate Static Elements API

Last updated

Was this helpful?