documentTemplateRIDstringrequired
PartialUpdateDocumentTemplateAsync
patch
/v1/documentTemplates/{documentTemplateRID}
Path Parameters
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
DeleteDocumentTemplateAsync
delete
/v1/documentTemplates/{documentTemplateRID}
Path Parameters
documentTemplateRIDstringrequired
Response
Response
No Content
/v1/documentTemplates/{documentTemplateRID}/file/download
get
/v1/documentTemplates/{documentTemplateRID}/file/download
Path Parameters
documentTemplateRIDstringrequired
Response
application/json
Response
application/json
Success
DownloadSpecification
* Additional properties are NOT allowed.
metadataUrlstring | null
__typestring | null
idstring | null
urlstring | null(uri)
downloadTokenstring | null
prepareXmlInfostring | null
downloadUrlstring | null(uri)
downloadPrepStartURLstring | null(uri)
downloadPrepStatusURLstring | null(uri)
application/json
/v1/documentTemplates/{documentTemplateRID}/file/thumbnail
get
/v1/documentTemplates/{documentTemplateRID}/file/thumbnail
Path Parameters
documentTemplateRIDstringrequired
Response
Response
Success
/v1/documentTemplates/{documentTemplateRID}/file/upload
post
/v1/documentTemplates/{documentTemplateRID}/file/upload
Path Parameters
documentTemplateRIDstringrequired
Response
application/json
Response
application/json
Success
FBPUploadSpecResponse
* Additional properties are NOT allowed.
methodstring | null
chunkUristring | null(uri)
finishUristring | null(uri)
canAcceptParamsInHeadersboolean | null
isDuplicateFileNameboolean | null
application/json