template

Update an existing template

patch/v1/org/{orgId}/template/email/{templateName}

Request

  • Base URL: https://localhost
  • URL: https://localhost/v1/org/{orgId}/template/email/{templateName}
  • Auth: none declared

Path parameters

templateNamestring required

Template name

Request body

namestring

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 updated

Changes

No recorded changes to this operation across all 20 revisions of this API.