Search
K
Document Generator API

DocumentTemplateRequestJsonPatchDocument

object
* Additional properties are NOT allowed.
operationsarray[object]read-only
* Additional properties are NOT allowed.
Show Child Parameters
contractResolverobject
* Additional properties are NOT allowed.
Example

DocumentTemplateRequestOperation

object
* Additional properties are NOT allowed.
operationTypestring

Allowed values:AddRemoveReplaceMoveCopyTestInvalid

pathstring
opstring
fromstring
value
Example

DocumentTemplateResponse

object
* Additional properties are NOT allowed.
idstring
ridstring
containerRIDstring
namestring
creatorobject
* Additional properties are NOT allowed.
Show Child Parameters
rsTemplateIdstring
rsTemplateParentIdstring
statusstring

Allowed values:DraftLiveExpired

fileobject
* Additional properties are NOT allowed.
Show Child Parameters
rolesarray[object]
* Additional properties are NOT allowed.
Show Child Parameters
fieldsarray[object]
* Additional properties are NOT allowed.
Show Child Parameters
templateTypestring

Allowed values:StaticDynamic

esignSettingsobject
* Additional properties are NOT allowed.
Show Child Parameters
workflowSettingsobject
* Additional properties are NOT allowed.
Show Child Parameters
permissionsobject
* Additional properties are NOT allowed.
Show Child Parameters
descriptionstring
messagestring
tagsarray[string]
isKbaEnabledboolean
isPasscodeEnabledboolean
isSharedboolean
signerSequencingboolean
createdAtstring(date-time)
updatedAtstring(date-time)
variablesarray[object]
* Additional properties are NOT allowed.
Show Child Parameters
Example

DocumentTemplateSearchResponse

object
* Additional properties are NOT allowed.
itemsarray[object]
* Additional properties are NOT allowed.
Show Child Parameters
continuationTokenstring
Example

DocumentTemplateStatus

string

Allowed values:DraftLiveExpired