BoldSign integration guide
VerifiedHow to connect BoldSign to WEXTL and use its 3 triggers and 88 actions in your workflows. About BoldSign: Electronic signature platform for sending documents to be signed and tracking their status.
- 3 triggers
- 27 searches
- 61 actions
- Instant (webhooks)
- Auth: API key
AI-assisted documentation29 min read
This documentation is compiled from our integration source code, internal specs for BoldSign, its official API documentation and anonymized requests logs we collect from our support team[2].
Requirements
Get your BoldSign credentials
- RegionselectRequired
Choose the region your account is hosted in. It is the address you sign in at (app.boldsign.com, app-eu.boldsign.com, and so on).[1]
- API KeypasswordRequired
In BoldSign, open API in the left menu, choose API Key, then Generate API Key. A key made in the sandbox only works with sandbox documents, and a sandbox key allows only 50 requests an hour.[1]
Connect BoldSign in WEXTL
- Log in to your WEXTL account, add the BoldSign node module to your workflow, and click Create new credential.Instant triggers use webhooks. Click Create a webhook first when adding one, then create the credential.
- Optional: In the Credential name field, enter a name for the credential.
- Enter the authentication credentials you copied from your BoldSign account, or follow the on-screen instructions to create the credential.
- If prompted, authenticate your account and confirm access.
- If you want to make changes to your credential in the future, follow the steps in Manage credentials →
BoldSign triggers and actions on WEXTL
The list below is a reference of every BoldSign node module the integration supports. You will be able to pick any of them on the workflow canvas while building automations.
Browse every BoldSign node module below. Each one opens to show its input parameters, outputs, and connection requirements.
Watch Documents
TriggerStarts the workflow for documents with new activity.
| Field | Type |
|---|---|
| Document ID | text |
| Title | text |
| Status | text |
| Created (Unix seconds) | number |
| Last Activity (Unix seconds) | number |
| Last Activity By | text |
| Expiry (Unix seconds) | number |
| Signing Order Enabled | boolean |
| Deleted | boolean |
| In Editing Mode | boolean |
| Display Status | text |
| Brand ID | text |
| Cursor | number |
5other output fields
Watch Events
TriggerFires right away when BoldSign sends an event.
| Field | Type |
|---|---|
| Event | object |
| Event ID | text |
| Created (Unix seconds) | number |
| Event Type | text |
| Client ID | text |
| Environment | text |
| Context | object |
| Event Type | text |
| Actor | object |
| Previous State | object |
| Data | object |
| Object | text |
| Document ID | text |
| Title | text |
| Description | text |
| Status | text |
| Created (Unix seconds) | number |
| Expiry (Unix seconds) | number |
| Signing Order Enabled | boolean |
| Emails Disabled | boolean |
| Sender | object |
Watch Templates
TriggerStarts the workflow when templates show new activity.
| Field | Type |
|---|---|
| Template ID | text |
| Name | text |
| Document ID | text |
| Template Name | text |
| Template Description | text |
| Title | text |
| Status | text |
| Last Activity By | text |
| Last Activity (Unix seconds) | number |
| Created (Unix seconds) | number |
| Access Type | text |
| Labels | array |
| Label | text |
| Template Labels | array |
| Template Label | text |
4other output fields
Download a Document
SearchSaves a document as one PDF or a ZIP.
| Field | Type |
|---|---|
DocumentRequired | choice |
| Format | choice |
| File Name | text |
| On Behalf Of | choice |
| Field | Type |
|---|---|
| File | text |
| File Name | text |
Download a Document Attachment
SearchFetches a single attachment file from a document.
| Field | Type |
|---|---|
DocumentRequired | choice |
Attachment IDRequired | text |
| File Name | text |
| On Behalf Of | choice |
| Field | Type |
|---|---|
| File | text |
| File Name | text |
Download a Template
SearchSaves a template PDF with or without filled values.
| Field | Type |
|---|---|
TemplateRequired | choice |
| Include Field Values | boolean |
| On Behalf Of | choice |
| Field | Type |
|---|---|
| File | text |
| File Name | text |
Download an Audit Log
SearchGets the audit trail PDF of one document.
| Field | Type |
|---|---|
DocumentRequired | choice |
| File Name | text |
| On Behalf Of | choice |
| Field | Type |
|---|---|
| File | text |
| File Name | text |
Download an ID Verification Image
SearchFetches the selfie or document image of an identity check.
| Field | Type |
|---|---|
DocumentRequired | choice |
File IDRequired | text |
| Signer | choice |
| Signing Order | number |
| Phone Country Code | text |
| Phone Number | text |
| On Behalf Of | choice |
| Field | Type |
|---|---|
| Image | text |
| File Name | text |
Get a Brand
SearchShows brand styling and disclaimer settings.
| Field | Type |
|---|---|
BrandRequired | choice |
| Field | Type |
|---|---|
| Brand ID | text |
| Logo URL | text |
| Brand Name | text |
| Background Color | text |
| Button Color | text |
| Button Text Color | text |
| Email Display Name | text |
| Disclaimer Title | text |
| Disclaimer Text | text |
| Redirect URL | text |
| Is Default | boolean |
| Can Hide Tagline | boolean |
| Combine Audit Trail | boolean |
14other output fields
Get a Contact
SearchShows the details of one contact.
| Field | Type |
|---|---|
ContactRequired | choice |
| Field | Type |
|---|---|
| Contact ID | text |
| Name | text |
| text | |
| Company | text |
| Job Title | text |
| Phone Number | object |
| Country Code | text |
| Number | text |
Get a Contact Group
SearchShows the members and creator of one contact group.
| Field | Type |
|---|---|
Contact GroupRequired | choice |
| Field | Type |
|---|---|
| Group ID | text |
| Group Name | text |
| Contacts | array |
| Contact | object |
| Creator | object |
| User ID | text |
| Created By | text |
| Directories | array |
Get a Document
SearchShows document properties and signer details.
| Field | Type |
|---|---|
DocumentRequired | choice |
| Field | Type |
|---|---|
| Document ID | text |
| Brand ID | text |
| Message Title | text |
| Document Description | text |
| Status | text |
| Files | array |
| ID | text |
| Document Name | text |
| Order | number |
| Page Count | number |
| Template Name | text |
| Template ID | text |
| Sender Detail | object |
| Name | text |
| Private Message | text |
| Email Address | text |
| Is Viewed | boolean |
| Signer Details | array |
| ID | text |
| Signer Name | text |
| Signer Role | text |
| Signer Email | text |
| Status | text |
| Enable Access Code | boolean |
| Is Authentication Failed | boolean |
| Enable Email OTP | boolean |
| Authentication Type | text |
| Is Delivery Failed | boolean |
| Form Groups | array |
| Minimum Count | number |
| Maximum Count | number |
| Data Sync Tag | text |
| Group Names | array |
| Group Validation | text |
| Common Fields | array |
| ID | text |
| Form Field ID | text |
| Type | text |
| Value | text |
| Font | text |
| Is Required | boolean |
| Is Read Only | boolean |
| Line Height | number |
| Font Size | number |
| Font Color | text |
| Behalf Of | object |
| Name | text |
| Email Address | text |
| CC Details | array |
| Email Address | text |
| Is Viewed | boolean |
| Reminder Settings | object |
| Enable Auto Reminder | boolean |
| Reminder Days | number |
| Reminder Count | number |
36other output fields
Get a Sender Identity
SearchShows the approval status and settings of a sender identity.
| Field | Type |
|---|---|
| Sender Identity | choice |
| Sender Identity ID | text |
| Field | Type |
|---|---|
| Sender Identity ID | text |
| Name | text |
| text | |
| Status | text |
| Created By | text |
| Approved Date | text |
| Notifications | object |
| Document Viewed | boolean |
| Document Sent | boolean |
| Email Delivery Failed | boolean |
| Document Declined | boolean |
| Document Revoked | boolean |
| Document Reassigned | boolean |
| Document Completed | boolean |
| Document Signed | boolean |
| Document Expired | boolean |
| Signer Authentication Failed | boolean |
| Brand ID | text |
| Redirect URL | text |
| Metadata | text |
| Language | text |
Get a Team
SearchShows the members and dates of a single team.
| Field | Type |
|---|---|
TeamRequired | choice |
| Field | Type |
|---|---|
| Team ID | text |
| Team Name | text |
| Users | array |
| User ID | text |
| text | |
| First Name | text |
| Last Name | text |
| Role | text |
| Status | text |
| Created Date (Unix seconds) | number |
| Modified Date (Unix seconds) | number |
Get a Template
SearchShows what a template contains, from files to defaults.
| Field | Type |
|---|---|
TemplateRequired | choice |
| Field | Type |
|---|---|
| Template ID | text |
| Title | text |
| Description | text |
| Document Title | text |
| Document Message | text |
| Files | array |
| Document ID | text |
| File Name | text |
| Order | number |
| Page Count | number |
| Roles | array |
| Name | text |
| Index | number |
| Default Signer Name | text |
| Default Signer Email | text |
| Signer Order | number |
| Signer Type | text |
| Authentication | text |
| Delivery Mode | text |
| CC Emails | array |
| Brand ID | text |
| Allow Message Editing | boolean |
| Allow New Roles | boolean |
| Allow New Files | boolean |
| Allow Modify Files | boolean |
7other output fields
Get a User
SearchShows a user profile with team and status.
| Field | Type |
|---|---|
UserRequired | choice |
| Field | Type |
|---|---|
| User ID | text |
| text | |
| First Name | text |
| Last Name | text |
| Team ID | text |
| Team Name | text |
| Role | text |
| Status | text |
| Created Date (Unix seconds) | number |
| Modified Date (Unix seconds) | number |
| Metadata | text |
Get an Embedded Signing Link
SearchGives one signer an embedded signing URL.
| Field | Type |
|---|---|
DocumentRequired | choice |
| Signer | choice |
| Redirect URL | text |
| Link Valid Until | date |
| Phone Country Code | text |
| Phone Number | text |
| Field | Type |
|---|---|
| Sign Link | text |
Get an ID Verification Report
SearchShows the identity check outcome for a signer.
| Field | Type |
|---|---|
DocumentRequired | choice |
| Signer | choice |
| Signing Order | number |
| Phone Country Code | text |
| Phone Number | text |
| On Behalf Of | choice |
| Field | Type |
|---|---|
| Verification Result | text |
| Verified Date | text |
| Error | object |
| Code | text |
| Message | text |
| Document | object |
| Type | text |
| First Name | text |
| Last Name | text |
| Country | text |
| Document Number | text |
| Address | object |
| Date of Birth | object |
| Issued Date | object |
| Expiration Date | object |
| Document File IDs | array |
Get API Credits
SearchShows the API credits left on the account.
| Field | Type |
|---|---|
| Balance Credits | number |
List Brands
SearchShows brands with their colors and disclaimers.
| Field | Type |
|---|---|
LimitRequired | number |
| Field | Type |
|---|---|
| Brand ID | text |
| Logo URL | text |
| Brand Name | text |
| Background Color | text |
| Button Color | text |
| Button Text Color | text |
| Email Display Name | text |
| Disclaimer Title | text |
| Disclaimer Text | text |
| Redirect URL | text |
| Is Default | boolean |
| Can Hide Tagline | boolean |
| Combine Audit Trail | boolean |
14other output fields
List Contact Groups
SearchFinds contact groups by search text and type.
| Field | Type |
|---|---|
LimitRequired | number |
| Search | text |
| Group Type | choice |
| Directories | array |
| Field | Type |
|---|---|
| Group ID | text |
| Group Name | text |
| Contacts | array |
| Contact | object |
| Creator | object |
| User ID | text |
| Created By | text |
| Directories | array |
List Contacts
SearchFinds contacts by search text.
| Field | Type |
|---|---|
LimitRequired | number |
| Search | text |
| Contact Type | choice |
| Field | Type |
|---|---|
| Name | text |
| text | |
| Company | text |
| Job Title | text |
| Phone Number | object |
| Country Code | text |
| Number | text |
| Contact ID | text |
List Custom Fields
SearchShows the custom form fields a brand owns.
| Field | Type |
|---|---|
BrandRequired | choice |
LimitRequired | number |
| Field | Type |
|---|---|
| Custom Field ID | text |
| Field Name | text |
| Description | text |
| Brand ID | text |
| Form Field | object |
| Field Type | text |
| Width | number |
| Height | number |
| Required | boolean |
| Read Only | boolean |
| Default Value | text |
| Font Size | number |
| Font | text |
| Options | array |
| Character Limit | number |
List Documents
SearchFinds documents by state, direction, label or text.
| Field | Type |
|---|---|
LimitRequired | number |
| Status | choice |
| Direction | choice |
| Sent By | array |
| Recipients | array |
| Labels | array |
| Brands | choice |
| Search | text |
| Date Filter | choice |
| Start Date | date |
| End Date | date |
| Field | Type |
|---|---|
| Document ID | text |
| Sender Detail | object |
| Name | text |
| Private Message | text |
| Email Address | text |
| Is Viewed | boolean |
| CC Details | array |
| Email Address | text |
| Is Viewed | boolean |
| Created Date (Unix seconds) | number |
| Activity Date (Unix seconds) | number |
| Activity By | text |
| Message Title | text |
| Status | text |
| Signer Details | array |
| ID | text |
| Signer Name | text |
| Signer Role | text |
| Signer Email | text |
| Status | text |
| Enable Access Code | boolean |
| Is Authentication Failed | boolean |
| Enable Email OTP | boolean |
| Authentication Type | text |
| Is Delivery Failed | boolean |
| Expiry Date (Unix seconds) | number |
| Enable Signing Order | boolean |
| Is Deleted | boolean |
| Labels | array |
5other output fields
List Documents on Behalf
SearchFinds documents sent for others or for you.
| Field | Type |
|---|---|
LimitRequired | number |
| Kind | choice |
| Sender Identities | choice |
| Signer Emails | array |
| Status | choice |
| Labels | array |
| Brands | choice |
| Search | text |
| Start Date | date |
| End Date | date |
| Field | Type |
|---|---|
| Behalf Of | object |
| Name | text |
| Email Address | text |
| Document ID | text |
| Sender Detail | object |
| Name | text |
| Private Message | text |
| Email Address | text |
| Is Viewed | boolean |
| CC Details | array |
| Email Address | text |
| Is Viewed | boolean |
| Created Date (Unix seconds) | number |
| Activity Date (Unix seconds) | number |
| Activity By | text |
| Message Title | text |
| Status | text |
| Signer Details | array |
| ID | text |
| Signer Name | text |
| Signer Role | text |
| Signer Email | text |
| Status | text |
| Enable Access Code | boolean |
| Is Authentication Failed | boolean |
| Enable Email OTP | boolean |
| Authentication Type | text |
| Is Delivery Failed | boolean |
| Expiry Date (Unix seconds) | number |
| Enable Signing Order | boolean |
| Is Deleted | boolean |
6other output fields
List Sender Identities
SearchShows sender identities filtered by text or brand.
| Field | Type |
|---|---|
LimitRequired | number |
| Search | text |
| Brands | choice |
| Field | Type |
|---|---|
| Sender Identity ID | text |
| Name | text |
| text | |
| Status | text |
| Created By | text |
| Approved Date | text |
| Notifications | object |
| Document Viewed | boolean |
| Document Sent | boolean |
| Email Delivery Failed | boolean |
| Document Declined | boolean |
| Document Revoked | boolean |
| Document Reassigned | boolean |
| Document Completed | boolean |
| Document Signed | boolean |
| Document Expired | boolean |
| Signer Authentication Failed | boolean |
| Brand ID | text |
| Redirect URL | text |
| Metadata | text |
| Language | text |
List Team Documents
SearchShows documents across teams, filterable by team or user.
| Field | Type |
|---|---|
LimitRequired | number |
| Teams | choice |
| Users | choice |
| Status | choice |
| Direction | choice |
| Labels | array |
| Brands | choice |
| Search | text |
| Date Filter | choice |
| Start Date | date |
| End Date | date |
| Field | Type |
|---|---|
| Document ID | text |
| Sender Detail | object |
| Name | text |
| Private Message | text |
| Email Address | text |
| Is Viewed | boolean |
| CC Details | array |
| Email Address | text |
| Is Viewed | boolean |
| Created Date (Unix seconds) | number |
| Activity Date (Unix seconds) | number |
| Activity By | text |
| Message Title | text |
| Status | text |
| Signer Details | array |
| ID | text |
| Signer Name | text |
| Signer Role | text |
| Signer Email | text |
| Status | text |
| Enable Access Code | boolean |
| Is Authentication Failed | boolean |
| Enable Email OTP | boolean |
| Authentication Type | text |
| Is Delivery Failed | boolean |
| Expiry Date (Unix seconds) | number |
| Enable Signing Order | boolean |
| Is Deleted | boolean |
| Labels | array |
5other output fields
List Teams
SearchGives every team name together with its ID.
| Field | Type |
|---|---|
LimitRequired | number |
| Search | text |
| Field | Type |
|---|---|
| Team ID | text |
| Team Name | text |
List Templates
SearchFinds templates by type, label or text.
| Field | Type |
|---|---|
LimitRequired | number |
| Template Type | choice |
| Search | text |
| Labels | array |
| Label | text |
| Created By | array |
| text | |
| Brands | choice |
| Shared With Teams | choice |
| Start Date | date |
| End Date | date |
| On Behalf Of | choice |
| Field | Type |
|---|---|
| Document ID | text |
| Template ID | text |
| Template Name | text |
| Template Description | text |
| Message Title | text |
| Status | text |
| Last Activity By | text |
| Activity Date (Unix seconds) | number |
| Created Date (Unix seconds) | number |
| Access Type | text |
| Brand ID | text |
| Sender | object |
| Name | text |
| Email Address | text |
| User ID | text |
| Roles | array |
| Signer Name | text |
| Signer Email | text |
| Signer Role | text |
| Status | text |
2other output fields
List Users
SearchShows account users, filterable by text.
| Field | Type |
|---|---|
LimitRequired | number |
| Search | text |
| Users | choice |
| Field | Type |
|---|---|
| User ID | text |
| text | |
| First Name | text |
| Last Name | text |
| Team ID | text |
| Team Name | text |
| Role | text |
| Status | text |
| Metadata | text |
Add a Signer Authentication
ActionAdds an identity check for one signer of a document.
| Field | Type |
|---|---|
DocumentRequired | choice |
SignerRequired | choice |
TypeRequired | choice |
| Signer Order | number |
| On Behalf Of | choice |
| Field | Type |
|---|---|
| Success | boolean |
Add Tags to a Document
ActionLabels one BoldSign document with extra tags.
| Field | Type |
|---|---|
DocumentRequired | choice |
TagsRequired | array |
| Tag | text |
| Field | Type |
|---|---|
| Success | boolean |
Add Tags to a Template
ActionLabels a template, its documents or both.
| Field | Type |
|---|---|
TemplateRequired | choice |
| Document Labels | array |
| Label | text |
| Template Labels | array |
| Label | text |
| On Behalf Of | choice |
| Field | Type |
|---|---|
| Success | boolean |
Cancel a Document Edit
ActionEnds an open editing session on a document.
| Field | Type |
|---|---|
DocumentRequired | choice |
| On Behalf Of | choice |
| Field | Type |
|---|---|
| Success | boolean |
Cancel a Signature Request
ActionCancels a sent signature request with a reason signers can read.
| Field | Type |
|---|---|
DocumentRequired | choice |
ReasonRequired | text |
| On Behalf Of | choice |
| Field | Type |
|---|---|
| Success | boolean |
Cancel a User Invitation
ActionWithdraws a user invite that is still open.
| Field | Type |
|---|---|
UserRequired | choice |
| Field | Type |
|---|---|
| Success | boolean |
Change a Signer
ActionSwaps one signer of a document for someone else.
| Field | Type |
|---|---|
DocumentRequired | choice |
ReasonRequired | text |
New Signer NameRequired | text |
| New Signer Email | text |
| Signer | choice |
| Signer Order | number |
| New Signer Phone Country Code | text |
| New Signer Phone Number | text |
| Old Signer Phone Country Code | text |
| Old Signer Phone Number | text |
| On Behalf Of | choice |
| Field | Type |
|---|---|
| Success | boolean |
Change a Signer Access Code
ActionGives a signer a new code to open the document.
| Field | Type |
|---|---|
DocumentRequired | choice |
SignerRequired | choice |
Access CodeRequired | secret |
| Signer Order | number |
| Phone Country Code | text |
| Phone Number | text |
| On Behalf Of | choice |
| Field | Type |
|---|---|
| Success | boolean |
Change the Team of a User
ActionTransfers a user to another team, optionally handing over documents.
| Field | Type |
|---|---|
UserRequired | choice |
New TeamRequired | choice |
| Transfer Documents To | choice |
| Field | Type |
|---|---|
| Success | boolean |
Create a Brand
ActionAdds a brand with logo, colors and sender display name.
| Field | Type |
|---|---|
Brand NameRequired | text |
LogoRequired | text |
| Background Color | text |
| Button Color | text |
| Button Text Color | text |
| Email Display Name | text |
| Disclaimer Title | text |
| Disclaimer Text | text |
| Redirect URL | text |
| Send Signed Document As | choice |
| Document Time Zone | text |
| Default Expiry Unit | choice |
| Default Expiry Value | number |
21other input fields
| Field | Type |
|---|---|
| Brand ID | text |
Create a Contact
ActionAdds a contact with company and phone details.
| Field | Type |
|---|---|
NameRequired | text |
EmailRequired | text |
| Job Title | text |
| Company | text |
| Phone Country Code | text |
| Phone Number | text |
| Field | Type |
|---|---|
| Contact ID | text |
| text |
Create a Contact Group
ActionGroups several contacts under one name.
| Field | Type |
|---|---|
Group NameRequired | text |
ContactsRequired | array |
| Contact | object |
| Directories | array |
| Field | Type |
|---|---|
| Group ID | text |
| Group Name | text |
Create a Custom Field
ActionAdds a brand form field with type, size and sharing options.
| Field | Type |
|---|---|
Field NameRequired | text |
BrandRequired | choice |
Field TypeRequired | choice |
| Description | text |
| Order | number |
| Shared Field | boolean |
| Width | number |
| Height | number |
| Required | boolean |
| Read Only | boolean |
| Default Value | text |
| Font Size | number |
| Font | choice |
| Field | Type |
|---|---|
| Custom Field ID | text |
| Message | text |
Create a Sender Identity
ActionAdds a sender identity that waits for email confirmation.
| Field | Type |
|---|---|
EmailRequired | text |
| Name | text |
| Brand | choice |
| Redirect URL | text |
| Language | choice |
| Notifications | object |
| Document Viewed | boolean |
| Document Sent | boolean |
| Email Delivery Failed | boolean |
| Document Declined | boolean |
| Document Revoked | boolean |
| Document Reassigned | boolean |
| Document Completed | boolean |
| Document Signed | boolean |
| Document Expired | boolean |
| Signer Authentication Failed | boolean |
| Metadata | array |
KeyRequired | text |
| Value | text |
| Field | Type |
|---|---|
| Sender Identity ID | text |
Create a Team
ActionAdds one team to the BoldSign account.
| Field | Type |
|---|---|
Team NameRequired | text |
| Field | Type |
|---|---|
| Team ID | text |
Create a Template
ActionAdds a template with signer roles and files.
| Field | Type |
|---|---|
Template NameRequired | text |
RolesRequired | array |
Role NumberRequired | number |
Role NameRequired | text |
| Default Signer Name | text |
| Default Signer Email | text |
| Role Type | choice |
| Signing Order | number |
| Authentication | choice |
| File | text |
| More Files | array |
FileRequired | text |
| File URLs | array |
| Link | text |
| Description | text |
| Document Title | text |
| Document Message | text |
| CC | array |
EmailRequired | text |
| Brand | choice |
| Document Labels | array |
| Label | text |
| Template Labels | array |
| Label | text |
| Use Text Tags | boolean |
9other input fields
| Field | Type |
|---|---|
| Template ID | text |
Create a User
ActionSends an account invitation with team and role.
| Field | Type |
|---|---|
EmailRequired | text |
| Team | choice |
| Role | choice |
| Metadata | array |
KeyRequired | text |
| Value | text |
| Field | Type |
|---|---|
| Success | boolean |
Create an Embedded Clone Link
ActionGives an embeddable page that copies a document.
| Field | Type |
|---|---|
DocumentRequired | choice |
| Redirect URL | text |
| Start Page | choice |
| Include Field Values | boolean |
| Page Language | choice |
| Link Valid Until | date |
| Show Toolbar | boolean |
| Show Save Button | boolean |
| Show Send Button | boolean |
| Show Preview Button | boolean |
| Show Navigation Buttons | boolean |
| Show Tooltips | boolean |
| On Behalf Of | choice |
| Field | Type |
|---|---|
| Document ID | text |
| Embed URL | text |
Create an Embedded Custom Field Link
ActionOpens the custom field designer for one brand.
| Field | Type |
|---|---|
BrandRequired | choice |
| Link Valid Until | date |
| Field | Type |
|---|---|
| Designer URL | text |
Create an Embedded Edit Link
ActionGives embedded editor access to unfinished documents.
| Field | Type |
|---|---|
DocumentRequired | choice |
| Redirect URL | text |
| Start Page | choice |
| Page Language | choice |
| Link Valid Until | date |
| Show Toolbar | boolean |
| Show Send Button | boolean |
| Show Preview Button | boolean |
| Show Navigation Buttons | boolean |
| On Behalf Of | choice |
| Field | Type |
|---|---|
| Edit URL | text |
Create an Embedded ID Verification Link
ActionGives one signer an embedded identity check link.
| Field | Type |
|---|---|
DocumentRequired | choice |
| Signer | choice |
| Redirect URL | text |
| Signing Order | number |
| Phone Country Code | text |
| Phone Number | text |
| On Behalf Of | choice |
| Field | Type |
|---|---|
| Verification Link | text |
Create an Embedded Merged Send Link
ActionGives a combined template send view for embedding.
| Field | Type |
|---|---|
TemplatesRequired | choice |
| Roles | array |
Role NumberRequired | number |
Signer NameRequired | text |
Signer EmailRequired | text |
| Private Message | text |
| Document Title | text |
| Message | text |
| CC | array |
EmailRequired | text |
| Enable Signing Order | boolean |
| Expires After (Days) | number |
| Brand | choice |
| Labels | array |
| Label | text |
| Send Reminders | boolean |
| Days Between Reminders | number |
| Number of Reminders | number |
| Do Not Send Emails | boolean |
19other input fields
| Field | Type |
|---|---|
| Document ID | text |
| Send URL | text |
Create an Embedded Send Link
ActionPrepares and sends a new document on an embedded page.
| Field | Type |
|---|---|
TitleRequired | text |
SignersRequired | array |
NameRequired | text |
EmailRequired | text |
| Role | choice |
| Signing Order | number |
| Authentication | choice |
| Delivery | choice |
| Private Message | text |
| Language | choice |
| File | text |
| Form Fields | array |
Signer NumberRequired | number |
Field TypeRequired | choice |
PageRequired | number |
XRequired | number |
YRequired | number |
WidthRequired | number |
HeightRequired | number |
| Required | boolean |
| Value | text |
| Message | text |
| CC | array |
EmailRequired | text |
| Enable Signing Order | boolean |
| Expiry Days | number |
| Send Automatic Reminders | boolean |
| Days Between Reminders | number |
| Number of Reminders | number |
| Brand | choice |
| Labels | array |
26other input fields
| Field | Type |
|---|---|
| Document ID | text |
| Send URL | text |
Create an Embedded Template Clone Link
ActionGives an embedded page that duplicates a template.
| Field | Type |
|---|---|
TemplateRequired | choice |
| Redirect URL | text |
| Start Page | choice |
| Show Toolbar | boolean |
| Show Save Button | boolean |
| Show Create Button | boolean |
| Show Preview Button | boolean |
| Show Navigation Buttons | boolean |
| Show Tooltips | boolean |
| Include Field Values | boolean |
| Language | choice |
| Link Valid Until | date |
| On Behalf Of | choice |
| Field | Type |
|---|---|
| New Template ID | text |
| Embed URL | text |
Create an Embedded Template Edit Link
ActionGives a template editing page for embedding in an app.
| Field | Type |
|---|---|
TemplateRequired | choice |
| Redirect URL | text |
| Start Page | choice |
| Show Toolbar | boolean |
| Show Save Button | boolean |
| Show Create Button | boolean |
| Show Preview Button | boolean |
| Show Navigation Buttons | boolean |
| Show Tooltips | boolean |
| Language | choice |
| Link Valid Until | date |
| On Behalf Of | choice |
| Field | Type |
|---|---|
| Edit URL | text |
Create an Embedded Template Link
ActionGives an embedded page for creating a template from scratch.
| Field | Type |
|---|---|
Template NameRequired | text |
| Roles | array |
Role NumberRequired | number |
Role NameRequired | text |
| Default Signer Name | text |
| Default Signer Email | text |
| Role Type | choice |
| Signing Order | number |
| Authentication | choice |
| File | text |
| More Files | array |
FileRequired | text |
| File URLs | array |
| Link | text |
| Description | text |
| Document Title | text |
| Document Message | text |
| CC | array |
EmailRequired | text |
| Brand | choice |
| Document Labels | array |
| Label | text |
| Template Labels | array |
| Label | text |
| Use Text Tags | boolean |
20other input fields
| Field | Type |
|---|---|
| Template ID | text |
| Create URL | text |
Create an Embedded Template Preview Link
ActionGives an embedded template preview with an optional expiry.
| Field | Type |
|---|---|
TemplateRequired | choice |
| Show Toolbar | boolean |
| Link Valid Until | date |
| Field | Type |
|---|---|
| Template URL | text |
Create an Embedded Template Send Link
ActionGives an embedded send page prefilled from a template.
| Field | Type |
|---|---|
TemplateRequired | choice |
| Document Title | text |
| Message | text |
| CC | array |
EmailRequired | text |
| Enable Signing Order | boolean |
| Expires After (Days) | number |
| Brand | choice |
| Labels | array |
| Label | text |
| Send Reminders | boolean |
| Days Between Reminders | number |
| Number of Reminders | number |
| Do Not Send Emails | boolean |
| Do Not Send Text Messages | boolean |
20other input fields
| Field | Type |
|---|---|
| Document ID | text |
| Send URL | text |
Delete a Brand
ActionRemoves one brand, which cannot be reversed.
| Field | Type |
|---|---|
BrandRequired | choice |
| Field | Type |
|---|---|
| Message | text |
Delete a Contact
ActionRemoves one saved contact.
| Field | Type |
|---|---|
ContactRequired | choice |
| Field | Type |
|---|---|
| Success | boolean |
Delete a Contact Group
ActionDeletes a group of saved contacts irreversibly.
| Field | Type |
|---|---|
Contact GroupRequired | choice |
| Field | Type |
|---|---|
| Success | boolean |
Delete a Custom Field
ActionRemoves a reusable custom field.
| Field | Type |
|---|---|
Custom Field IDRequired | text |
| Field | Type |
|---|---|
| Message | text |
Delete a Document
ActionDeletes a document to the trash or beyond recovery.
| Field | Type |
|---|---|
DocumentRequired | choice |
| Delete Permanently | boolean |
| Field | Type |
|---|---|
| Success | boolean |
Delete a Sender Identity
ActionDeletes a sender identity used to send documents.
| Field | Type |
|---|---|
Sender IdentityRequired | choice |
| Field | Type |
|---|---|
| Success | boolean |
Delete a Template
ActionRemoves a template, with an on-behalf option.
| Field | Type |
|---|---|
TemplateRequired | choice |
| On Behalf Of | choice |
| Field | Type |
|---|---|
| Success | boolean |
Edit a Brand
ActionChanges brand name, logo and colors.
| Field | Type |
|---|---|
BrandRequired | choice |
| Brand Name | text |
| Logo | text |
| Background Color | text |
| Button Color | text |
| Button Text Color | text |
| Email Display Name | text |
| Disclaimer Title | text |
| Disclaimer Text | text |
| Redirect URL | text |
| Send Signed Document As | choice |
| Document Time Zone | text |
| Default Expiry Unit | choice |
23other input fields
| Field | Type |
|---|---|
| Brand ID | text |
Edit a Custom Field
ActionEdits custom field name, size and sharing.
| Field | Type |
|---|---|
BrandRequired | choice |
Custom FieldRequired | choice |
| Field Name | text |
| Description | text |
| Order | number |
| Shared Field | choice |
| Width | number |
| Height | number |
| Required | choice |
| Read Only | choice |
| Default Value | text |
| Placeholder | text |
| Character Limit | number |
1other input field
| Field | Type |
|---|---|
| Custom Field ID | text |
| Message | text |
Edit a Document
ActionEdits the title, message, signers and expiry of a document.
| Field | Type |
|---|---|
DocumentRequired | choice |
| Title | text |
| Message | text |
| Signer Changes | array |
| Signer | object |
| Add File | text |
| Remove File ID | text |
| CC | array |
| CC | object |
| Labels | array |
| Label | text |
| Brand | choice |
| Enable Signing Order | choice |
| Expiry | choice |
| Clear Fields | choice |
| On Behalf Of | choice |
| Field | Type |
|---|---|
| Status | text |
Edit a Template
ActionEdits template name, defaults and roles.
| Field | Type |
|---|---|
TemplateRequired | choice |
| Template Name | text |
| Description | text |
| Document Title | text |
| Document Message | text |
| Roles (replaces all roles) | array |
Role NumberRequired | number |
Role NameRequired | text |
| Default Signer Name | text |
| Default Signer Email | text |
| Role Type | choice |
| Signing Order | number |
| Authentication | choice |
| CC | array |
EmailRequired | text |
| Brand | choice |
| Document Labels | array |
| Label | text |
| Template Labels | array |
| Label | text |
| Allow Message Editing | choice |
| Allow New Roles | choice |
| Allow New Files | choice |
6other input fields
| Field | Type |
|---|---|
| Success | boolean |
Make an API Call
universalCustom BoldSign REST API request.
| Field | Type |
|---|---|
URLRequired | text |
MethodRequired | choice |
| Headers | array |
| Header | object |
| Query String | array |
| Parameter | object |
| Body | text |
| Field | Type |
|---|---|
| Body | text |
| Headers | object |
| Key | text |
| Value | text |
| Status Code | number |
Remove a Signer Authentication
ActionRemoves the verification requirement from a signer.
| Field | Type |
|---|---|
DocumentRequired | choice |
SignerRequired | choice |
| Signer Order | number |
| Phone Country Code | text |
| Phone Number | text |
| On Behalf Of | choice |
| Field | Type |
|---|---|
| Success | boolean |
Remove Tags from a Document
ActionStrips chosen tags off a BoldSign document.
| Field | Type |
|---|---|
DocumentRequired | choice |
TagsRequired | array |
| Tag | text |
| Field | Type |
|---|---|
| Success | boolean |
Remove Tags from a Template
ActionRemoves template labels, document labels or both.
| Field | Type |
|---|---|
TemplateRequired | choice |
| Document Labels | array |
| Label | text |
| Template Labels | array |
| Label | text |
| On Behalf Of | choice |
| Field | Type |
|---|---|
| Success | boolean |
Send a Document
ActionSends a document for signing, review or approval.
| Field | Type |
|---|---|
TitleRequired | text |
SignersRequired | array |
NameRequired | text |
EmailRequired | text |
| Role | choice |
| Signing Order | number |
| Authentication | choice |
| Delivery | choice |
| Private Message | text |
| Language | choice |
| File | text |
| Form Fields | array |
Signer NumberRequired | number |
Field TypeRequired | choice |
PageRequired | number |
XRequired | number |
YRequired | number |
WidthRequired | number |
HeightRequired | number |
| Required | boolean |
| Value | text |
| Message | text |
| CC | array |
EmailRequired | text |
| Enable Signing Order | boolean |
| Expiry Days | number |
| Send Automatic Reminders | boolean |
| Days Between Reminders | number |
| Number of Reminders | number |
| Brand | choice |
| Labels | array |
16other input fields
| Field | Type |
|---|---|
| Document ID | text |
Send a Document from a Template
ActionSends a document built from a template to its role holders.
| Field | Type |
|---|---|
TemplateRequired | choice |
| Document Title | text |
| Message | text |
| CC | array |
EmailRequired | text |
| Enable Signing Order | boolean |
| Expires After (Days) | number |
| Brand | choice |
| Labels | array |
| Label | text |
| Send Reminders | boolean |
| Days Between Reminders | number |
| Number of Reminders | number |
| Do Not Send Emails | boolean |
| Do Not Send Text Messages | boolean |
10other input fields
| Field | Type |
|---|---|
| Document ID | text |
Send a Document from Merged Templates
ActionSends a single merged document to the people in the roles.
| Field | Type |
|---|---|
TemplatesRequired | choice |
RolesRequired | array |
Role NumberRequired | number |
Signer NameRequired | text |
Signer EmailRequired | text |
| Private Message | text |
| Document Title | text |
| Message | text |
| CC | array |
EmailRequired | text |
| Enable Signing Order | boolean |
| Expires After (Days) | number |
| Brand | choice |
| Labels | array |
| Label | text |
| Send Reminders | boolean |
| Days Between Reminders | number |
| Number of Reminders | number |
| Do Not Send Emails | boolean |
9other input fields
| Field | Type |
|---|---|
| Document ID | text |
Send a Draft Document
ActionMoves a draft into the signing stage.
| Field | Type |
|---|---|
DocumentRequired | choice |
| Field | Type |
|---|---|
| Success | boolean |
Send a Reminder
ActionSends a reminder to signers who still have to sign.
| Field | Type |
|---|---|
DocumentRequired | choice |
| Signers | choice |
| Message | text |
| Phone Numbers | array |
| Phone Number | object |
| On Behalf Of | choice |
| Field | Type |
|---|---|
| Success | boolean |
Send a Sender Identity Invitation Again
ActionResends the invitation for an unconfirmed identity.
| Field | Type |
|---|---|
Sender IdentityRequired | choice |
| Field | Type |
|---|---|
| Success | boolean |
Send a Sender Identity Request Again
ActionAsks BoldSign a second time to approve a denied identity.
| Field | Type |
|---|---|
Sender IdentityRequired | choice |
| Field | Type |
|---|---|
| Success | boolean |
Send a User Invitation Again
ActionRe-invites a user whose invitation is still pending.
| Field | Type |
|---|---|
UserRequired | choice |
| Field | Type |
|---|---|
| Success | boolean |
Set Document Field Values
ActionPrefills form field values on one document.
| Field | Type |
|---|---|
DocumentRequired | choice |
FieldsRequired | array |
| Field | object |
| On Behalf Of | choice |
| Field | Type |
|---|---|
| Success | boolean |
Set the Default Brand
ActionSwitches the account default to another brand.
| Field | Type |
|---|---|
BrandRequired | choice |
| Field | Type |
|---|---|
| Message | text |
Update a Contact
ActionEdits a contact and can clear fields.
| Field | Type |
|---|---|
ContactRequired | choice |
| Name | text |
| text | |
| Job Title | text |
| Company | text |
| Phone Country Code | text |
| Phone Number | text |
| Clear Fields | choice |
| Field | Type |
|---|---|
| Success | boolean |
Update a Contact Group
ActionEdits the name, members and directories of a contact group.
| Field | Type |
|---|---|
Contact GroupRequired | choice |
| Group Name | text |
| Contacts (replaces all contacts) | array |
| Contact | object |
| Directories | array |
| Clear Fields | choice |
| Field | Type |
|---|---|
| Success | boolean |
Update a Sender Identity
ActionEdits sender identity name, language and redirect link.
| Field | Type |
|---|---|
Sender IdentityRequired | choice |
| Name | text |
| Redirect URL | text |
| Language | choice |
| Metadata | array |
KeyRequired | text |
| Value | text |
| Document Viewed | choice |
| Document Sent | choice |
| Email Delivery Failed | choice |
| Document Declined | choice |
| Document Revoked | choice |
| Document Reassigned | choice |
| Document Completed | choice |
| Document Signed | choice |
5other input fields
| Field | Type |
|---|---|
| Success | boolean |
Update a Team
ActionChanges the display name of one team.
| Field | Type |
|---|---|
TeamRequired | choice |
Team NameRequired | text |
| Field | Type |
|---|---|
| Success | boolean |
Update a User
ActionEdits a user role and active status.
| Field | Type |
|---|---|
UserRequired | choice |
| Role | choice |
| Status | choice |
| Transfer Documents To | choice |
| Field | Type |
|---|---|
| Success | boolean |
Update the Document Expiry
ActionGives a document a later expiry.
| Field | Type |
|---|---|
DocumentRequired | choice |
New ExpiryRequired | text |
| Warn Signers a Day Before | choice |
| On Behalf Of | choice |
| Field | Type |
|---|---|
| Success | boolean |
Templates
Look for BoldSign templates in the WEXTL template library.
Browse templates →Other productivity integrations on WEXTL
DocuSeal[2]Send, sign, and manage documents with DocuSeal e-signatures.
GristSpreadsheet-database hybrid for organizing records, documents, and automations with the Grist API.
CarboneGenerate PDFs and other documents from templates and data, and convert files between formats.
DocupilotDocument automation with templates, e-signatures and bulk generation.
Agiled (Public API)Manage clients, deals, projects, invoices and bookings in Agiled.
References
- WEXTL® BoldSign Source Code connector implementation.
- Our users use cases and automations.
- Official API Documentation for BoldSign.
- WEXTL® visual workflow builder data.
Last updated: Nov 11, 2026 16:16
How we write our apps documentation
How we compile these docs: sources, the role of AI, and how we verify.





























