v1

latestOpenAPI 3.0.12026-07-242682197.7 KB
Document

Update and Send Document

Updates a draft document and sends it to be signed by recipients.

post/api/v1/documents/{id}/send

Path parameters

idstring uuid required

Unique identifier for a document.

Request body

test_modeboolean

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

namestring

The name of the document.

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).

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

embedded_signingboolean

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.

embedded_signing_notificationsboolean

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

custom_requester_namestring

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.

custom_requester_emailstring email

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.

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

created

test_modeboolean required
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

Possible values: Draft, Created, Sending, Sent, Pending, Viewed, Completed, Manually completed, Declined, Canceled, Bounced, Blocked, Error, Expired

remindersboolean
archivedboolean
embedded_signingboolean
embedded_edit_urlstring url nullable
embedded_preview_urlstring url nullable
apply_signing_orderboolean
redirect_urlstring url nullable
decline_redirect_urlstring url nullable
languagestring
expires_ininteger
decline_messagestring nullable
error_messagestring nullable
template_idstring nullable
template_idsstring[]
embedded_signing_notificationsboolean
allow_declineboolean nullable
allow_reassignboolean nullable