Takeinteger(int32)
>= 0<= 20
Searchstring
ContinuationTokenstring
Filtersstring
GetDocumentTemplatesAsync
get
/v1/documentTemplates
Query Parameters
Response
application/json
Response
application/json
Success
DocumentTemplateSearchResponse
* Additional properties are NOT allowed.
itemsarray | null[object]
* Additional properties are NOT allowed.
Show Child Parameters
continuationTokenstring | null
application/json
CreateDocumentTemplateAsync
post
/v1/documentTemplates
Body
Body
DocumentTemplateRequest
* Additional properties are NOT allowed.
namestring | null
rsTemplateIdstring | null
rsTemplateParentIdstring | null
statusstring
Allowed values:DraftLiveExpired
fileobject
* Additional properties are NOT allowed.
Show Child Parameters
rolesarray | null[object]
* Additional properties are NOT allowed.
Show Child Parameters
fieldsarray | null[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
descriptionstring | null
messagestring | null
tagsarray | null[string]
isKbaEnabledboolean | null
isPasscodeEnabledboolean | null
isSharedboolean | null
signerSequencingboolean | null
containerRIDstring | null
base64EncodedFilestring | null
variablesarray | null[object]
* Additional properties are NOT allowed.
Show Child Parameters
Response
application/json
Response
application/json
Created
DocumentTemplateResponse
* Additional properties are NOT allowed.
idstring | null
ridstring | null
containerRIDstring | null
namestring | null
creatorobject
* Additional properties are NOT allowed.
Show Child Parameters
rsTemplateIdstring | null
rsTemplateParentIdstring | null
statusstring
Allowed values:DraftLiveExpired
fileobject
* Additional properties are NOT allowed.
Show Child Parameters
rolesarray | null[object]
* Additional properties are NOT allowed.
Show Child Parameters
fieldsarray | null[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 | null
messagestring | null
tagsarray | null[string]
isKbaEnabledboolean | null
isPasscodeEnabledboolean | null
isSharedboolean | null
signerSequencingboolean | null
createdAtstring | null(date-time)
updatedAtstring | null(date-time)
variablesarray | null[object]
* Additional properties are NOT allowed.
Show Child Parameters
application/json
GetDocumentTemplateAsync
get
/v1/documentTemplates/{documentTemplateRID}
Path Parameters
documentTemplateRIDstringrequired
Response
application/json
Response
application/json
Success
DocumentTemplateResponse
* Additional properties are NOT allowed.
idstring | null
ridstring | null
containerRIDstring | null
namestring | null
creatorobject
* Additional properties are NOT allowed.
Show Child Parameters
rsTemplateIdstring | null
rsTemplateParentIdstring | null
statusstring
Allowed values:DraftLiveExpired
fileobject
* Additional properties are NOT allowed.
Show Child Parameters
rolesarray | null[object]
* Additional properties are NOT allowed.
Show Child Parameters
fieldsarray | null[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 | null
messagestring | null
tagsarray | null[string]
isKbaEnabledboolean | null
isPasscodeEnabledboolean | null
isSharedboolean | null
signerSequencingboolean | null
createdAtstring | null(date-time)
updatedAtstring | null(date-time)
variablesarray | null[object]
* Additional properties are NOT allowed.
Show Child Parameters
application/json
UpdateDocumentTemplateAsync
put
/v1/documentTemplates/{documentTemplateRID}
Path Parameters
documentTemplateRIDstringrequired
Body
Body
DocumentTemplateRequest
* Additional properties are NOT allowed.
namestring | null
rsTemplateIdstring | null
rsTemplateParentIdstring | null
statusstring
Allowed values:DraftLiveExpired
fileobject
* Additional properties are NOT allowed.
Show Child Parameters
rolesarray | null[object]
* Additional properties are NOT allowed.
Show Child Parameters
fieldsarray | null[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
descriptionstring | null
messagestring | null
tagsarray | null[string]
isKbaEnabledboolean | null
isPasscodeEnabledboolean | null
isSharedboolean | null
signerSequencingboolean | null
containerRIDstring | null
base64EncodedFilestring | null
variablesarray | null[object]
* Additional properties are NOT allowed.
Show Child Parameters
Response
application/json
Response
application/json
Success
DocumentTemplateResponse
* Additional properties are NOT allowed.
idstring | null
ridstring | null
containerRIDstring | null
namestring | null
creatorobject
* Additional properties are NOT allowed.
Show Child Parameters
rsTemplateIdstring | null
rsTemplateParentIdstring | null
statusstring
Allowed values:DraftLiveExpired
fileobject
* Additional properties are NOT allowed.
Show Child Parameters
rolesarray | null[object]
* Additional properties are NOT allowed.
Show Child Parameters
fieldsarray | null[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 | null
messagestring | null
tagsarray | null[string]
isKbaEnabledboolean | null
isPasscodeEnabledboolean | null
isSharedboolean | null
signerSequencingboolean | null
createdAtstring | null(date-time)
updatedAtstring | null(date-time)
variablesarray | null[object]
* Additional properties are NOT allowed.
Show Child Parameters
application/json
PartialUpdateDocumentTemplateAsync
patch
/v1/documentTemplates/{documentTemplateRID}
Path Parameters
documentTemplateRIDstringrequired
Body
application/json-patch+json
Body
application/json-patch+json
JsonPatchDocument
Array of operations to perform
opstring
valuestring | null
pathstring
Response
application/json
Response
application/json
Success
DocumentTemplateResponse
* Additional properties are NOT allowed.
idstring | null
ridstring | null
containerRIDstring | null
namestring | null
creatorobject
* Additional properties are NOT allowed.
Show Child Parameters
rsTemplateIdstring | null
rsTemplateParentIdstring | null
statusstring
Allowed values:DraftLiveExpired
fileobject
* Additional properties are NOT allowed.
Show Child Parameters
rolesarray | null[object]
* Additional properties are NOT allowed.
Show Child Parameters
fieldsarray | null[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 | null
messagestring | null
tagsarray | null[string]
isKbaEnabledboolean | null
isPasscodeEnabledboolean | null
isSharedboolean | null
signerSequencingboolean | null
createdAtstring | null(date-time)
updatedAtstring | null(date-time)
variablesarray | null[object]
* Additional properties are NOT allowed.
Show Child Parameters
application/json