v1

latestOpenAPI 3.0.12026-07-242682197.7 KB
Template

Update Template

Updates an existing template.

put/api/v1/document_templates/{id}

Path parameters

idstring uuid required

Unique identifier for a template.

Request body

namestring

The name of the template.

subjectstring

Email subject for the signature request that recipients will see. Defaults to the default system subject or a template subject (if the document is created from a template).

messagestring

Email message for the signature request that recipients will see. Defaults to the default system message or a template message (if the document is created from a template).

draftboolean

Whether the template can still be updated before it is ready for usage. If set to false the template is marked as Available and it will be ready for use. Defaults to false.

expires_ininteger

Number of days before the signature request expires. Defaults to the account expiration setting or template expiration (if the document is created from a template).

remindersboolean

Whether to send signing reminders to recipients. Reminders are sent on day 3, day 6, and day 10 if set to true. Defaults to true.

apply_signing_orderboolean

When set to true recipients will sign one at a time in the order of the recipients collection of this request.

api_application_idstring uuid

Unique identifier for API Application settings to use. API Applications are optional and mainly used when isolating OAuth apps or for more control over embedded API settings

redirect_urlstring url

A URL that recipients are redirected to after successfully signing a document.

allow_declineboolean

Whether to allow recipients the option to decline signing a document. If multiple signers are involved in a document, any single recipient can cancel the entire document signing process by declining to sign.

allow_reassignboolean

In some cases a signer is not the right person to sign and may need to reassign their signing responsibilities to another person. This feature allows them to reassign the document to someone else.

decline_redirect_urlstring url

A URL that recipients are redirected to if the document is declined.

metadataobject

Optional key-value data that can be associated with the document. If set, will be available every time the document data is returned.

Response

ok

idstring required
api_application_idstring uuid nullable
requester_email_addressstring email
custom_requester_namestring nullable
custom_requester_emailstring email nullable
namestring
subjectstring
messagestring
metadataobject nullable
created_atstring date-time
updated_atstring date-time
statusstring
remindersboolean nullable
archivedboolean
embedded_edit_urlstring url nullable
template_linkstring url
template_idstring nullable
apply_signing_orderboolean
redirect_urlstring url nullable
decline_redirect_urlstring url nullable
languagestring
expires_ininteger nullable
allow_declineboolean nullable
allow_reassignboolean nullable