API Reference

Update and Send Document

post
https://www.signwell.com/api/v1/documents//send

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

Path Params
uuid
required

Unique identifier for a document.

Body Params
boolean
Defaults to false

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

string

The name of the document.

string

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

string

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

integer
≥ 1

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

boolean
Defaults to true

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.

boolean
Defaults to false

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

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

boolean
Defaults to false

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.

boolean
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

string

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.

string

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.

url

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

boolean
Defaults to true

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.

boolean
Defaults to true

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.

url

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

metadata
object

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

labels
array of objects

Labels can be used to organize documents in a way that can make it easy to find using the document search in SignWell. A document can have multiple labels. Updating labels on a document will replace any existing labels for that document.

labels
checkbox_groups
array of objects

Checkbox fields that are placed on a document can be grouped with selection requirements. At least 2 checkbox fields in an array of fields must be assigned to the same recipient.

checkbox_groups
Responses

Updated 28 days ago

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 28 days ago