v1
latestOpenAPI 3.0.12026-07-242682197.7 KBUpdate and Send Document
Updates a draft document and sends it to be signed by recipients.
Path parameters
Unique identifier for a document.
Request body
Set to true to enable Test Mode. Documents created with Test Mode do not count towards API billing and are not legally binding. Defaults to false
The name of the document.
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).
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).
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).
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.
When set to true recipients will sign one at a time in the order of the recipients collection of this request.
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
When set to true it enables embedded signing in your website/web application. Embedded functionality works with an iFrame and email authentication is disabled. :embedded_signinig defaults to false.
On embedding signing, document owners (and CC'd contacts) do not get a notification email when documents have been completed. Setting this param to true will send out those final completed notifications. Default is false
Sets the custom requester name for the document. When set, this is the name used for all email communications, signing notifications, and in the audit file.
Sets the custom requester email for the document. When set, this is the email used for all email communications, signing notifications, and in the audit file.
A URL that recipients are redirected to after successfully signing a document.
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.
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.
A URL that recipients are redirected to if the document is declined.
Optional key-value data that can be associated with the document. If set, will be available every time the document data is returned.
Response
created
Possible values: Draft, Created, Sending, Sent, Pending, Viewed, Completed, Manually completed, Declined, Canceled, Bounced, Blocked, Error, Expired