search
Ctrlk

Template Structure API

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

hashtag
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

hashtag
Template information block

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)

hashtag
‘data’ parameter

circle-info

‘data’ parameter is a XML.

hashtag
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

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

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

hashtag
Signatures

Argument
Description

name

Signature name

role id

Role identifier

document id

Document identifier

hashtag
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

PreviousTemplate APINextTemplate Static Elements API

Last updated