The BoldSign connector lets your AI agent act in each user's BoldSign account. Each user connects their own BoldSign API key once, and Scalekit sends it with every call, so your agent never handles credentials. It comes with 50 tools.
- Tools
- 50
- What they doRead · write · destructive
- 21 · 20 · 921 read20 write9 destructive
- Users sign in with
- API key
Setup
Install the SDK
Terminal window npm install @scalekit-sdk/node dotenvTerminal window pip install scalekit-sdk-python python-dotenvSet your credentials
Add your Scalekit credentials to your
.envfile. Find values in app.scalekit.com > Developers > API Credentials..env SCALEKIT_ENVIRONMENT_URL=<your-environment-url>SCALEKIT_CLIENT_ID=<your-client-id>SCALEKIT_CLIENT_SECRET=<your-client-secret>Create the BoldSign connection
In AgentKit > Connections, create a BoldSign connection. The name you give it is the
connection_nameyour code passes. See Configure connections.Authorize a user and make your first call
quickstart.mts import { ScalekitClient } from '@scalekit-sdk/node'import 'dotenv/config'import { createInterface } from 'node:readline/promises'const scalekit = new ScalekitClient(process.env.SCALEKIT_ENVIRONMENT_URL,process.env.SCALEKIT_CLIENT_ID,process.env.SCALEKIT_CLIENT_SECRET,)const actions = scalekit.actionsconst connector = 'boldsign'const identifier = 'user_123'// Generate an authorization link for the userconst { link } = await actions.getAuthorizationLink({ connectionName: connector, identifier })console.log('Authorize BoldSign:', link)const rl = createInterface({ input: process.stdin, output: process.stdout })await rl.question('Press Enter after authorizing...')rl.close()// Make your first callconst result = await actions.executeTool({connector,identifier,toolName: 'boldsign_get_api_credits',toolInput: {},})console.log(result)Terminal window npx tsx quickstart.mtsquickstart.py import osfrom scalekit import ScalekitClientfrom dotenv import load_dotenvload_dotenv()scalekit_client = ScalekitClient(env_url=os.getenv("SCALEKIT_ENVIRONMENT_URL"),client_id=os.getenv("SCALEKIT_CLIENT_ID"),client_secret=os.getenv("SCALEKIT_CLIENT_SECRET"),)actions = scalekit_client.actionsconnection_name = "boldsign"identifier = "user_123"# Generate an authorization link for the userlink_response = actions.get_authorization_link(connection_name=connection_name,identifier=identifier,)print("Authorize BoldSign:", link_response.link)input("Press Enter after authorizing...")# Make your first callresult = actions.execute_tool(tool_input={},tool_name="boldsign_get_api_credits",connection_name=connection_name,identifier=identifier,)print(result)Terminal window python quickstart.pyEach user opens the link once and enters their BoldSign credentials there. See Authorize a user for the full flow and statuses.
Tools
Pass the exact name toexecute_toolboldsign_get_api_creditsRetrieve the remaining API credits of the account.Read-onlyGet API Credits Balance
Retrieve the remaining API credits of the account. Returns BalanceCredits. Use to check whether the account can still send documents through the API.
Inputs
This tool takes no inputs.
boldsign_get_brandRetrieve the settings of one brand.Read-onlyGet Brand
Retrieve the settings of one brand. Returns brandId, brandName, brandLogo, colors, emailDisplayName, disclaimer text, redirectUrl and isDefault. Use after boldsign_list_brands to read one brand.
Inputs
brandIdstringrequired- Brand ID returned by boldsign_list_brands.
boldsign_get_contactRetrieve one contact by id.Read-onlyGet Contact
Retrieve one contact by id. Returns id, name, email, companyName, jobTitle and phoneNumber. Use after boldsign_list_contacts to read one contact.
Inputs
idstringrequired- Contact ID returned by boldsign_list_contacts.
boldsign_get_contact_groupRetrieve one contact group with its members.Read-onlyGet Contact Group
Retrieve one contact group with its members. Returns groupId, groupName, contacts, creator and directories. Use after boldsign_list_contact_groups to read one group.
Inputs
groupIdstringrequired- Group ID returned by boldsign_list_contact_groups.
boldsign_get_document_propertiesRetrieve the full details of one document, including its status, signers, form fields, files and history.Read-onlyGet Document Properties
Retrieve the full details of one document, including its status, signers, form fields, files and history. Returns documentId, messageTitle, status, senderDetail, signerDetails, ccDetails, formGroups, documentHistory and expiry settings. Use after boldsign_list_documents to inspect one document. Use boldsign_list_documents to find documents.
Inputs
documentIdstringrequired- Document ID returned by boldsign_send_document or boldsign_list_documents.
boldsign_get_embedded_sign_linkGenerate a signing URL for one signer of a document created with embedded signing enabled.Read-onlyGet Embedded Signing Link
Generate a signing URL for one signer of a document created with embedded signing enabled. Returns signLink, a URL the signer opens to sign. Use to embed signing in your own app. The document must have been sent with enableEmbeddedSigning true.
Inputs
DocumentIdstringrequired- Document ID returned by boldsign_send_document or boldsign_list_documents.
CountryCodestring- Phone country code of the signer when the signer is identified by phone, for example +1.
PhoneNumberstring- Phone number of the signer when the signer is identified by phone.
RedirectUrlstring- URL the signer is redirected to after signing.
SignerEmailstring- Email address of the signer the link is for.
SignLinkValidTillstring- Date and time until which the link is valid, as an ISO 8601 timestamp.
boldsign_get_sender_identityRetrieve one sender identity by id or email.Read-onlyGet Sender Identity
Retrieve one sender identity by id or email. Returns id, name, email, status, brandId, redirectUrl, notificationSettings and locale. Use after boldsign_list_sender_identities. Provide either id or email.
Inputs
emailstring- Sender identity email address. Provide this or id.
idstring- Sender identity ID. Provide this or email.
boldsign_get_teamRetrieve one team with its members.Read-onlyGet Team
Retrieve one team with its members. Returns teamId, teamName, users, createdDate and modifiedDate. Use after boldsign_list_teams to read one team.
Inputs
teamIdstringrequired- Team ID returned by boldsign_list_teams.
boldsign_get_template_propertiesRetrieve the details of one template, including its roles, files, form fields and settings.Read-onlyGet Template Properties
Retrieve the details of one template, including its roles, files, form fields and settings. Returns templateId, title, documentTitle, roles, formGroups, commonFields, ccDetails and sharing options. Use before boldsign_send_document_from_template to learn the role indices to fill.
Inputs
templateIdstringrequired- Template ID returned by boldsign_list_templates.
boldsign_get_userRetrieve one user of the account.Read-onlyGet User
Retrieve one user of the account. Returns userId, email, firstName, lastName, role, userStatus, teamId, teamName and metaData. Use after boldsign_list_users to read one user.
Inputs
userIdstringrequired- User ID returned by boldsign_list_users.
boldsign_list_brandsList the brands defined in the account.Read-onlyList Brands
List the brands defined in the account. Returns a result array with brandId, brandName, brandLogo and isDefault for each brand. Use to find a brandId for sending documents. Use boldsign_get_brand for the full details of one brand.
Inputs
This tool takes no inputs.
boldsign_list_contact_groupsList contact groups, optionally filtered by search text.Read-onlyList Contact Groups
List contact groups, optionally filtered by search text. Returns groupId, groupName, contacts and pageDetails. Use to find a groupId. Use boldsign_get_contact_group for one group.
Inputs
Pageintegerrequired- Page number to return, starting at 1.
ContactTypestring- Whether to list groups of the user or of the organization. Allowed values: MyContacts, AllContacts.one of
MyContactsAllContacts Directoriesstring- Directory to list groups from. Pass a single value.
PageSizeinteger- Number of groups per page, up to 100.
SearchKeystring- Text matched against group names.
boldsign_list_contactsList contacts in the BoldSign address book, optionally filtered by search text.Read-onlyList Contacts
List contacts in the BoldSign address book, optionally filtered by search text. Returns id, name, email, companyName, jobTitle, phoneNumber and pageDetails. Use to find a contact id. Use boldsign_get_contact for one contact.
Inputs
Pageintegerrequired- Page number to return, starting at 1.
ContactTypestring- Whether to list contacts of the user or of the organization. Allowed values: MyContacts, AllContacts.one of
MyContactsAllContacts PageSizeinteger- Number of contacts per page, up to 100.
SearchKeystring- Text matched against contact names and email addresses.
boldsign_list_custom_fieldsList the custom form fields saved for a brand.Read-onlyList Custom Fields
List the custom form fields saved for a brand. Returns a result array with customFieldId, fieldName, fieldType and formatting settings. Use to find a customFieldId. Custom fields belong to a brand; use boldsign_list_brands to find one.
Inputs
brandIdstringrequired- ID of the brand whose custom fields to list.
boldsign_list_documentsList documents the API key owner has sent or received, filtered by status, date range, sender, recipient, label or text search.Read-onlyList Documents
List documents the API key owner has sent or received, filtered by status, date range, sender, recipient, label or text search. Returns documentId, messageTitle, status, signerDetails, createdDate, expiryDate and pageDetails with totalRecordsCount. Use for browsing and finding a documentId. Use boldsign_get_document_properties for the full detail of one document.
Inputs
Pageintegerrequired- Page number to return, starting at 1.
BrandIdsstring- BrandId(s) of the document. Pass a single value.
DateFilterTypestring- Date Filter as SentBetween and ExpiresOn. Allowed values: SentBetween, Expiring.one of
SentBetweenExpiring EndDatestring- End date of the document.
Labelsstring- Labels of the document. Pass a single value.
NextCursorinteger- Next cursor value for pagination, required for fetching the next set of documents beyond 10,000 records.
PageSizeinteger- Number of documents per page, up to 100.
Recipientsstring- Email address of a recipient to filter by. Pass a single email.
SearchKeystring- Documents can be listed by the search key present in the document like document title, document ID, sender or recipient(s) name, etc.,.
SentBystring- Email address of the sender to filter by. Pass a single email.
StartDatestring- Start date of the document.
Statusstring- Document status to filter by. Pass a single status. Allowed values: None, WaitingForMe, WaitingForOthers, NeedAttention, Completed, Declined, Revoked, Expired, Draft, Scheduled.one of
NoneWaitingForMeWaitingForOthersNeedAttentionCompletedDeclinedRevokedExpiredDraftScheduled TransmitTypestring- Transmit Type. Allowed values: Sent, Received, Both.one of
SentReceivedBoth
boldsign_list_documents_on_behalfList documents sent on behalf of other senders or for other users, filtered by sender email, signer, status or date.Read-onlyList Documents Sent On Behalf
List documents sent on behalf of other senders or for other users, filtered by sender email, signer, status or date. Returns documentId, messageTitle, status, behalfOf and pageDetails. Use when documents were created through sender identities. Use boldsign_list_documents for the API key owner's own documents.
Inputs
Pageintegerrequired- Page number to return, starting at 1.
BrandIdsstring- BrandId(s) of the document. Pass a single value.
EmailAddressstring- The sender identity's email used to filter the documents returned in the API. The API will return documents that were sent on behalf of the specified email address. Pass a single value.
EndDatestring- End date of the document.
Labelsstring- Labels of the document. Pass a single value.
NextCursorinteger- Next cursor value for pagination, required for fetching the next set of documents beyond 10,000 records.
PageSizeinteger- Number of documents per page, up to 100.
PageTypestring- The filter used to differentiate between documents sent on the user's behalf and documents sent by the user on behalf of others. The API will return documents based on the specified value. Allowed values: BehalfOfOthers, BehalfOfMe.one of
BehalfOfOthersBehalfOfMe SearchKeystring- Documents can be listed by the search key present in the document like document title, document ID, sender or recipient(s) name, etc.,.
Signersstring- Email address of a signer to filter by. Pass a single email.
StartDatestring- Start date of the document.
Statusstring- Document status to filter by. Pass a single status. Allowed values: None, WaitingForMe, WaitingForOthers, NeedAttention, Completed, Declined, Revoked, Expired, Draft, Scheduled.one of
NoneWaitingForMeWaitingForOthersNeedAttentionCompletedDeclinedRevokedExpiredDraftScheduled
boldsign_list_sender_identitiesList sender identities, which are the approved email senders documents can be sent on behalf of.Read-onlyList Sender Identities
List sender identities, which are the approved email senders documents can be sent on behalf of. Returns id, name, email, status and pageDetails. Use to find an identity. Use boldsign_get_sender_identity for one identity.
Inputs
Pageintegerrequired- Page number to return, starting at 1.
BrandIdsstring- Brand ID to filter by. Pass a single ID.
PageSizeinteger- Number of identities per page, up to 100.
Searchstring- Text matched against identity names and emails.
boldsign_list_team_documentsList documents sent by members of the teams the API key owner administers, filtered by user, team, status or date.Read-onlyList Team Documents
List documents sent by members of the teams the API key owner administers, filtered by user, team, status or date. Returns documentId, messageTitle, status, senderDetail, signerDetails and pageDetails. Use for team-wide reporting. Use boldsign_list_documents for the API key owner's own documents.
Inputs
Pageintegerrequired- Page number to return, starting at 1.
BrandIdsstring- BrandId(s) of the document. Pass a single value.
DateFilterTypestring- Date Filter as SentBetween and Expiring. Allowed values: SentBetween, Expiring.one of
SentBetweenExpiring EndDatestring- End date of the document.
Labelsstring- Labels of the document. Pass a single value.
NextCursorinteger- Next cursor value for pagination, required for fetching the next set of documents beyond 10,000 records.
PageSizeinteger- Number of documents per page, up to 100.
SearchKeystring- Documents can be listed by the search key present in the document like document title, document ID, sender or recipient(s) name, etc.,.
StartDatestring- Start date of the document.
Statusstring- Document status to filter by. Pass a single status. Allowed values: None, WaitingForMe, WaitingForOthers, NeedAttention, Completed, Declined, Revoked, Expired, Draft, Scheduled.one of
NoneWaitingForMeWaitingForOthersNeedAttentionCompletedDeclinedRevokedExpiredDraftScheduled TeamIdstring- TeamId of the Team document. Pass a single value.
TransmitTypestring- Transmit type as Sent, Received and Both. Allowed values: Sent, Received, Both.one of
SentReceivedBoth UserIdstring- UserId of the Team document. Pass a single value.
boldsign_list_teamsList the teams in the account, optionally filtered by search text.Read-onlyList Teams
List the teams in the account, optionally filtered by search text. Returns teamId, teamName, createdDate and pageDetails. Use to find a teamId. Use boldsign_get_team to see the members of one team.
Inputs
Pageintegerrequired- Page number to return, starting at 1.
PageSizeinteger- Number of teams per page, up to 100.
SearchKeystring- Text matched against team names.
boldsign_list_templatesList templates in the account, filtered by type, label, creator, brand or text search.Read-onlyList Templates
List templates in the account, filtered by type, label, creator, brand or text search. Returns templateId, templateName, createdBy, createdDate, roles and pageDetails. Use to find a templateId. Use boldsign_get_template_properties for the roles and fields of one template.
Inputs
Pageintegerrequired- Page number to return, starting at 1.
BrandIdsstring- BrandId(s) of the template. Pass a single value.
CreatedBystring- Email address of the template creator to filter by. Pass a single email.
EndDatestring- End date of the template.
OnBehalfOfstring- Email address of the sender identity to act on behalf of. Leave empty to act as the API key owner.
PageSizeinteger- Number of templates per page, up to 100.
SearchKeystring- Text matched against template names and descriptions.
SharedWithTeamIdstring- The templates can be listed by the shared teams. Pass a single value.
StartDatestring- Start date of the template.
TemplateLabelsstring- Label to filter by. Pass a single label.
TemplateTypestring- Which templates to list. Allowed values: mytemplates, sharedtemplate, all.one of
mytemplatessharedtemplateall
boldsign_list_usersList the users of the BoldSign account, optionally filtered by search text.Read-onlyList Users
List the users of the BoldSign account, optionally filtered by search text. Returns userId, email, firstName, lastName, role, userStatus, teamName and pageDetails. Use to find a userId. Use boldsign_get_user for one user.
Inputs
Pageintegerrequired- Page number to return, starting at 1.
PageSizeinteger- Number of users per page, up to 100.
Searchstring- Text matched against user names and emails.
UserIdstring- User ID to filter by. Pass a single ID.
boldsign_change_document_recipientReplace a signer on an in-progress document with a different person.WriteChange Document Recipient
Replace a signer on an in-progress document with a different person. Returns an empty response on success. Use when a signer needs to be reassigned. Identify the old signer by oldSignerEmail and give the new signer's name and email.
Inputs
documentIdstringrequired- Document ID returned by boldsign_send_document or boldsign_list_documents.
newSignerNamestringrequired- Name of the new signer.
reasonstringrequired- Reason for the change, shown to the new signer.
newSignerEmailstring- Email address of the new signer.
oldSignerEmailstring- Email address of the signer being replaced.
onBehalfOfstring- Email address of the sender identity to act on behalf of. Leave empty to act as the API key owner.
orderinteger- Signing order position of the signer being replaced, when signing order is enabled.
boldsign_create_contact_groupCreate a contact group with a name and its member contacts.WriteCreate Contact Group
Create a contact group with a name and its member contacts. Returns groupId and groupName. Use to bundle signers that are used together. Use boldsign_update_contact_group to change a group.
Inputs
contactsarrayrequired- Array of member objects, each with a name and email. Provide a JSON array of objects.
groupNamestringrequired- Name of the new group.
directoriesarray- Array of directories the group belongs to.
boldsign_create_contactsCreate one or more contacts in the BoldSign address book.WriteCreate Contacts
Create one or more contacts in the BoldSign address book. Returns createdContacts, each with the new contact id, name and email. Use to save signers for reuse. Use boldsign_update_contact to change an existing contact.
Inputs
contactsarrayrequired- Array of contact objects. Each needs a name and email, and may include phoneNumber (object with countryCode and number), jobTitle and companyName. Provide a JSON array of objects.
boldsign_create_embedded_send_urlCreate a draft document and return a URL that opens the BoldSign send page inside your own app.WriteCreate Embedded Send URL
Create a draft document and return a URL that opens the BoldSign send page inside your own app. Returns documentId and sendUrl. Use to let a user review and place fields before sending. Use boldsign_send_document for fully API-driven sending.
Inputs
fileUrlsarrayrequired- Array of publicly reachable URLs of the files to include. At least one URL is required.
brandIdstring- ID of the brand to apply to the emails and signing pages, from boldsign_list_brands. Leave empty for the default brand.
ccarray- Array of objects, each with an emailAddress, for people who receive a copy of the completed document. Provide a JSON array of objects.
disableEmailsboolean- Set true to stop BoldSign from emailing signers, for example when signing happens inside your own app.
disableSMSboolean- Set true to stop BoldSign from sending SMS notifications to signers.
embeddedSendLinkValidTillstring- Date and time until which the returned send URL stays valid, as an ISO 8601 timestamp.
enableEmbeddedSigningboolean- Set true to allow signing inside your own app.
enableSigningOrderboolean- Set true to make signers sign one after another in the order given by signerOrder.
expiryDaysinteger- Number of days until the signature request expires.
hideDocumentIdboolean- Set true to hide the document ID on the signed pages.
isSandboxboolean- Set true to create the document in sandbox mode, which is free and not legally binding.
labelsarray- Array of labels to tag the document with for later filtering.
messagestring- Message shown to signers in the signature request email.
metaDataobject- Object of custom string key-value pairs stored with the document.
onBehalfOfstring- Email address of the sender identity to act on behalf of. Leave empty to act as the API key owner.
redirectUrlstring- URL the user is redirected to after the document is sent.
reminderSettingsobject- Object that controls automatic reminders, with enableAutoReminder (boolean), reminderDays (days between reminders) and reminderCount (number of reminders).
sendViewOptionstring- Which view the embedded page opens on, PreparePage to place fields or FillingPage to fill them. Allowed values: PreparePage, FillingPage.one of
PreparePageFillingPage showNavigationButtonsboolean- Set true to show the navigation buttons on the embedded page.
showPreviewButtonboolean- Set true to show the preview button on the embedded page.
showSaveButtonboolean- Set true to show the save button on the embedded page.
showSendButtonboolean- Set true to show the send button on the embedded page.
showToolbarboolean- Set true to show the BoldSign toolbar on the embedded page.
showTooltipboolean- Set true to show tooltips on the embedded page.
signersarray- Array of signer objects. Each needs a name, emailAddress and signerType (Signer, Reviewer or InPersonSigner). Provide a JSON array of objects.
titlestring- Title shown in the signature request email and the BoldSign dashboard.
boldsign_create_embedded_template_send_urlCreate a draft document from a template and return a URL that opens the BoldSign send page inside your own app.WriteCreate Embedded Template Send URL
Create a draft document from a template and return a URL that opens the BoldSign send page inside your own app. Returns documentId and sendUrl. Use to let a user review a template-based document before sending. Use boldsign_send_document_from_template for fully API-driven sending.
Inputs
rolesarrayrequired- Array of role objects. Each has a roleIndex matching a template role, plus signerName and signerEmail. Provide a JSON array of objects.
templateIdstringrequired- Template ID returned by boldsign_list_templates.
brandIdstring- ID of the brand to apply to the emails and signing pages, from boldsign_list_brands. Leave empty for the default brand.
ccarray- Array of objects, each with an emailAddress, for people who receive a copy of the completed document. Provide a JSON array of objects.
disableEmailsboolean- Set true to stop BoldSign from emailing signers, for example when signing happens inside your own app.
disableExpiryAlertboolean- Set true to stop expiry alert emails.
disableSMSboolean- Set true to stop BoldSign from sending SMS notifications to signers.
enablePrintAndSignboolean- Set true to let signers print, sign by hand and upload the document.
enableReassignboolean- Set true to let signers reassign the document to someone else.
enableSigningOrderboolean- Set true to make signers sign one after another in the order given by signerOrder.
expiryDaysinteger- Number of days until the signature request expires.
hideDocumentIdboolean- Set true to hide the document ID on the signed pages.
isSandboxboolean- Set true to create the document in sandbox mode, which is free and not legally binding.
labelsarray- Array of labels to tag the document with for later filtering.
messagestring- Message shown to signers in the signature request email.
metaDataobject- Object of custom string key-value pairs stored with the document.
onBehalfOfstring- Email address of the sender identity to act on behalf of. Leave empty to act as the API key owner.
redirectUrlstring- URL the user is redirected to after the document is sent.
reminderSettingsobject- Object that controls automatic reminders, with enableAutoReminder (boolean), reminderDays (days between reminders) and reminderCount (number of reminders).
removeFormFieldsarray- Array of form field IDs to remove from this document.
roleRemovalIndicesarray- Array of template role indices to leave out of this document.
sendLinkValidTillstring- Date and time until which the returned send URL stays valid, as an ISO 8601 timestamp.
sendViewOptionstring- Which view the embedded page opens on, PreparePage to place fields or FillingPage to fill them. Allowed values: PreparePage, FillingPage.one of
PreparePageFillingPage showNavigationButtonsboolean- Set true to show the navigation buttons on the embedded page.
showPreviewButtonboolean- Set true to show the preview button on the embedded page.
showSaveButtonboolean- Set true to show the save button on the embedded page.
showSendButtonboolean- Set true to show the send button on the embedded page.
showToolbarboolean- Set true to show the BoldSign toolbar on the embedded page.
showTooltipboolean- Set true to show tooltips on the embedded page.
titlestring- Title shown in the signature request email and the BoldSign dashboard.
boldsign_create_sender_identityCreate a sender identity and send it an approval invitation.WriteCreate Sender Identity
Create a sender identity and send it an approval invitation. Returns senderIdentityId. Use to let documents be sent on behalf of a shared mailbox. The identity becomes usable after the recipient approves it.
Inputs
emailstringrequired- Email address of the sender identity. An approval invitation is sent here.
brandIdstring- ID of the brand to use for this identity.
localestring- Language of the emails, for example EN. Allowed values: EN, NO, FR, DE, ES, BG, CS, DA, IT, NL, PL, PT, RO, RU, SV, Default, JA, TH, ZH_CN, ZH_TW, KO.one of
ENNOFRDEESBGCSDAITNLPLPTRORUSVDefaultJATHZH_CNZH_TWKO metaDataobject- Object of custom string key-value pairs.
namestring- Display name of the sender identity.
notificationSettingsobject- Object of notification toggles for this identity, such as signed, viewed and declined notifications.
redirectUrlstring- URL signers are redirected to after signing.
boldsign_extend_document_expiryExtend the expiry date of an in-progress document.WriteExtend Document Expiry
Extend the expiry date of an in-progress document. Returns an empty response on success. Use before a document expires. The new date cannot be more than 180 days after the document was created.
Inputs
documentIdstringrequired- Document ID returned by boldsign_send_document or boldsign_list_documents.
newExpiryValuestringrequired- New expiry. Format depends on the document expiry type: a date yyyy-MM-dd when expiry is in Days, an integer when in Hours, or an ISO 8601 date-time when a specific date and time. Cannot be more than 180 days after the document was created.
onBehalfOfstring- Email address of the sender identity to act on behalf of. Leave empty to act as the API key owner.
warnPriorboolean- Set true to notify signers one day before expiry, false to send no such notice. Leave empty to keep the document setting.
boldsign_merge_and_send_templateMerge several templates into one document and send it for e-signature.WriteMerge Templates And Send
Merge several templates into one document and send it for e-signature. Returns the documentId of the new document. Use when a single request combines multiple templates. Use boldsign_send_document_from_template for one template.
Inputs
rolesarrayrequired- Array of role objects. Each has a roleIndex matching the merged template roles, plus signerName, signerEmail and optionally signerOrder and formFields. Provide a JSON array of objects.
templateIdsarrayrequired- Array of template IDs to merge, in the order the documents should appear.
allowScheduledSendboolean- Set true to schedule the send for scheduledSendTime instead of sending immediately.
brandIdstring- ID of the brand to apply to the emails and signing pages, from boldsign_list_brands. Leave empty for the default brand.
ccarray- Array of objects, each with an emailAddress, for people who receive a copy of the completed document. Provide a JSON array of objects.
disableEmailsboolean- Set true to stop BoldSign from emailing signers, for example when signing happens inside your own app.
disableExpiryAlertboolean- Set true to stop expiry alert emails.
disableSMSboolean- Set true to stop BoldSign from sending SMS notifications to signers.
documentTimeZonestring- IANA-style time zone name used for dates on the document, for example Europe/London.
enablePrintAndSignboolean- Set true to let signers print, sign by hand and upload the document.
enableReassignboolean- Set true to let signers reassign the document to someone else.
enableSigningOrderboolean- Set true to make signers sign one after another in the order given by signerOrder.
expiryDaysinteger- Number of days until the signature request expires.
hideDocumentIdboolean- Set true to hide the document ID on the signed pages.
isSandboxboolean- Set true to create the document in sandbox mode, which is free and not legally binding.
labelsarray- Array of labels to tag the document with for later filtering.
messagestring- Message shown to signers in the signature request email.
metaDataobject- Object of custom string key-value pairs stored with the document.
onBehalfOfstring- Email address of the sender identity to act on behalf of. Leave empty to act as the API key owner.
reminderSettingsobject- Object that controls automatic reminders, with enableAutoReminder (boolean), reminderDays (days between reminders) and reminderCount (number of reminders).
removeFormFieldsarray- Array of form field IDs to remove from this document.
roleRemovalIndicesarray- Array of template role indices to leave out of this document.
scheduledSendTimeinteger- Unix timestamp in seconds at which to send the document. Requires allowScheduledSend true.
titlestring- Title shown in the signature request email and the BoldSign dashboard.
boldsign_prefill_document_fieldsPrefill values of form fields on a draft or in-progress document before signers open it.WritePrefill Document Fields
Prefill values of form fields on a draft or in-progress document before signers open it. Returns an empty response on success. Use to populate fields such as names or amounts from your system. Field IDs come from boldsign_get_document_properties.
Inputs
documentIdstringrequired- Document ID returned by boldsign_send_document or boldsign_list_documents.
fieldsarrayrequired- Array of objects, each with the id of a form field and the value to prefill. Provide a JSON array of objects.
onBehalfOfstring- Email address of the sender identity to act on behalf of. Leave empty to act as the API key owner.
boldsign_remind_documentSend a reminder email to signers who have not yet completed an in-progress document.WriteRemind Signers
Send a reminder email to signers who have not yet completed an in-progress document. Returns an empty response on success. Use to nudge pending signers. Only signers who still have to act are reminded.
Inputs
documentIdstringrequired- Document ID returned by boldsign_send_document or boldsign_list_documents.
messagestring- Custom message included in the reminder email.
onBehalfOfstring- Email address of the sender identity to act on behalf of. Leave empty to act as the API key owner.
receiverEmailsstring- Email address of one signer to remind. Leave empty to remind all pending signers.
reminderPhoneNumbersarray- Array of phone number objects, each with countryCode and number, to remind by SMS. Provide a JSON array of objects.
boldsign_resend_sender_identity_invitationResend the approval invitation of a sender identity that is still pending.WriteResend Sender Identity Invitation
Resend the approval invitation of a sender identity that is still pending. Returns an empty response on success. Use when the invitation email was missed.
Inputs
emailstringrequired- Email address of the pending sender identity.
boldsign_revoke_documentRevoke an in-progress document so signers can no longer sign it.WriteRevoke Document
Revoke an in-progress document so signers can no longer sign it. Returns an empty response on success. Use to cancel a signature request that was sent in error. Use boldsign_delete_document to remove the document from the account.
Inputs
documentIdstringrequired- Document ID returned by boldsign_send_document or boldsign_list_documents.
messagestringrequired- Reason for revoking, shown to the signers.
onBehalfOfstring- Email address of the sender identity to act on behalf of. Leave empty to act as the API key owner.
boldsign_send_documentSend one or more documents, supplied as public file URLs, to signers for e-signature.WriteSend Document For Signature
Send one or more documents, supplied as public file URLs, to signers for e-signature. Returns the documentId of the new document. Use for ad hoc documents. Use boldsign_send_document_from_template to send a saved template. Provide signers with their form fields; use fileUrls for the document source.
Inputs
fileUrlsarrayrequired- Array of publicly reachable URLs of the files to send, for example PDF or Word documents. At least one URL is required.
signersarrayrequired- Array of signer objects. Each signer needs a name, emailAddress and signerType (Signer, Reviewer or InPersonSigner), and may carry signerOrder, authenticationType, deliveryMode and formFields that place signature, date or text fields on the document. Provide a JSON array of objects.
allowScheduledSendboolean- Set true to schedule the send for scheduledSendTime instead of sending immediately.
brandIdstring- ID of the brand to apply to the emails and signing pages, from boldsign_list_brands. Leave empty for the default brand.
ccarray- Array of objects, each with an emailAddress, for people who receive a copy of the completed document. Provide a JSON array of objects.
disableEmailsboolean- Set true to stop BoldSign from emailing signers, for example when signing happens inside your own app.
disableExpiryAlertboolean- Set true to stop expiry alert emails.
disableSMSboolean- Set true to stop BoldSign from sending SMS notifications to signers.
documentTimeZonestring- IANA-style time zone name used for dates on the document, for example Europe/London.
enableEmbeddedSigningboolean- Set true to allow signing inside your own app through boldsign_get_embedded_sign_link.
enablePrintAndSignboolean- Set true to let signers print, sign by hand and upload the document.
enableReassignboolean- Set true to let signers reassign the document to someone else.
enableSigningOrderboolean- Set true to make signers sign one after another in the order given by signerOrder.
expiryDaysinteger- Number of days until the signature request expires.
hideDocumentIdboolean- Set true to hide the document ID on the signed pages.
isSandboxboolean- Set true to create the document in sandbox mode, which is free and not legally binding.
labelsarray- Array of labels to tag the document with for later filtering.
messagestring- Message shown to signers in the signature request email.
metaDataobject- Object of custom string key-value pairs stored with the document.
onBehalfOfstring- Email address of the sender identity to act on behalf of. Leave empty to act as the API key owner.
reminderSettingsobject- Object that controls automatic reminders, with enableAutoReminder (boolean), reminderDays (days between reminders) and reminderCount (number of reminders).
scheduledSendTimeinteger- Unix timestamp in seconds at which to send the document. Requires allowScheduledSend true.
titlestring- Title shown in the signature request email and the BoldSign dashboard.
boldsign_send_document_from_templateSend a document for e-signature using a saved template and the people who fill its roles.WriteSend Document From Template
Send a document for e-signature using a saved template and the people who fill its roles. Returns the documentId of the new document. Use for repeatable documents such as NDAs. Use boldsign_send_document for ad hoc files.
Inputs
rolesarrayrequired- Array of role objects. Each has a roleIndex matching a template role, plus signerName and signerEmail, and optionally signerOrder, authenticationType and existingFormFields with prefilled values. Provide a JSON array of objects.
templateIdstringrequired- Template ID returned by boldsign_list_templates.
allowScheduledSendboolean- Set true to schedule the send for scheduledSendTime instead of sending immediately.
brandIdstring- ID of the brand to apply to the emails and signing pages, from boldsign_list_brands. Leave empty for the default brand.
ccarray- Array of objects, each with an emailAddress, for people who receive a copy of the completed document. Provide a JSON array of objects.
disableEmailsboolean- Set true to stop BoldSign from emailing signers, for example when signing happens inside your own app.
disableExpiryAlertboolean- Set true to stop expiry alert emails.
disableSMSboolean- Set true to stop BoldSign from sending SMS notifications to signers.
documentTimeZonestring- IANA-style time zone name used for dates on the document, for example Europe/London.
enablePrintAndSignboolean- Set true to let signers print, sign by hand and upload the document.
enableReassignboolean- Set true to let signers reassign the document to someone else.
enableSigningOrderboolean- Set true to make signers sign one after another in the order given by signerOrder.
expiryDaysinteger- Number of days until the signature request expires.
hideDocumentIdboolean- Set true to hide the document ID on the signed pages.
isSandboxboolean- Set true to create the document in sandbox mode, which is free and not legally binding.
labelsarray- Array of labels to tag the document with for later filtering.
messagestring- Message shown to signers in the signature request email.
metaDataobject- Object of custom string key-value pairs stored with the document.
onBehalfOfstring- Email address of the sender identity to act on behalf of. Leave empty to act as the API key owner.
reminderSettingsobject- Object that controls automatic reminders, with enableAutoReminder (boolean), reminderDays (days between reminders) and reminderCount (number of reminders).
removeFormFieldsarray- Array of form field IDs to remove from this document.
roleRemovalIndicesarray- Array of template role indices to leave out of this document.
scheduledSendTimeinteger- Unix timestamp in seconds at which to send the document. Requires allowScheduledSend true.
titlestring- Title of the document. Defaults to the template title.
boldsign_send_draft_documentSend a document that is currently in Draft status to its signers.WriteSend Draft Document
Send a document that is currently in Draft status to its signers. Returns an empty response on success. Use to send documents created as drafts. Use boldsign_send_document to create and send in one step.
Inputs
documentIdstringrequired- Document ID returned by boldsign_send_document or boldsign_list_documents.
boldsign_set_default_brandMake a brand the default brand used when documents are sent without a brandId.WriteSet Default Brand
Make a brand the default brand used when documents are sent without a brandId. Returns a message confirming the change. Use to change which brand applies by default. Use boldsign_list_brands to find the brandId.
- Idempotent
Inputs
brandIdstringrequired- ID of the brand to make the default.
boldsign_update_contactUpdate the name, email, phone, job title or company of an existing contact.WriteUpdate Contact
Update the name, email, phone, job title or company of an existing contact. Returns an empty response on success. Use to change a contact found with boldsign_list_contacts. Use boldsign_create_contacts to add new ones.
- Idempotent
Inputs
emailstringrequired- New email address of the contact.
namestringrequired- New name of the contact.
companyNamestring- New company name.
idstring- ID of the contact to update, from boldsign_list_contacts.
jobTitlestring- New job title.
phoneNumberobject- Object with countryCode and number for the contact phone.
boldsign_update_contact_groupRename a contact group or replace its members.WriteUpdate Contact Group
Rename a contact group or replace its members. Returns an empty response on success. Use to change a group found with boldsign_list_contact_groups.
- Idempotent
Inputs
groupIdstringrequired- ID of the group to update.
contactsarray- Array of member objects, each with a name and email. Replaces the current members. Provide a JSON array of objects.
directoriesarray- Array of directories the group belongs to.
groupNamestring- New name of the group.
boldsign_delete_brandDelete a brand.DestructiveDelete Brand
Delete a brand. Returns a message confirming the deletion. Use to remove unused brands. The default brand cannot be deleted.
- Idempotent
Inputs
brandIdstringrequired- ID of the brand to delete.
boldsign_delete_contactDelete a contact from the address book.DestructiveDelete Contact
Delete a contact from the address book. Returns an empty response on success. Use to remove stale contacts. Documents already sent are not affected.
- Idempotent
Inputs
idstringrequired- ID of the contact to delete, from boldsign_list_contacts.
boldsign_delete_contact_groupDelete a contact group.DestructiveDelete Contact Group
Delete a contact group. Returns an empty response on success. Use to remove unused groups. The contacts inside the group are kept.
- Idempotent
Inputs
groupIdstringrequired- ID of the group to delete.
boldsign_delete_custom_fieldDelete a custom form field.DestructiveDelete Custom Field
Delete a custom form field. Returns a message confirming the deletion. Use to remove unused custom fields. Use boldsign_list_custom_fields to find the customFieldId.
- Idempotent
Inputs
customFieldIdstringrequired- ID of the custom field to delete.
boldsign_delete_documentDelete a document, moving it to trash or removing it permanently.DestructiveDelete Document
Delete a document, moving it to trash or removing it permanently. Returns an empty response on success. Use to clean up documents. Use boldsign_revoke_document to stop signing without deleting.
- Idempotent
Inputs
documentIdstringrequired- Document ID returned by boldsign_send_document or boldsign_list_documents.
deletePermanentlyboolean- Set true to delete permanently instead of moving the document to trash.
boldsign_delete_sender_identityDelete a sender identity by email.DestructiveDelete Sender Identity
Delete a sender identity by email. Returns an empty response on success. Use to remove identities that are no longer in use.
- Idempotent
Inputs
emailstringrequired- Email address of the sender identity to delete.
boldsign_delete_templateDelete a template permanently.DestructiveDelete Template
Delete a template permanently. Returns an empty response on success. Use to remove templates that are no longer needed. Documents already sent from the template are not affected.
- Idempotent
Inputs
templateIdstringrequired- Template ID returned by boldsign_list_templates.
onBehalfOfstring- Email address of the sender identity to act on behalf of. Leave empty to act as the API key owner.
No tools match.
