v3

latestSwagger 2.02026-08-067506752.0 MB

template

Create a template

post/v1/org/{orgId}/template

Path parameters

orgIdstring required

Org identifier (either id or slug)

Request body

namestring required

template name, must be unique to organization

descriptionstring

description of template

contentstring

template content

stylesheetstring

template inline stylesheet

fileIdstring

file identifier, if the template is based on a PDF file instead of a CQLT template

type'DOCUMENT' | 'EMAIL'

type of template

tagsstring[]

tags to organize the purpose of the template

filenamestring

document filename CQL

fieldIdstring

the field id that will be used to store documents generated by this template

qesFilterstring

filter expression evaluated on each signer for whether to use qualified electronic signature (if it evalutes to true for any signer, QES will be used). If null, defaults to org qesFilter setting

isSequentialboolean

whether signers must sign in sequential order; false (the default) means simultaneous signing

Example request

{
  "fileId": "588f7ee98f138b19220041a7",
  "fieldId": "588f7ee98f138b19220041a7"
}

Response

template created

idstring required

globally unique id

orgIdstring required

parent organization id

namestring required

template name, must be unique to organization

descriptionstring

description of template

contentstring

template content

stylesheetstring

template inline stylesheet

fileIdstring

file identifier, if the template is based on a PDF file instead of a CQLT template

type'DOCUMENT' | 'EMAIL' required

type of template

tagsstring[] required

tags to organize the purpose of the template

filenamestring

document filename CQL

fieldIdstring

the field id that will be used to store documents generated by this template

qesFilterstring

filter expression evaluated on each signer for whether to use qualified electronic signature (if it evalutes to true for any signer, QES will be used). If null, defaults to org qesFilter setting

isSequentialboolean

whether signers must sign in sequential order; false (the default) means simultaneous signing

createIdstring

created by user id

createBehalfIdstring

created on behalf of user id

createAtstring

created timestamp

updateIdstring

last updated by user id

updateBehalfIdstring

last updated on behalf of user id

updateAtstring

last updated timestamp

deleteIdstring

deleted by user id

deleteBehalfIdstring

deleted on behalf of user id

deleteAtstring

deleted timestamp

Example response

{
  "id": "588f7ee98f138b19220041a7",
  "orgId": "588f7ee98f138b19220041a7",
  "fileId": "588f7ee98f138b19220041a7",
  "fieldId": "588f7ee98f138b19220041a7",
  "createId": "588f7ee98f138b19220041a7",
  "createBehalfId": "588f7ee98f138b19220041a7",
  "createAttribution": {
    "principalUserId": "588f7ee98f138b19220041a7",
    "agentUserIds": [
      "588f7ee98f138b19220041a7"
    ],
    "eventId": "588f7ee98f138b19220041a7",
    "aiChatId": "588f7ee98f138b19220041a7"
  },
  "updateId": "588f7ee98f138b19220041a7",
  "updateBehalfId": "588f7ee98f138b19220041a7",
  "updateAttribution": {
    "principalUserId": "588f7ee98f138b19220041a7",
    "agentUserIds": [
      "588f7ee98f138b19220041a7"
    ],
    "eventId": "588f7ee98f138b19220041a7",
    "aiChatId": "588f7ee98f138b19220041a7"
  },
  "deleteId": "588f7ee98f138b19220041a7",
  "deleteBehalfId": "588f7ee98f138b19220041a7",
  "deleteAttribution": {
    "principalUserId": "588f7ee98f138b19220041a7",
    "agentUserIds": [
      "588f7ee98f138b19220041a7"
    ],
    "eventId": "588f7ee98f138b19220041a7",
    "aiChatId": "588f7ee98f138b19220041a7"
  },
  "deleteAt": "2017-01-24T13:57:52Z"
}