API Reference
  1. RESOURCES AND ENDPOINTS
  2. Document

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. subject and message apply to email notifications only; SMS notifications always use fixed system templates.

Path Params
uuid
required

Unique identifier for a document.

Body Params
boolean
Defaults to false

Set to true to enable Test Mode. Documents sent in Test Mode do not count towards API billing and are not legally binding. Defaults to false.

Test Mode does not carry over from the draft. To send a draft in Test Mode, set test_mode to true or use the X-TestMode-Enabled header. Otherwise, the document is sent live.

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). Applies to email notifications only; SMS notifications always use fixed system templates.

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). Applies to email notifications only; SMS notifications always use fixed system templates.

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

embedded
object

Optional container for embedded settings. Purely additive: requests that omit it behave exactly as before, and the existing top-level api_application_id, embedded_signing and embedded_signing_notifications parameters are unchanged. Not supported on template endpoints, which return a 422 if it is present.

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. Unavailable on 21 CFR Part 11 documents: omit it and reassignment stays off, while sending true returns a 422.

url

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

conditional_rules
array of objects

Conditional logic rules that show, hide, or require fields based on what a signer does to other fields. Every identifier is a field api_id. At most 10 rules per document or template.

conditional_rules
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
boolean

Only applies when test_mode is true. When true and an SMS notification is scheduled for an SMS-only recipient, sends the document owner a preview email with a masked phone number. In embedded signing, the recipient's send_sms must be true to schedule that notification. Test mode delivers no SMS and uses no SMS credits. On newly created documents this setting defaults to false; omitting it in Update and Send preserves the stored setting.

Headers
boolean

Alternative to the test_mode body parameter. Set to true to enable Test Mode or false to disable it. Only lowercase true and false are supported. If both are provided, the header takes precedence.

This is a request header only and is not included in API responses.

Responses

Updated 6 months 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 6 months ago