View as Markdown
BoldSign icon

BoldSign ACTION

Send Document Using Template

Send documents for e-signature using a BoldSign template. See the documentation
  • Action
  • Writes data
  • OAuth
  • SDK
  • MCP

IMPLEMENTATION

Call this tool

Connect a user's BoldSign account once, then configure and run Send Document Using Template from your backend or agent.

import { PipedreamClient } from "@pipedream/sdk"

const pd = new PipedreamClient({
  projectId: process.env.PIPEDREAM_PROJECT_ID!,
  clientId: process.env.PIPEDREAM_CLIENT_ID!,
  clientSecret: process.env.PIPEDREAM_CLIENT_SECRET!,
  projectEnvironment: "production",
})

const result = await pd.actions.run({
  id: "boldsign-send-document-template",
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  configuredProps: {
    boldsign: { authProvisionId: "apn_xxxxxxx" },
    templateId: "Template ID",
    title: "Title",
  },
})

console.log(result)

SCHEMA

Inputs

Pipedream supplies the connected account. Your application provides the operation-specific values below. Dynamic inputs are resolved against that user's account.

Send Document Using Template inputs
Property Type Description
templateId Template ID string
The ID of the BoldSign template to use.
Required Dynamic
title Title string
The title of the document.
Optional
message Message string
A message to include with the document.
Optional
roles Roles string[]
A role is simply a placeholder for a real person. For example, if we have a purchase order that will always be signed by two people, one from the company and one from the customer, we can create a template with two roles Customer and Representative. Example: [{"roleIndex": 50,"signerName": "Richard","signerOrder": 1,"signerEmail": "richard@cubeflakes.com","privateMessage": "Please check and sign the document.","authenticationCode": "281028","enableEmailOTP": false,"signerType": "Signer","signerRole": "Manager","formFields": [{"id": "SignField","fieldType": "Signature","pageNumber": 1,"bounds": {"x": 100,"y": 100,"width": 100,"height": 50},"isRequired": true}].
Required
brandId Brand ID string
The brand ID for customizing the document.
Optional Dynamic
labels Labels string[]
Labels for categorizing documents.
Optional
disableEmails Disable Emails boolean
Disable sending emails to recipients.
Optional
disableSMS Disable SMS boolean
Disable sending SMS to recipients.
Optional
hideDocumentId Hide Document ID boolean
Decides whether the document ID should be hidden or not.
Optional
enableAutoReminder Enable Auto Reminder boolean
Enable automatic reminders.
Optional
reminderDays Reminder Days integer
Number of days between reminders.
Optional
reminderCount Reminder Count integer
Number of reminder attempts.
Optional
cc CC string[]
A list of CC recipients for the document.
Optional Dynamic
expiryDays Expiry Days integer
Number of days before document expires.
Optional
enablePrintAndSign Enable Print and Sign boolean
Allow signers to print and sign document.
Optional
enableReassign Enable Reassign boolean
Allow signers to reassign the document.
Optional
enableSigningOrder Enable Signing Order boolean
Enable signing order for the document.
Optional
disableExpiryAlert Disable Expiry Alert boolean
Disable alerts before document expiry.
Optional
documentInfo Document Info string[]
Custom information fields for the document. See the documentation for further information.
Optional
roleRemovalIndices Role Removal Indices integer[]
Removes the roles present in the template with their indices given in this property.
Optional
documentDownloadOption Document Download Option string
Option for document download configuration.
Optional
formGroups Form Groups string[]
Manages the rules and configuration of grouped form fields. See the documentation for further information.
Optional
files File Paths or URLs string[]
The files to upload. For each entry, provide either a file URL or path to a file in the /tmp directory (for example, /tmp/myFile.txt)
Optional
fileUrls File URLs string[]
URLs of files to include in the document.
Optional
recipientNotificationSettings Recipient Notification Settings object
Settings for recipient notifications. See the documentation for further information.
Optional
removeFormfields Remove Formfields string[]
The removeFormFields property in API allows you to exclude specific form fields from a document before sending it. You provide a string array with the IDs of the existing form fields you want to remove. One or more values can be specified.
Optional
enableAuditTrailLocalization Enable Audit Trail Localization boolean
Enable localization for audit trail based on the signer's language. If null is provided, the value will be inherited from the Business Profile settings. Only one additional language can be specified in the signer's languages besides English.
Optional
syncDir SyncDir dir
Optional

REFERENCE

Tool details

Behavior hints are published with the component in the Pipedream registry and surface as MCP tool annotations, so an agent can reason about a tool before it calls it.

Registry key
boldsign-send-document-template
Version
0.1.3
App
BoldSign
Authentication
OAuth
Read-only
No
Destructive
No
Open world
Yes