Skip to main content
Boldsign logo
  • Category: signatures
  • Auth: OAUTH2
  • Composio-managed OAuth available? Yes
  • Tools: 14
  • Triggers: 0
  • Slug: BOLDSIGN
  • Version: 20261101_00

Tools

Slug: BOLDSIGN_BRAND_GETTool to get brand details by brand ID. Use after obtaining the brand identifier.

Input Parameters

string
required
Unique identifier of the brand to fetch.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BOLDSIGN_BRAND_LISTTool to list all brands in the account. Use after confirming account is authenticated.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BOLDSIGN_CUSTOM_FIELD_CREATETool to create a brand-scoped custom field. Use when you need to define and register a new custom field for a specific brand.

Input Parameters

string
Brand identifier to associate the custom field.
string
required
Name of the custom field.
object
required
Custom form field definition.
string
required
Position/order of the custom field.
boolean
Whether the field is shared across the organization.
string
required
Description/info about the custom field.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BOLDSIGN_CUSTOM_FIELD_EDITTool to edit an existing custom field. Use when you need to update a custom field’s properties after creation.

Input Parameters

string
Brand identifier to associate the field
string
Name of the custom field
object
Custom form field settings as a JSON object, follow API spec for nested properties
string
Order/position of the custom field
boolean
Whether the field is shared across the organization
string
required
The ID of the custom field to edit
string
Description of the custom field

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BOLDSIGN_DOCUMENT_BEHALF_LISTTool to list documents sent on behalf of users. Use when fetching and filtering documents you’ve sent or on behalf of others.

Input Parameters

integer
Page number to retrieve (1-based). Default is 1.
array
Filter by document labels.
array
Filter by document status. One or more of: None, WaitingForMe, WaitingForOthers, NeedAttention, Completed, Declined, Revoked, Expired, Draft.
string
End of date range (ISO 8601 date-time string).
array
Filter by signer email address(es).
array
Filter by brand ID(s); applies to docs created on/after Oct 4, 2024.
integer
Number of items per page (1-100). Default is 10.
string ("BehalfOfOthers" | "BehalfOfMe")
Which documents to list: ‘BehalfOfOthers’ or ‘BehalfOfMe’. Default is ‘BehalfOfOthers’.
string
Keyword to search across title, document ID, sender or signer names.
string
Start of date range (ISO 8601 date-time string).
integer
Cursor for deep pagination beyond 10,000 records.
array
Filter by sender identity email address(es).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BOLDSIGN_DOCUMENT_EDIT_BETATool to edit a draft or sent document. Use when updating files, recipients, or document settings before finalizing the document.

Input Parameters

array
CC recipients list of objects with EmailAddress.
array
List of file edits (add/update/remove).
string
Document title (draft-only).
array
List of document labels (<=255 chars, no whitespace).
string
Apply brand by ID (draft-only).
string
Message for all recipients.
array
Signer edits (add/update/remove recipients).
object
Custom metadata key/value pairs.
boolean
Disable SMS notifications.
array
Group rule settings for form fields.
string
required
ID of the document to edit.
integer
Expiry value matching ExpiryDateType.
boolean
Convert text tags to fields.
array
Per-signer document settings.
boolean
Disable email notifications.
string ("Days" | "Hours" | "SpecificDateTime")
Expiry type unit.
boolean
Hide document ID in UI.
string
Custom download filename format.
object
Auto reminder configuration.
integer
Unix timestamp to schedule send; null sends immediately.
boolean
Enable signing order (draft-only).
array
List of text tag definition objects.
boolean
Localize audit trail.
object
Notification toggles for document recipients and CC.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BOLDSIGN_DOCUMENT_EXTEND_EXPIRYTool to extend a document’s expiry date. Use before signing to prolong a document’s deadline.

Input Parameters

boolean
Whether to send notification email one day before expiry. null uses existing setting; true enables notification; false disables.
string
Email of the user on whose behalf the request is made.
string
required
ID of the document to extend expiry for.
string
required
New expiry value for the document. Must not exceed 180 days from creation. Format depends on document’s default expiry type: ‘yyyy-MM-dd’ for days, integer hours (e.g., ‘12’) for hours, or ISO 8601 datetime for specific date/time (e.g., ‘2022-12-15T10:58:04.863Z’).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BOLDSIGN_DOCUMENT_LISTTool to list documents in My Documents with filters. Use when you need to fetch and filter documents based on various criteria.

Input Parameters

integer
Page number to retrieve (1-based). Default is 1.
array
Filter by document labels.
array
Filter by sender email address(es).
array
Filter by document status. One or more of: None, WaitingForMe, WaitingForOthers, NeedAttention, Completed, Declined, Revoked, Expired, Scheduled, Draft.
string
End of date range (ISO 8601 date-time string).
array
Filter by brand ID(s).
integer
Number of items per page (1 or more). Default is 10.
string
Keyword to search across title, document ID, sender or recipient names.
string
Start of date range (ISO 8601 date-time string).
integer
Cursor for deep pagination beyond 10,000 records.
array
Filter by recipient email address(es).
string ("Sent" | "Received" | "Both")
Filter by transmission type: ‘Sent’, ‘Received’, or ‘Both’.
string ("SentBetween" | "Expiring")
Filter documents by sent between dates or expiring date.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BOLDSIGN_DOCUMENT_REMOVE_AUTHENTICATIONRemove authentication for a specified signer on an existing document, with an optional signer order to distinguish roles sharing an email address.

Input Parameters

integer
Signer order in recipient list, used to target specific signer when multiple roles share same email.
string
required
Email address of the signer whose authentication is to be removed.
string
required
ID of the document from which to remove authentication.
string
Sender’s identity email when performing this action on behalf of another user.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BOLDSIGN_DOCUMENT_SENDTool to send a document for eSignature. Use when you need to deliver documents to recipients for signing.

Input Parameters

array
List of CC recipients
array
Base64-encoded files to send. Use either files or fileUrls, not both
string
required
Document title displayed in UI and emails
array
Tags for categorization; no spaces; max 255 chars each
string
Apply existing brand ID to document emails and pages
string
Message/instructions for all recipients
array
List of signers/recipients for the document
array
Public URLs to files to send. Use either files or fileUrls, not both
object
Custom key-value metadata (max 50 entries)
boolean
Disable document-related SMS messages
integer
Days until document expires
array
Rules for grouped form fields
string
Send on behalf of this email address
boolean
Convert text tags into BoldSign fields
array
Per-signer override settings for document metadata
boolean
Disable document-related emails
boolean
Hide the document ID in communications
boolean
Automatically detect fillable fields in files
string
Custom filename pattern for downloaded document
object
Configuration for automatic reminders.
integer
Unix timestamp for scheduling send (≥30 min in future)
ISO8601 datetime when generated signing link expires
boolean
Enforce sequential signing order
array
Definitions for text tag conversion
string
Download option: Combined or Individually
object
Toggle notifications for all recipients

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BOLDSIGN_DOCUMENT_TEAM_LISTList a page of team documents for a team or account admin, with optional filters.

Input Parameters

integer
Page number to retrieve (1-based). Default is 1.
array
Filter by document labels (tags).
array
Filter by document status. One or more of: None, WaitingForMe, WaitingForOthers, NeedAttention, Completed, Declined, Revoked, Expired, Draft.
array
Filter by team ID(s).
array
Filter by team user ID(s).
string
End of date range (ISO 8601 date-time string).
array
Filter by associated brand ID(s).
integer
Number of items per page. Default is 10.
string
Keyword to search across title, document ID, sender or recipient names.
string
Start of date range (ISO 8601 date-time string).
integer
Cursor for deep pagination beyond 10,000 records.
string ("Sent" | "Received" | "Both")
Transmission type: ‘Sent’, ‘Received’, or ‘Both’.
string ("SentBetween" | "Expiring")
Date filter type: SentBetween or Expiring.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BOLDSIGN_FILE_UPLOADHelper action to upload a file to R2 temp via the Composio file pipeline, returning a key that can be passed to FileUploadable fields in other actions (e.g., BrandLogo in brand create).

Input Parameters

string
required
Base64 encoded file content
string
required
MIME type of the file
string
required
Filename to use when uploading

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BOLDSIGN_PLAN_GET_API_CREDITS_COUNTTool to get remaining BoldSign API credits count. Use after authenticating your BoldSign account.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not