> ## Documentation Index
> Fetch the complete documentation index at: https://composio-preview.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# Signwell

> SignWell is an electronic signature tool for legally binding e-signatures and faster document signing.

![Signwell logo](https://mintcdn.com/composio-preview/B09iGux45A5cYDuO/images/toolkits/signwell.svg?fit=max\&auto=format\&n=B09iGux45A5cYDuO\&q=85\&s=7a0c4b50a9ea3399a33b039d0cad59e2)

* **Category:** signatures
* **Auth:** API\_KEY
* **Composio-managed OAuth available?** N/A
* **Tools:** 12
* **Triggers:** 0
* **Slug:** `SIGNWELL`
* **Version:** 20261101\_00

## Tools

> [accordion] Create Document
>
> **Slug:** `SIGNWELL_CREATE_DOCUMENT`
>
> Tool to create and optionally send a new document for signing. Use when you have files and recipients defined and want to programmatically submit a signature request in one call.
>
> #### Input Parameters
>
> **draft** `boolean`
>
> If true, saves document as draft (no emails sent). If false, sends signature requests immediately.
>
> **files** `array` *required*
>
> List of files to include in the document. At least one file is required.
>
> **message** `string`
>
> Email message for the signature request. Defaults to system or template message.
>
> **subject** `string`
>
> Email subject for the signature request. Defaults to system or template subject.
>
> **language** `string`
>
> ISO 639-1 code for localization (e.g., en, fr, es). Defaults to en.
>
> **metadata** `object`
>
> Optional key/value data associated with the document.
>
> **reminders** `boolean`
>
> If true, sends reminders on day 3, 6, and 10.
>
> **test\_mode** `boolean`
>
> Set to true to enable Test Mode (not legally binding & not billed). Defaults to false.
>
> **text\_tags** `boolean`
>
> If true, you may place fields via special text tags in your document.
>
> **expires\_in** `integer`
>
> Number of days before the request expires (>=1). Defaults to account or template setting.
>
> **recipients** `array` *required*
>
> People who must complete and/or sign this document.
>
> **redirect\_url** `string`
>
> URL to redirect recipients to after successful signing.
>
> **allow\_decline** `boolean`
>
> If true, recipients may decline to sign (which cancels the request).
>
> **allow\_reassign** `boolean`
>
> If true, signers may reassign their signing responsibility.
>
> **embedded\_signing** `boolean`
>
> If true, enables embedded signing (iframe) and disables email auth.
>
> **api\_application\_id** `string`
>
> UUID of API Application settings to use (optional).
>
> **apply\_signing\_order** `boolean`
>
> If true, enforces signing in the order provided by recipients.
>
> **with\_signature\_page** `boolean`
>
> If true, appends a signature page to the end and requires signing there.
>
> **decline\_redirect\_url** `string`
>
> URL to redirect recipients to if they decline to sign.
>
> **custom\_requester\_name** `string`
>
> Custom name used in all email communications and audit records.
>
> **custom\_requester\_email** `string`
>
> Custom email used in communications instead of the API key owner.
>
> **embedded\_signing\_notifications** `boolean`
>
> If true, sends completion notifications when using embedded signing.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Create Document from Template
>
> **Slug:** `SIGNWELL_CREATE_DOCUMENT_FROM_TEMPLATE`
>
> Tool to create and optionally send a new document for signing from a template. Use when you need to generate a document using a pre-configured template with placeholders. If draft is set to true the document will not be sent.
>
> #### Input Parameters
>
> **name** `string`
>
> Name of the document being created from the template.
>
> **draft** `boolean`
>
> If true, saves document as draft without sending. If false, sends for signing immediately. Defaults to false.
>
> **files** `array`
>
> Additional files to append to the document. Will not replace existing template files.
>
> **fields** `array`
>
> Fields to add to appended files (not existing template files). 2D array - one array of fields per appended file.
>
> **labels** `array`
>
> Labels for organizing documents. Updating labels replaces any existing labels.
>
> **message** `string`
>
> Email message for the signature request. Defaults to template or system message.
>
> **subject** `string`
>
> Email subject for the signature request. Defaults to template or system subject.
>
> **metadata** `object`
>
> Optional key-value metadata associated with the document. Returned in all document queries.
>
> **reminders** `boolean`
>
> If true, sends reminders on day 3, 6, and 10. Defaults to true.
>
> **test\_mode** `boolean`
>
> Set to true to enable Test Mode (not legally binding and not billed). Defaults to false.
>
> **text\_tags** `boolean`
>
> If true, enables special text tags for placing fields in documents. Defaults to false.
>
> **expires\_in** `integer`
>
> Number of days before the signature request expires (minimum 1). Defaults to account or template setting.
>
> **recipients** `array` *required*
>
> Document recipients assigned to template placeholders. Recipients inherit placeholder fields and settings.
>
> **template\_id** `string`
>
> UUID of a single template to use. Either template\_id or template\_ids must be provided, not both.
>
> **redirect\_url** `string`
>
> URL to redirect recipients to after successfully signing the document.
>
> **template\_ids** `array`
>
> List of template UUIDs to use for creating a multi-template document. Either template\_id or template\_ids must be provided, not both.
>
> **allow\_decline** `boolean`
>
> If true, recipients may decline to sign (which cancels the entire document). Defaults to true.
>
> **allow\_reassign** `boolean`
>
> If true, signers may reassign their signing responsibility to another person. Defaults to true.
>
> **copied\_contacts** `array`
>
> Contacts who receive the final document once all recipients complete signing.
>
> **template\_fields** `array`
>
> Template fields to prepopulate with values. Cannot prepopulate Signature or Initials fields.
>
> **embedded\_signing** `boolean`
>
> If true, enables embedded signing (iframe) and disables email authentication. Defaults to false.
>
> **api\_application\_id** `string`
>
> UUID of API Application settings to use for OAuth isolation or embedded API settings.
>
> **apply\_signing\_order** `boolean`
>
> If true, enforces signing in the order provided by recipients array. Defaults to false.
>
> **attachment\_requests** `array`
>
> Attachments that recipients must upload to complete signing. Shown after all document fields are completed.
>
> **with\_signature\_page** `boolean`
>
> If true, appends a signature page to the end and requires all signers to sign there. Defaults to false.
>
> **decline\_redirect\_url** `string`
>
> URL to redirect recipients to if they decline to sign.
>
> **custom\_requester\_name** `string`
>
> Custom name used in all email communications, notifications, and audit file.
>
> **custom\_requester\_email** `string`
>
> Custom email used for all communications and audit file instead of the API key owner's email.
>
> **embedded\_signing\_notifications** `boolean`
>
> If true, sends completion notifications when using embedded signing. Defaults to false.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Create Webhook
>
> **Slug:** `SIGNWELL_CREATE_WEBHOOK`
>
> Tool to register a webhook callback URL. Use when you need to receive document event notifications.
>
> #### Input Parameters
>
> **callbackUrl** `string` *required*
>
> URL where SignWell will post document event payloads.
>
> **apiApplicationId** `string`
>
> UUID of the API Application to associate with this webhook.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Delete Document
>
> **Slug:** `SIGNWELL_DELETE_DOCUMENT`
>
> Tool to delete a document (and cancel signing if in progress). Use when you need to remove a document by ID after confirming it.
>
> #### Input Parameters
>
> **id** `string` *required*
>
> The unique identifier (UUID) of the document to delete. This ID is returned when creating a document via SIGNWELL\_CREATE\_DOCUMENT or can be retrieved using SIGNWELL\_GET\_DOCUMENT.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Delete Webhook
>
> **Slug:** `SIGNWELL_DELETE_WEBHOOK`
>
> Deletes a registered webhook by its ID. Use this to remove webhooks that are no longer needed. Returns no content on success.
>
> #### Input Parameters
>
> **id** `string` *required*
>
> The UUID of the webhook to delete. Obtain this from the list webhooks action.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Credentials
>
> **Slug:** `SIGNWELL_GET_CREDENTIALS`
>
> Retrieve account, user, workspace, and contact information associated with the authenticated API key. The response includes account capability flags and user and account IDs.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Document
>
> **Slug:** `SIGNWELL_GET_DOCUMENT`
>
> Fetch a document by ID and return its document details, including recipient and signing information.
>
> #### Input Parameters
>
> **id** `string` *required*
>
> The unique identifier (UUID) for the document to retrieve. This ID is returned when creating a document via the API.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Bulk Sends
>
> **Slug:** `SIGNWELL_LIST_BULK_SENDS`
>
> Tool to list all Bulk Sends. Use after setting up API credentials to retrieve paginated records.
>
> #### Input Parameters
>
> **page** `integer`
>
> Page number for pagination. Defaults to 1.
>
> **email** `string`
>
> Email address of the user that sent the Bulk Send. Requires admin or manager role to view other users' sends.
>
> **per\_page** `integer`
>
> Number of results per page. Defaults to 10, maximum 50.
>
> **api\_application\_id** `string`
>
> Unique identifier for API Application settings to scope the request.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Webhooks
>
> **Slug:** `SIGNWELL_LIST_WEBHOOKS`
>
> Tool to list all registered webhooks. Use when you need to retrieve the active webhooks for your SignWell account after setup.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Send Reminder
>
> **Slug:** `SIGNWELL_SEND_REMINDER`
>
> Send a reminder for a document to recipients who have not signed yet. Recipients are reminded through their configured delivery method, which may be email, SMS, or both.
>
> #### Input Parameters
>
> **id** `string` *required*
>
> The unique identifier (UUID) of the document for which to send reminders. This ID is returned when creating a document via SIGNWELL\_CREATE\_DOCUMENT or can be retrieved using SIGNWELL\_GET\_DOCUMENT.
>
> **recipients** `array`
>
> Optional list of specific recipients within the document to send a reminder email to. If none are specified, all recipients that have not signed yet will receive a reminder email.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Update and Send Document
>
> **Slug:** `SIGNWELL_UPDATE_AND_SEND_DOCUMENT`
>
> Tool to update a draft document and send it to recipients for signing. Use when you need to modify document settings and initiate the signing process.
>
> #### Input Parameters
>
> **id** `string` *required*
>
> Unique identifier for the document to update and send.
>
> **name** `string`
>
> The name of the document.
>
> **labels** `array`
>
> Labels to organize documents. Updating labels replaces any existing labels for this document.
>
> **message** `string`
>
> Email message for the signature request that recipients will see. Defaults to system or template message.
>
> **subject** `string`
>
> Email subject for the signature request that recipients will see. Defaults to system or template subject.
>
> **metadata** `object`
>
> Optional key-value data associated with the document. Available every time document data is returned.
>
> **reminders** `boolean`
>
> Whether to send signing reminders to recipients. Reminders are sent on day 3, 6, and 10 if enabled.
>
> **test\_mode** `boolean`
>
> Set to true to enable Test Mode. Test Mode documents do not count towards API billing and are not legally binding.
>
> **expires\_in** `integer`
>
> Number of days before the signature request expires. Defaults to the account or template expiration setting.
>
> **redirect\_url** `string`
>
> URL that recipients are redirected to after successfully signing the document.
>
> **allow\_decline** `boolean`
>
> Whether to allow recipients the option to decline signing. If multiple signers are involved, any recipient can cancel the entire process by declining.
>
> **allow\_reassign** `boolean`
>
> Allows signers to reassign their signing responsibilities to another person if they are not the right person to sign.
>
> **embedded\_signing** `boolean`
>
> When set to true, enables embedded signing in your website/web application via iFrame with email authentication disabled.
>
> **api\_application\_id** `string`
>
> Unique identifier for API Application settings to use. Mainly used for isolating OAuth apps or for more control over embedded API settings.
>
> **apply\_signing\_order** `boolean`
>
> When set to true, recipients will sign one at a time in the order specified.
>
> **decline\_redirect\_url** `string`
>
> URL that recipients are redirected to if the document is declined.
>
> **custom\_requester\_name** `string`
>
> Custom requester name used for all email communications, signing notifications, and in the audit file.
>
> **custom\_requester\_email** `string`
>
> Custom requester email used for all email communications, signing notifications, and in the audit file.
>
> **embedded\_signing\_notifications** `boolean`
>
> For embedded signing, setting this to true will send out final completion notification emails to document owners and CC'd contacts.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Update Template
>
> **Slug:** `SIGNWELL_UPDATE_TEMPLATE`
>
> Tool to update an existing template in SignWell. Use when you need to modify template properties such as name, subject, message, reminders, expiration, or other settings.
>
> #### Input Parameters
>
> **id** `string` *required*
>
> Unique identifier for the template to update.
>
> **name** `string`
>
> The name of the template.
>
> **draft** `boolean`
>
> Whether the template can still be updated before it is ready for usage. If set to false the template is marked as Available and ready for use.
>
> **labels** `array`
>
> Labels can be used to organize templates in a way that makes them easy to find using template search in SignWell. A template can have multiple labels. Updating labels on a template will replace any existing labels.
>
> **message** `string`
>
> Email message for the signature request that recipients will see. Defaults to the default system message or template message.
>
> **subject** `string`
>
> Email subject for the signature request that recipients will see. Defaults to the default system subject or template subject.
>
> **metadata** `object`
>
> Optional key-value data that can be associated with the template. If set, will be available every time the template data is returned.
>
> **reminders** `boolean`
>
> Whether to send signing reminders to recipients. Reminders are sent on day 3, day 6, and day 10 if set to true.
>
> **expires\_in** `integer`
>
> Number of days before the signature request expires. Defaults to the account expiration setting or template expiration.
>
> **redirect\_url** `string`
>
> A URL that recipients are redirected to after successfully signing a document.
>
> **allow\_decline** `boolean`
>
> Whether to allow recipients the option to decline signing a document. If multiple signers are involved, any single recipient can cancel the entire document signing process by declining to sign.
>
> **allow\_reassign** `boolean`
>
> 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.
>
> **api\_application\_id** `string`
>
> 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.
>
> **apply\_signing\_order** `boolean`
>
> When set to true recipients will sign one at a time in the order of the recipients collection.
>
> **decline\_redirect\_url** `string`
>
> A URL that recipients are redirected to if the document is declined.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not
