Skip to docs navigation

BoldSign integration guide

Verified

How 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].

Open BoldSign on WEXTL →
  • BoldSign
  • WEXTL
  • DocuSeal
  • Grist
  • Carbone
  • Docupilot
  • Agiled (Public API)
  • ChMeetings
  • codeREADr
  • Outline
  • CraftMyPDF
  • Goody
  • eSignatures.com
  • ONLYOFFICE Docs
  • Dailybot
  • Aboard Sign
  • KoBoToolbox
  • Nextcloud
  • Mem
  • Paperless-ngx
  • Formstack Documents
  • Beeminder
  • Form.io
  • Grain
  • Feathery
  • Frame.io V4
  • Egnyte
  • Mural
  • Adobe Acrobat Sign
  • Interact
  • DocuSign
  • 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]

  1. 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.
  2. Optional: In the Credential name field, enter a name for the credential.
  3. Enter the authentication credentials you copied from your BoldSign account, or follow the on-screen instructions to create the credential.
  4. If prompted, authenticate your account and confirm access.
  5. If you want to make changes to your credential in the future, follow the steps in Manage credentials →

Watch Documents

TriggerStarts the workflow for documents with new activity.
Output fields[3]
FieldType
Document IDtext
Titletext
Statustext
Created (Unix seconds)number
Last Activity (Unix seconds)number
Last Activity Bytext
Expiry (Unix seconds)number
Signing Order Enabledboolean
Deletedboolean
In Editing Modeboolean
Display Statustext
Brand IDtext
Cursornumber

5other output fields

Watch Events

TriggerFires right away when BoldSign sends an event.
Output fields[3]
FieldType
Eventobject
Event IDtext
Created (Unix seconds)number
Event Typetext
Client IDtext
Environmenttext
Contextobject
Event Typetext
Actorobject
Previous Stateobject
Dataobject
Objecttext
Document IDtext
Titletext
Descriptiontext
Statustext
Created (Unix seconds)number
Expiry (Unix seconds)number
Signing Order Enabledboolean
Emails Disabledboolean
Senderobject

Watch Templates

TriggerStarts the workflow when templates show new activity.
Output fields[3]
FieldType
Template IDtext
Nametext
Document IDtext
Template Nametext
Template Descriptiontext
Titletext
Statustext
Last Activity Bytext
Last Activity (Unix seconds)number
Created (Unix seconds)number
Access Typetext
Labelsarray
Labeltext
Template Labelsarray
Template Labeltext

4other output fields

Download a Document

SearchSaves a document as one PDF or a ZIP.
Input fields[3]
FieldType
DocumentRequired
choice
Formatchoice
File Nametext
On Behalf Ofchoice
Output fields[3]
FieldType
Filetext
File Nametext

Download a Document Attachment

SearchFetches a single attachment file from a document.
Input fields[3]
FieldType
DocumentRequired
choice
Attachment IDRequired
text
File Nametext
On Behalf Ofchoice
Output fields[3]
FieldType
Filetext
File Nametext

Download a Template

SearchSaves a template PDF with or without filled values.
Input fields[3]
FieldType
TemplateRequired
choice
Include Field Valuesboolean
On Behalf Ofchoice
Output fields[3]
FieldType
Filetext
File Nametext

Download an Audit Log

SearchGets the audit trail PDF of one document.
Input fields[3]
FieldType
DocumentRequired
choice
File Nametext
On Behalf Ofchoice
Output fields[3]
FieldType
Filetext
File Nametext

Download an ID Verification Image

SearchFetches the selfie or document image of an identity check.
Input fields[3]
FieldType
DocumentRequired
choice
File IDRequired
text
Signerchoice
Signing Ordernumber
Phone Country Codetext
Phone Numbertext
On Behalf Ofchoice
Output fields[3]
FieldType
Imagetext
File Nametext

Get a Brand

SearchShows brand styling and disclaimer settings.
Input fields[3]
FieldType
BrandRequired
choice
Output fields[3]
FieldType
Brand IDtext
Logo URLtext
Brand Nametext
Background Colortext
Button Colortext
Button Text Colortext
Email Display Nametext
Disclaimer Titletext
Disclaimer Texttext
Redirect URLtext
Is Defaultboolean
Can Hide Taglineboolean
Combine Audit Trailboolean

14other output fields

Get a Contact

SearchShows the details of one contact.
Input fields[3]
FieldType
ContactRequired
choice
Output fields[3]
FieldType
Contact IDtext
Nametext
Emailtext
Companytext
Job Titletext
Phone Numberobject
Country Codetext
Numbertext

Get a Contact Group

SearchShows the members and creator of one contact group.
Input fields[3]
FieldType
Contact GroupRequired
choice
Output fields[3]
FieldType
Group IDtext
Group Nametext
Contactsarray
Contactobject
Creatorobject
User IDtext
Created Bytext
Directoriesarray

Get a Document

SearchShows document properties and signer details.
Input fields[3]
FieldType
DocumentRequired
choice
Output fields[3]
FieldType
Document IDtext
Brand IDtext
Message Titletext
Document Descriptiontext
Statustext
Filesarray
IDtext
Document Nametext
Ordernumber
Page Countnumber
Template Nametext
Template IDtext
Sender Detailobject
Nametext
Private Messagetext
Email Addresstext
Is Viewedboolean
Signer Detailsarray
IDtext
Signer Nametext
Signer Roletext
Signer Emailtext
Statustext
Enable Access Codeboolean
Is Authentication Failedboolean
Enable Email OTPboolean
Authentication Typetext
Is Delivery Failedboolean
Form Groupsarray
Minimum Countnumber
Maximum Countnumber
Data Sync Tagtext
Group Namesarray
Group Validationtext
Common Fieldsarray
IDtext
Form Field IDtext
Typetext
Valuetext
Fonttext
Is Requiredboolean
Is Read Onlyboolean
Line Heightnumber
Font Sizenumber
Font Colortext
Behalf Ofobject
Nametext
Email Addresstext
CC Detailsarray
Email Addresstext
Is Viewedboolean
Reminder Settingsobject
Enable Auto Reminderboolean
Reminder Daysnumber
Reminder Countnumber

36other output fields

Get a Sender Identity

SearchShows the approval status and settings of a sender identity.
Input fields[3]
FieldType
Sender Identitychoice
Sender Identity IDtext
Output fields[3]
FieldType
Sender Identity IDtext
Nametext
Emailtext
Statustext
Created Bytext
Approved Datetext
Notificationsobject
Document Viewedboolean
Document Sentboolean
Email Delivery Failedboolean
Document Declinedboolean
Document Revokedboolean
Document Reassignedboolean
Document Completedboolean
Document Signedboolean
Document Expiredboolean
Signer Authentication Failedboolean
Brand IDtext
Redirect URLtext
Metadatatext
Languagetext

Get a Team

SearchShows the members and dates of a single team.
Input fields[3]
FieldType
TeamRequired
choice
Output fields[3]
FieldType
Team IDtext
Team Nametext
Usersarray
User IDtext
Emailtext
First Nametext
Last Nametext
Roletext
Statustext
Created Date (Unix seconds)number
Modified Date (Unix seconds)number

Get a Template

SearchShows what a template contains, from files to defaults.
Input fields[3]
FieldType
TemplateRequired
choice
Output fields[3]
FieldType
Template IDtext
Titletext
Descriptiontext
Document Titletext
Document Messagetext
Filesarray
Document IDtext
File Nametext
Ordernumber
Page Countnumber
Rolesarray
Nametext
Indexnumber
Default Signer Nametext
Default Signer Emailtext
Signer Ordernumber
Signer Typetext
Authenticationtext
Delivery Modetext
CC Emailsarray
Brand IDtext
Allow Message Editingboolean
Allow New Rolesboolean
Allow New Filesboolean
Allow Modify Filesboolean

7other output fields

Get a User

SearchShows a user profile with team and status.
Input fields[3]
FieldType
UserRequired
choice
Output fields[3]
FieldType
User IDtext
Emailtext
First Nametext
Last Nametext
Team IDtext
Team Nametext
Roletext
Statustext
Created Date (Unix seconds)number
Modified Date (Unix seconds)number
Metadatatext

Get an Embedded Signing Link

SearchGives one signer an embedded signing URL.
Input fields[3]
FieldType
DocumentRequired
choice
Signerchoice
Redirect URLtext
Link Valid Untildate
Phone Country Codetext
Phone Numbertext
Output fields[3]
FieldType
Sign Linktext

Get an ID Verification Report

SearchShows the identity check outcome for a signer.
Input fields[3]
FieldType
DocumentRequired
choice
Signerchoice
Signing Ordernumber
Phone Country Codetext
Phone Numbertext
On Behalf Ofchoice
Output fields[3]
FieldType
Verification Resulttext
Verified Datetext
Errorobject
Codetext
Messagetext
Documentobject
Typetext
First Nametext
Last Nametext
Countrytext
Document Numbertext
Addressobject
Date of Birthobject
Issued Dateobject
Expiration Dateobject
Document File IDsarray

Get API Credits

SearchShows the API credits left on the account.
Output fields[3]
FieldType
Balance Creditsnumber

List Brands

SearchShows brands with their colors and disclaimers.
Input fields[3]
FieldType
LimitRequired
number
Output fields[3]
FieldType
Brand IDtext
Logo URLtext
Brand Nametext
Background Colortext
Button Colortext
Button Text Colortext
Email Display Nametext
Disclaimer Titletext
Disclaimer Texttext
Redirect URLtext
Is Defaultboolean
Can Hide Taglineboolean
Combine Audit Trailboolean

14other output fields

List Contact Groups

SearchFinds contact groups by search text and type.
Input fields[3]
FieldType
LimitRequired
number
Searchtext
Group Typechoice
Directoriesarray
Output fields[3]
FieldType
Group IDtext
Group Nametext
Contactsarray
Contactobject
Creatorobject
User IDtext
Created Bytext
Directoriesarray

List Contacts

SearchFinds contacts by search text.
Input fields[3]
FieldType
LimitRequired
number
Searchtext
Contact Typechoice
Output fields[3]
FieldType
Nametext
Emailtext
Companytext
Job Titletext
Phone Numberobject
Country Codetext
Numbertext
Contact IDtext

List Custom Fields

SearchShows the custom form fields a brand owns.
Input fields[3]
FieldType
BrandRequired
choice
LimitRequired
number
Output fields[3]
FieldType
Custom Field IDtext
Field Nametext
Descriptiontext
Brand IDtext
Form Fieldobject
Field Typetext
Widthnumber
Heightnumber
Requiredboolean
Read Onlyboolean
Default Valuetext
Font Sizenumber
Fonttext
Optionsarray
Character Limitnumber

List Documents

SearchFinds documents by state, direction, label or text.
Input fields[3]
FieldType
LimitRequired
number
Statuschoice
Directionchoice
Sent Byarray
Recipientsarray
Labelsarray
Brandschoice
Searchtext
Date Filterchoice
Start Datedate
End Datedate
Output fields[3]
FieldType
Document IDtext
Sender Detailobject
Nametext
Private Messagetext
Email Addresstext
Is Viewedboolean
CC Detailsarray
Email Addresstext
Is Viewedboolean
Created Date (Unix seconds)number
Activity Date (Unix seconds)number
Activity Bytext
Message Titletext
Statustext
Signer Detailsarray
IDtext
Signer Nametext
Signer Roletext
Signer Emailtext
Statustext
Enable Access Codeboolean
Is Authentication Failedboolean
Enable Email OTPboolean
Authentication Typetext
Is Delivery Failedboolean
Expiry Date (Unix seconds)number
Enable Signing Orderboolean
Is Deletedboolean
Labelsarray

5other output fields

List Documents on Behalf

SearchFinds documents sent for others or for you.
Input fields[3]
FieldType
LimitRequired
number
Kindchoice
Sender Identitieschoice
Signer Emailsarray
Statuschoice
Labelsarray
Brandschoice
Searchtext
Start Datedate
End Datedate
Output fields[3]
FieldType
Behalf Ofobject
Nametext
Email Addresstext
Document IDtext
Sender Detailobject
Nametext
Private Messagetext
Email Addresstext
Is Viewedboolean
CC Detailsarray
Email Addresstext
Is Viewedboolean
Created Date (Unix seconds)number
Activity Date (Unix seconds)number
Activity Bytext
Message Titletext
Statustext
Signer Detailsarray
IDtext
Signer Nametext
Signer Roletext
Signer Emailtext
Statustext
Enable Access Codeboolean
Is Authentication Failedboolean
Enable Email OTPboolean
Authentication Typetext
Is Delivery Failedboolean
Expiry Date (Unix seconds)number
Enable Signing Orderboolean
Is Deletedboolean

6other output fields

List Sender Identities

SearchShows sender identities filtered by text or brand.
Input fields[3]
FieldType
LimitRequired
number
Searchtext
Brandschoice
Output fields[3]
FieldType
Sender Identity IDtext
Nametext
Emailtext
Statustext
Created Bytext
Approved Datetext
Notificationsobject
Document Viewedboolean
Document Sentboolean
Email Delivery Failedboolean
Document Declinedboolean
Document Revokedboolean
Document Reassignedboolean
Document Completedboolean
Document Signedboolean
Document Expiredboolean
Signer Authentication Failedboolean
Brand IDtext
Redirect URLtext
Metadatatext
Languagetext

List Team Documents

SearchShows documents across teams, filterable by team or user.
Input fields[3]
FieldType
LimitRequired
number
Teamschoice
Userschoice
Statuschoice
Directionchoice
Labelsarray
Brandschoice
Searchtext
Date Filterchoice
Start Datedate
End Datedate
Output fields[3]
FieldType
Document IDtext
Sender Detailobject
Nametext
Private Messagetext
Email Addresstext
Is Viewedboolean
CC Detailsarray
Email Addresstext
Is Viewedboolean
Created Date (Unix seconds)number
Activity Date (Unix seconds)number
Activity Bytext
Message Titletext
Statustext
Signer Detailsarray
IDtext
Signer Nametext
Signer Roletext
Signer Emailtext
Statustext
Enable Access Codeboolean
Is Authentication Failedboolean
Enable Email OTPboolean
Authentication Typetext
Is Delivery Failedboolean
Expiry Date (Unix seconds)number
Enable Signing Orderboolean
Is Deletedboolean
Labelsarray

5other output fields

List Teams

SearchGives every team name together with its ID.
Input fields[3]
FieldType
LimitRequired
number
Searchtext
Output fields[3]
FieldType
Team IDtext
Team Nametext

List Templates

SearchFinds templates by type, label or text.
Input fields[3]
FieldType
LimitRequired
number
Template Typechoice
Searchtext
Labelsarray
Labeltext
Created Byarray
Emailtext
Brandschoice
Shared With Teamschoice
Start Datedate
End Datedate
On Behalf Ofchoice
Output fields[3]
FieldType
Document IDtext
Template IDtext
Template Nametext
Template Descriptiontext
Message Titletext
Statustext
Last Activity Bytext
Activity Date (Unix seconds)number
Created Date (Unix seconds)number
Access Typetext
Brand IDtext
Senderobject
Nametext
Email Addresstext
User IDtext
Rolesarray
Signer Nametext
Signer Emailtext
Signer Roletext
Statustext

2other output fields

List Users

SearchShows account users, filterable by text.
Input fields[3]
FieldType
LimitRequired
number
Searchtext
Userschoice
Output fields[3]
FieldType
User IDtext
Emailtext
First Nametext
Last Nametext
Team IDtext
Team Nametext
Roletext
Statustext
Metadatatext

Add a Signer Authentication

ActionAdds an identity check for one signer of a document.
Input fields[3]
FieldType
DocumentRequired
choice
SignerRequired
choice
TypeRequired
choice
Signer Ordernumber
On Behalf Ofchoice
Output fields[3]
FieldType
Successboolean

Add Tags to a Document

ActionLabels one BoldSign document with extra tags.
Input fields[3]
FieldType
DocumentRequired
choice
TagsRequired
array
Tagtext
Output fields[3]
FieldType
Successboolean

Add Tags to a Template

ActionLabels a template, its documents or both.
Input fields[3]
FieldType
TemplateRequired
choice
Document Labelsarray
Labeltext
Template Labelsarray
Labeltext
On Behalf Ofchoice
Output fields[3]
FieldType
Successboolean

Cancel a Document Edit

ActionEnds an open editing session on a document.
Input fields[3]
FieldType
DocumentRequired
choice
On Behalf Ofchoice
Output fields[3]
FieldType
Successboolean

Cancel a Signature Request

ActionCancels a sent signature request with a reason signers can read.
Input fields[3]
FieldType
DocumentRequired
choice
ReasonRequired
text
On Behalf Ofchoice
Output fields[3]
FieldType
Successboolean

Cancel a User Invitation

ActionWithdraws a user invite that is still open.
Input fields[3]
FieldType
UserRequired
choice
Output fields[3]
FieldType
Successboolean

Change a Signer

ActionSwaps one signer of a document for someone else.
Input fields[3]
FieldType
DocumentRequired
choice
ReasonRequired
text
New Signer NameRequired
text
New Signer Emailtext
Signerchoice
Signer Ordernumber
New Signer Phone Country Codetext
New Signer Phone Numbertext
Old Signer Phone Country Codetext
Old Signer Phone Numbertext
On Behalf Ofchoice
Output fields[3]
FieldType
Successboolean

Change a Signer Access Code

ActionGives a signer a new code to open the document.
Input fields[3]
FieldType
DocumentRequired
choice
SignerRequired
choice
Access CodeRequired
secret
Signer Ordernumber
Phone Country Codetext
Phone Numbertext
On Behalf Ofchoice
Output fields[3]
FieldType
Successboolean

Change the Team of a User

ActionTransfers a user to another team, optionally handing over documents.
Input fields[3]
FieldType
UserRequired
choice
New TeamRequired
choice
Transfer Documents Tochoice
Output fields[3]
FieldType
Successboolean

Create a Brand

ActionAdds a brand with logo, colors and sender display name.
Input fields[3]
FieldType
Brand NameRequired
text
LogoRequired
text
Background Colortext
Button Colortext
Button Text Colortext
Email Display Nametext
Disclaimer Titletext
Disclaimer Texttext
Redirect URLtext
Send Signed Document Aschoice
Document Time Zonetext
Default Expiry Unitchoice
Default Expiry Valuenumber

21other input fields

Output fields[3]
FieldType
Brand IDtext

Create a Contact

ActionAdds a contact with company and phone details.
Input fields[3]
FieldType
NameRequired
text
EmailRequired
text
Job Titletext
Companytext
Phone Country Codetext
Phone Numbertext
Output fields[3]
FieldType
Contact IDtext
Emailtext

Create a Contact Group

ActionGroups several contacts under one name.
Input fields[3]
FieldType
Group NameRequired
text
ContactsRequired
array
Contactobject
Directoriesarray
Output fields[3]
FieldType
Group IDtext
Group Nametext

Create a Custom Field

ActionAdds a brand form field with type, size and sharing options.
Input fields[3]
FieldType
Field NameRequired
text
BrandRequired
choice
Field TypeRequired
choice
Descriptiontext
Ordernumber
Shared Fieldboolean
Widthnumber
Heightnumber
Requiredboolean
Read Onlyboolean
Default Valuetext
Font Sizenumber
Fontchoice
Output fields[3]
FieldType
Custom Field IDtext
Messagetext

Create a Sender Identity

ActionAdds a sender identity that waits for email confirmation.
Input fields[3]
FieldType
EmailRequired
text
Nametext
Brandchoice
Redirect URLtext
Languagechoice
Notificationsobject
Document Viewedboolean
Document Sentboolean
Email Delivery Failedboolean
Document Declinedboolean
Document Revokedboolean
Document Reassignedboolean
Document Completedboolean
Document Signedboolean
Document Expiredboolean
Signer Authentication Failedboolean
Metadataarray
KeyRequired
text
Valuetext
Output fields[3]
FieldType
Sender Identity IDtext

Create a Team

ActionAdds one team to the BoldSign account.
Input fields[3]
FieldType
Team NameRequired
text
Output fields[3]
FieldType
Team IDtext

Create a Template

ActionAdds a template with signer roles and files.
Input fields[3]
FieldType
Template NameRequired
text
RolesRequired
array
Role NumberRequired
number
Role NameRequired
text
Default Signer Nametext
Default Signer Emailtext
Role Typechoice
Signing Ordernumber
Authenticationchoice
Filetext
More Filesarray
FileRequired
text
File URLsarray
Linktext
Descriptiontext
Document Titletext
Document Messagetext
CCarray
EmailRequired
text
Brandchoice
Document Labelsarray
Labeltext
Template Labelsarray
Labeltext
Use Text Tagsboolean

9other input fields

Output fields[3]
FieldType
Template IDtext

Create a User

ActionSends an account invitation with team and role.
Input fields[3]
FieldType
EmailRequired
text
Teamchoice
Rolechoice
Metadataarray
KeyRequired
text
Valuetext
Output fields[3]
FieldType
Successboolean

Create an Embedded Clone Link

ActionGives an embeddable page that copies a document.
Input fields[3]
FieldType
DocumentRequired
choice
Redirect URLtext
Start Pagechoice
Include Field Valuesboolean
Page Languagechoice
Link Valid Untildate
Show Toolbarboolean
Show Save Buttonboolean
Show Send Buttonboolean
Show Preview Buttonboolean
Show Navigation Buttonsboolean
Show Tooltipsboolean
On Behalf Ofchoice
Output fields[3]
FieldType
Document IDtext
Embed URLtext

Create an Embedded Custom Field Link

ActionOpens the custom field designer for one brand.
Input fields[3]
FieldType
BrandRequired
choice
Link Valid Untildate
Output fields[3]
FieldType
Designer URLtext

Create an Embedded Edit Link

ActionGives embedded editor access to unfinished documents.
Input fields[3]
FieldType
DocumentRequired
choice
Redirect URLtext
Start Pagechoice
Page Languagechoice
Link Valid Untildate
Show Toolbarboolean
Show Send Buttonboolean
Show Preview Buttonboolean
Show Navigation Buttonsboolean
On Behalf Ofchoice
Output fields[3]
FieldType
Edit URLtext

Create an Embedded ID Verification Link

ActionGives one signer an embedded identity check link.
Input fields[3]
FieldType
DocumentRequired
choice
Signerchoice
Redirect URLtext
Signing Ordernumber
Phone Country Codetext
Phone Numbertext
On Behalf Ofchoice
Output fields[3]
FieldType
Verification Linktext

Create an Embedded Merged Send Link

ActionGives a combined template send view for embedding.
Input fields[3]
FieldType
TemplatesRequired
choice
Rolesarray
Role NumberRequired
number
Signer NameRequired
text
Signer EmailRequired
text
Private Messagetext
Document Titletext
Messagetext
CCarray
EmailRequired
text
Enable Signing Orderboolean
Expires After (Days)number
Brandchoice
Labelsarray
Labeltext
Send Remindersboolean
Days Between Remindersnumber
Number of Remindersnumber
Do Not Send Emailsboolean

19other input fields

Output fields[3]
FieldType
Document IDtext
Send URLtext

Create an Embedded Send Link

ActionPrepares and sends a new document on an embedded page.
Input fields[3]
FieldType
TitleRequired
text
SignersRequired
array
NameRequired
text
EmailRequired
text
Rolechoice
Signing Ordernumber
Authenticationchoice
Deliverychoice
Private Messagetext
Languagechoice
Filetext
Form Fieldsarray
Signer NumberRequired
number
Field TypeRequired
choice
PageRequired
number
XRequired
number
YRequired
number
WidthRequired
number
HeightRequired
number
Requiredboolean
Valuetext
Messagetext
CCarray
EmailRequired
text
Enable Signing Orderboolean
Expiry Daysnumber
Send Automatic Remindersboolean
Days Between Remindersnumber
Number of Remindersnumber
Brandchoice
Labelsarray

26other input fields

Output fields[3]
FieldType
Document IDtext
Send URLtext

Create an Embedded Template Clone Link

ActionGives an embedded page that duplicates a template.
Input fields[3]
FieldType
TemplateRequired
choice
Redirect URLtext
Start Pagechoice
Show Toolbarboolean
Show Save Buttonboolean
Show Create Buttonboolean
Show Preview Buttonboolean
Show Navigation Buttonsboolean
Show Tooltipsboolean
Include Field Valuesboolean
Languagechoice
Link Valid Untildate
On Behalf Ofchoice
Output fields[3]
FieldType
New Template IDtext
Embed URLtext

Create an Embedded Template Edit Link

ActionGives a template editing page for embedding in an app.
Input fields[3]
FieldType
TemplateRequired
choice
Redirect URLtext
Start Pagechoice
Show Toolbarboolean
Show Save Buttonboolean
Show Create Buttonboolean
Show Preview Buttonboolean
Show Navigation Buttonsboolean
Show Tooltipsboolean
Languagechoice
Link Valid Untildate
On Behalf Ofchoice
Output fields[3]
FieldType
Edit URLtext

Create an Embedded Template Link

ActionGives an embedded page for creating a template from scratch.
Input fields[3]
FieldType
Template NameRequired
text
Rolesarray
Role NumberRequired
number
Role NameRequired
text
Default Signer Nametext
Default Signer Emailtext
Role Typechoice
Signing Ordernumber
Authenticationchoice
Filetext
More Filesarray
FileRequired
text
File URLsarray
Linktext
Descriptiontext
Document Titletext
Document Messagetext
CCarray
EmailRequired
text
Brandchoice
Document Labelsarray
Labeltext
Template Labelsarray
Labeltext
Use Text Tagsboolean

20other input fields

Output fields[3]
FieldType
Template IDtext
Create URLtext

Create an Embedded Template Preview Link

ActionGives an embedded template preview with an optional expiry.
Input fields[3]
FieldType
TemplateRequired
choice
Show Toolbarboolean
Link Valid Untildate
Output fields[3]
FieldType
Template URLtext

Create an Embedded Template Send Link

ActionGives an embedded send page prefilled from a template.
Input fields[3]
FieldType
TemplateRequired
choice
Document Titletext
Messagetext
CCarray
EmailRequired
text
Enable Signing Orderboolean
Expires After (Days)number
Brandchoice
Labelsarray
Labeltext
Send Remindersboolean
Days Between Remindersnumber
Number of Remindersnumber
Do Not Send Emailsboolean
Do Not Send Text Messagesboolean

20other input fields

Output fields[3]
FieldType
Document IDtext
Send URLtext

Delete a Brand

ActionRemoves one brand, which cannot be reversed.
Input fields[3]
FieldType
BrandRequired
choice
Output fields[3]
FieldType
Messagetext

Delete a Contact

ActionRemoves one saved contact.
Input fields[3]
FieldType
ContactRequired
choice
Output fields[3]
FieldType
Successboolean

Delete a Contact Group

ActionDeletes a group of saved contacts irreversibly.
Input fields[3]
FieldType
Contact GroupRequired
choice
Output fields[3]
FieldType
Successboolean

Delete a Custom Field

ActionRemoves a reusable custom field.
Input fields[3]
FieldType
Custom Field IDRequired
text
Output fields[3]
FieldType
Messagetext

Delete a Document

ActionDeletes a document to the trash or beyond recovery.
Input fields[3]
FieldType
DocumentRequired
choice
Delete Permanentlyboolean
Output fields[3]
FieldType
Successboolean

Delete a Sender Identity

ActionDeletes a sender identity used to send documents.
Input fields[3]
FieldType
Sender IdentityRequired
choice
Output fields[3]
FieldType
Successboolean

Delete a Template

ActionRemoves a template, with an on-behalf option.
Input fields[3]
FieldType
TemplateRequired
choice
On Behalf Ofchoice
Output fields[3]
FieldType
Successboolean

Edit a Brand

ActionChanges brand name, logo and colors.
Input fields[3]
FieldType
BrandRequired
choice
Brand Nametext
Logotext
Background Colortext
Button Colortext
Button Text Colortext
Email Display Nametext
Disclaimer Titletext
Disclaimer Texttext
Redirect URLtext
Send Signed Document Aschoice
Document Time Zonetext
Default Expiry Unitchoice

23other input fields

Output fields[3]
FieldType
Brand IDtext

Edit a Custom Field

ActionEdits custom field name, size and sharing.
Input fields[3]
FieldType
BrandRequired
choice
Custom FieldRequired
choice
Field Nametext
Descriptiontext
Ordernumber
Shared Fieldchoice
Widthnumber
Heightnumber
Requiredchoice
Read Onlychoice
Default Valuetext
Placeholdertext
Character Limitnumber

1other input field

Output fields[3]
FieldType
Custom Field IDtext
Messagetext

Edit a Document

ActionEdits the title, message, signers and expiry of a document.
Input fields[3]
FieldType
DocumentRequired
choice
Titletext
Messagetext
Signer Changesarray
Signerobject
Add Filetext
Remove File IDtext
CCarray
CCobject
Labelsarray
Labeltext
Brandchoice
Enable Signing Orderchoice
Expirychoice
Clear Fieldschoice
On Behalf Ofchoice
Output fields[3]
FieldType
Statustext

Edit a Template

ActionEdits template name, defaults and roles.
Input fields[3]
FieldType
TemplateRequired
choice
Template Nametext
Descriptiontext
Document Titletext
Document Messagetext
Roles (replaces all roles)array
Role NumberRequired
number
Role NameRequired
text
Default Signer Nametext
Default Signer Emailtext
Role Typechoice
Signing Ordernumber
Authenticationchoice
CCarray
EmailRequired
text
Brandchoice
Document Labelsarray
Labeltext
Template Labelsarray
Labeltext
Allow Message Editingchoice
Allow New Roleschoice
Allow New Fileschoice

6other input fields

Output fields[3]
FieldType
Successboolean

Make an API Call

universalCustom BoldSign REST API request.
Input fields[3]
FieldType
URLRequired
text
MethodRequired
choice
Headersarray
Headerobject
Query Stringarray
Parameterobject
Bodytext
Output fields[3]
FieldType
Bodytext
Headersobject
Keytext
Valuetext
Status Codenumber

Remove a Signer Authentication

ActionRemoves the verification requirement from a signer.
Input fields[3]
FieldType
DocumentRequired
choice
SignerRequired
choice
Signer Ordernumber
Phone Country Codetext
Phone Numbertext
On Behalf Ofchoice
Output fields[3]
FieldType
Successboolean

Remove Tags from a Document

ActionStrips chosen tags off a BoldSign document.
Input fields[3]
FieldType
DocumentRequired
choice
TagsRequired
array
Tagtext
Output fields[3]
FieldType
Successboolean

Remove Tags from a Template

ActionRemoves template labels, document labels or both.
Input fields[3]
FieldType
TemplateRequired
choice
Document Labelsarray
Labeltext
Template Labelsarray
Labeltext
On Behalf Ofchoice
Output fields[3]
FieldType
Successboolean

Send a Document

ActionSends a document for signing, review or approval.
Input fields[3]
FieldType
TitleRequired
text
SignersRequired
array
NameRequired
text
EmailRequired
text
Rolechoice
Signing Ordernumber
Authenticationchoice
Deliverychoice
Private Messagetext
Languagechoice
Filetext
Form Fieldsarray
Signer NumberRequired
number
Field TypeRequired
choice
PageRequired
number
XRequired
number
YRequired
number
WidthRequired
number
HeightRequired
number
Requiredboolean
Valuetext
Messagetext
CCarray
EmailRequired
text
Enable Signing Orderboolean
Expiry Daysnumber
Send Automatic Remindersboolean
Days Between Remindersnumber
Number of Remindersnumber
Brandchoice
Labelsarray

16other input fields

Output fields[3]
FieldType
Document IDtext

Send a Document from a Template

ActionSends a document built from a template to its role holders.
Input fields[3]
FieldType
TemplateRequired
choice
Document Titletext
Messagetext
CCarray
EmailRequired
text
Enable Signing Orderboolean
Expires After (Days)number
Brandchoice
Labelsarray
Labeltext
Send Remindersboolean
Days Between Remindersnumber
Number of Remindersnumber
Do Not Send Emailsboolean
Do Not Send Text Messagesboolean

10other input fields

Output fields[3]
FieldType
Document IDtext

Send a Document from Merged Templates

ActionSends a single merged document to the people in the roles.
Input fields[3]
FieldType
TemplatesRequired
choice
RolesRequired
array
Role NumberRequired
number
Signer NameRequired
text
Signer EmailRequired
text
Private Messagetext
Document Titletext
Messagetext
CCarray
EmailRequired
text
Enable Signing Orderboolean
Expires After (Days)number
Brandchoice
Labelsarray
Labeltext
Send Remindersboolean
Days Between Remindersnumber
Number of Remindersnumber
Do Not Send Emailsboolean

9other input fields

Output fields[3]
FieldType
Document IDtext

Send a Draft Document

ActionMoves a draft into the signing stage.
Input fields[3]
FieldType
DocumentRequired
choice
Output fields[3]
FieldType
Successboolean

Send a Reminder

ActionSends a reminder to signers who still have to sign.
Input fields[3]
FieldType
DocumentRequired
choice
Signerschoice
Messagetext
Phone Numbersarray
Phone Numberobject
On Behalf Ofchoice
Output fields[3]
FieldType
Successboolean

Send a Sender Identity Invitation Again

ActionResends the invitation for an unconfirmed identity.
Input fields[3]
FieldType
Sender IdentityRequired
choice
Output fields[3]
FieldType
Successboolean

Send a Sender Identity Request Again

ActionAsks BoldSign a second time to approve a denied identity.
Input fields[3]
FieldType
Sender IdentityRequired
choice
Output fields[3]
FieldType
Successboolean

Send a User Invitation Again

ActionRe-invites a user whose invitation is still pending.
Input fields[3]
FieldType
UserRequired
choice
Output fields[3]
FieldType
Successboolean

Set Document Field Values

ActionPrefills form field values on one document.
Input fields[3]
FieldType
DocumentRequired
choice
FieldsRequired
array
Fieldobject
On Behalf Ofchoice
Output fields[3]
FieldType
Successboolean

Set the Default Brand

ActionSwitches the account default to another brand.
Input fields[3]
FieldType
BrandRequired
choice
Output fields[3]
FieldType
Messagetext

Update a Contact

ActionEdits a contact and can clear fields.
Input fields[3]
FieldType
ContactRequired
choice
Nametext
Emailtext
Job Titletext
Companytext
Phone Country Codetext
Phone Numbertext
Clear Fieldschoice
Output fields[3]
FieldType
Successboolean

Update a Contact Group

ActionEdits the name, members and directories of a contact group.
Input fields[3]
FieldType
Contact GroupRequired
choice
Group Nametext
Contacts (replaces all contacts)array
Contactobject
Directoriesarray
Clear Fieldschoice
Output fields[3]
FieldType
Successboolean

Update a Sender Identity

ActionEdits sender identity name, language and redirect link.
Input fields[3]
FieldType
Sender IdentityRequired
choice
Nametext
Redirect URLtext
Languagechoice
Metadataarray
KeyRequired
text
Valuetext
Document Viewedchoice
Document Sentchoice
Email Delivery Failedchoice
Document Declinedchoice
Document Revokedchoice
Document Reassignedchoice
Document Completedchoice
Document Signedchoice

5other input fields

Output fields[3]
FieldType
Successboolean

Update a Team

ActionChanges the display name of one team.
Input fields[3]
FieldType
TeamRequired
choice
Team NameRequired
text
Output fields[3]
FieldType
Successboolean

Update a User

ActionEdits a user role and active status.
Input fields[3]
FieldType
UserRequired
choice
Rolechoice
Statuschoice
Transfer Documents Tochoice
Output fields[3]
FieldType
Successboolean

Update the Document Expiry

ActionGives a document a later expiry.
Input fields[3]
FieldType
DocumentRequired
choice
New ExpiryRequired
text
Warn Signers a Day Beforechoice
On Behalf Ofchoice
Output fields[3]
FieldType
Successboolean

Update the Metadata of a User

ActionRewrites the metadata of a user with a full entry list.
Input fields[3]
FieldType
UserRequired
choice
MetadataRequired
array
KeyRequired
text
Valuetext
Output fields[3]
FieldType
Successboolean

Update the Sharing of a Template

ActionShares a template with teams or stops sharing it.
Input fields[3]
FieldType
TemplateRequired
choice
TeamsRequired
array
TeamRequired
choice
ActionRequired
choice
Accesschoice
Output fields[3]
FieldType
Successboolean

Look for BoldSign templates in the WEXTL template library.

Browse templates →
  1. WEXTL® BoldSign Source Code connector implementation.
  2. Our users use cases and automations.
  3. Official API Documentation for BoldSign.
  4. 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.