Skip to main content
Dropbox Sign logo
  • Category: signatures
  • Auth: API_KEY, OAUTH2
  • Composio-managed OAuth available? No
  • Tools: 56
  • Triggers: 0
  • Slug: DROPBOX_SIGN
  • Version: 20261101_00

Tools

Slug: DROPBOX_SIGN_ADD_USER_TO_TEAMTool to invite a user to your Team. Use when you need to add a member by email or account ID.

Input Parameters

string ("Member" | "Developer" | "Team Manager" | "Admin")
Role to assign to the invited user. Allowed values: Member, Developer, Team Manager, Admin.
string
The ID of the team to which the user will be invited.
string
The account ID of the user to invite. If provided, takes precedence over email_address.
string
The email address of the user to invite. Required if account_id is not provided.

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: DROPBOX_SIGN_ADD_USER_TO_TEMPLATETool to grant a specified account access to a template. Use when you need to share a template with another user after confirming template and account identifiers.

Input Parameters

string
ID of the account to grant access (must be 40 characters long). Takes precedence over email_address.
string
required
ID of the template to share
string
Email of the account to grant access. Ignored if account_id is provided.
boolean
If true, suppresses the email notification sent when sharing the template.

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: DROPBOX_SIGN_BULK_CREATE_EMBEDDED_SIG_REQ_WITH_TEMPLATETool to create a BulkSendJob for embedded templated signature requests. Use when you need to send up to 250 embedded signature requests at once via one or more templates for iFrame signing.

Input Parameters

array
CC recipients; required if template defines CC roles
string
Optional internal title for the job
string
Custom email message to signers
string
Custom email subject line
object
Up to 10 key/value pairs to be returned in events; keys ≤40 chars, values ≤1000 chars
string
required
Client ID of the application creating the embedded request
boolean
If true, the request is not legally binding
object
CSV file with signer data: columns name,email_address,optional pin,sms_phone_number, and any *_field for custom fields. Required unless signer_list is provided.
array
Structured list of signers and custom fields. Required unless signer_file is provided.
array
required
List of template IDs in the order they should be applied
boolean
Allow signers to decline the request
array
Global template merge fields to prefill
string
URL to redirect signers after signing completes

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: DROPBOX_SIGN_BULK_SEND_WITH_TEMPLATETool to create a BulkSendJob for templated signature requests. Use when you need to send up to 250 signature requests at once via one or more templates.

Input Parameters

array
CC recipients; required if template defines CC roles
string
Optional internal title for the job
string
Custom email message to signers
string
Custom email subject line
object
Up to 10 key/value pairs to be returned in events; keys ≤40 chars, values ≤1000 chars
string
API App client_id for branding and callbacks
boolean
If true, the request is not legally binding
object
CSV file with signer data: columns name,email_address,optional pin,sms_phone_number, and any *_field for custom fields. Required unless signer_list is provided.
array
Structured list of signers and custom fields. Required unless signer_file is provided.
array
required
List of template IDs in the order they should be applied
boolean
Allow signers to decline the request
array
Global template merge fields to prefill
string
URL to redirect signers after signing completes

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: DROPBOX_SIGN_CANCEL_SIGNATURE_REQUESTCancels an incomplete signature request. Use when you need to cancel a pending signature request that has not been completed. The operation is asynchronous and not reversible - once canceled, the signature request cannot be restored.

Input Parameters

string
required
The id of the SignatureRequest to cancel. Must be a valid signature request ID (40-character hexadecimal string). Note: This operation is asynchronous and not reversible.

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: DROPBOX_SIGN_CREATE_ACCOUNTTool to create a new Dropbox Sign account associated with a specified email address. Use when you need to programmatically register new users in the Dropbox Sign platform.

Input Parameters

string
The locale for the account. Defaults to ‘en_US’ if not specified.
string
Used for OAuth account creation. The Client ID for your API App.
string
Used for OAuth account creation. The Client Secret for your API App.
string
required
The email address which will be associated with the new Dropbox Sign 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
Slug: DROPBOX_SIGN_CREATE_API_APPTool to create a new Dropbox Sign API App. Use when you need to register a new application for API integration. The app will have a client_id for authentication and can be configured with OAuth, callbacks, and white labeling.

Input Parameters

string
required
The name to assign to the API App.
object
OAuth configuration for the API App.
array
required
List of domain names associated with the app (hostname only, without protocol). Use when the app will be accessed from specific domains.
object
Options for the API App.
string
URL where event callbacks will be sent. Use when you need to receive notifications about signature request events.
object
White labeling customization options for the API App.

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: DROPBOX_SIGN_CREATE_EMBEDDED_SIGNATURE_REQUESTTool to create an embedded signature request for signing in an iFrame. Use when you need to initiate a signature request that will be signed within your application rather than via email links.

Input Parameters

array
Document files to be signed (multipart upload). Use files or file_urls, not both.
string
Title displayed in the signature interface
string
Custom message included in signer emails
array
required
List of signer objects with name, email, and optional order
string
Email subject line for signature request
object
Up to 10 custom key/value metadata entries (keys <=40 chars, values <=1000 chars)
string
required
Client ID for embedded signing (must be exactly 32 characters). Get this from your API app settings at sign.dropbox.com
array
URLs to documents to be signed; Dropbox Sign will fetch. Use file_urls or files, not both.
boolean
Whether request operates in sandbox mode (default false)
integer
Unix timestamp when request expires; unsigned requests move to expired
array
Signer attachments to collect
boolean
Allow signers to decline (default false)
array
Custom field values for merge fields or text tags
object
Field formatting options.
boolean
Enable text tags parsing in documents
boolean
Allow signers to reassign (premium feature, default false)
boolean
Remove text tags in the final document
object
Signature creation method options.
array
Email addresses to CC on the request
boolean
Allow auto-fill fields to pre-populate signer info during signing

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: DROPBOX_SIGN_CREATE_EMBEDDED_SIGNATURE_REQUEST_WITH_TEMPLATECreates an embedded signature request using predefined templates and returns signature request details. A signing URL may be included in the response.

Input Parameters

array
CC recipients matching any CC roles in template
array
Binary file uploads; mutually exclusive with file_urls
string
Title for the signature request (max 255 chars)
string
Custom email message to signers (max 5000 chars)
array
required
Signer definitions matching template roles
string
Email subject to signers (max 255 chars)
object
Key/value metadata (≤10 keys, values ≤1000 chars)
string
required
Client ID of your Dropbox Sign app for embedded requests (must be exactly 32 characters)
array
URLs for Dropbox Sign to fetch file(s); mutually exclusive with files
boolean
If true, signature request is a non-legally binding test
array
required
One or more template IDs to use for the signature request
boolean
Allow signers to decline
array
Values for merge fields in template
object
Signing method options for signature requests.
boolean
If true, auto-fill fields are pre-populated during embedded signing

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: DROPBOX_SIGN_CREATE_EMBEDDED_TEMPLATE_DRAFTTool to create an embedded template draft. Use when initiating an embedded template workflow where users can edit the template in an iframe before finalizing it.

Input Parameters

array
List of PDF files to upload. Either files or file_urls must be provided.
string
Title for the template
string
Message to be included with the template
string
Subject line for the template
array
Array of CC role names
object
Key-value data to be returned in callbacks and webhooks
boolean
Allow users to add CC recipients when sending
string
required
Client ID from your API App. Required for embedded template workflow.
array
Array of publicly accessible URLs for PDF files. Either files or file_urls must be provided.
boolean
Whether this is a test (true for test, false for production)
boolean
Skip the current user in the signing order
array
Array of merge field objects
boolean
Show preview before sending
array
Array of signer role objects with name and order
boolean
Allow signers to reassign the signature request
boolean
Show progress stepper in the embedded UI
boolean
Enable to auto-detect fields from the document

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: DROPBOX_SIGN_CREATE_EMBEDDED_UNCLAIMED_DRAFT_WITH_TEMPLATETool to create an embedded unclaimed draft using saved templates. Use when you need to create a draft that can be claimed and embedded in an iFrame for signature collection.

Input Parameters

array
CC recipients; required if template defines CC roles
string
Optional internal title for the draft
string
Custom email message to signers
array
required
List of signers for the signature request; order and roles must match template requirements
string
Custom email subject line
object
Up to 10 key/value pairs to be returned in events; keys ≤40 chars, values ≤1000 chars
string
required
Client ID of the app used to create the draft; applies app branding and callback URL (must be exactly 32 characters)
boolean
If true, the request is not legally binding
boolean
Skip the current user’s signature step if they are a signer
boolean
Enable preview mode in the embedded editor
array
required
List of template IDs to use for creating the draft; must contain at least one template ID
boolean
Allow signers to decline the signature request
array
Template merge fields to prefill
object
Additional field-level options for form fields
object
Options to configure the embedded editor UI.
boolean
Force signers to use specific roles defined in template
string
URL to redirect signers after they successfully sign
boolean
Force use of subject and message from template
boolean
Show progress stepper; set to false to hide when only one step remains
boolean
If true, the resulting signature request will be signable in embedded mode
string
required
Email address of the requester who will be designated as the sender of the signature request
string
URL to redirect users after they successfully request a signature

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: DROPBOX_SIGN_CREATE_REPORTRequest creation of CSV report(s) for a specified date range. Reports are generated asynchronously and delivered via email. Available report types: user_activity (account activity), document_status (signature request status), sms_activity (SMS delivery info). You can request up to 2 report types per call. Date range can be up to 12 months, with start_date no more than 10 years in the past. Note: This feature may require a paid plan.

Input Parameters

string
required
Inclusive end date in MM/DD/YYYY format.
string
required
Inclusive start date in MM/DD/YYYY format. Date range may be up to 12 months; start_date must not be more than 10 years in the past.
array
required
Type(s) of report to create. Allowed values: ‘user_activity’, ‘document_status’, ‘sms_activity’. Up to two report types may be requested.

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: DROPBOX_SIGN_CREATE_TEMPLATETool to create a reusable template for document signing workflows. Use when you need to establish a template with pre-defined form fields, signer roles, and documents.

Input Parameters

array
PDF files to upload for the template. At least one file source (files or file_urls) required.
string
required
The template’s name
string
Email message body for signature requests
string
Email subject line for signature requests
array
CC recipient role names
object
Key-value metadata attached to the template (max 10 pairs)
string
Client account identifier for template association
array
URLs pointing to existing PDFs. At least one file source (files or file_urls) required.
boolean
Whether to create in test/sandbox mode
boolean
Skip creator from signing even if included in signer roles
array
Defines signer role names and signing order. Required if form fields reference signers.
boolean
Use pre-existing form fields from uploaded PDF if available
array
required
Required array of form field objects defining where and how fields appear. At least one field required.

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: DROPBOX_SIGN_CREATE_UNCLAIMED_DRAFTTool to create an unclaimed draft that can be claimed via a unique URL. Use when you need to prepare a signature request or document send that will be finalized later by someone else through the claim URL.

Input Parameters

string ("send_document" | "request_signature")
required
Draft type: ‘send_document’ allows document sending without signatures, ‘request_signature’ requires signers and enables signature collection
array
PDF/document files to upload; use files or file_urls, not both.
string
Custom message included in signature request email
array
Array of signer objects with name, email_address, and order; required when type is ‘request_signature’
string
Email subject line for the signature request
object
Custom key-value metadata (up to 10 pairs; keys ≤40 chars, values ≤1000 chars)
string
API app client ID for applying custom branding and callback URL
array
URLs pointing to documents for Dropbox Sign to fetch; use file_urls or files, not both.
boolean
If true, the draft/request will be in test mode and not legally binding
boolean
Allow signers to decline signing the request
boolean
Enable parsing of text tags in uploaded documents
boolean
Allow signers to reassign the signature request to another person
boolean
Remove text tags from final signed document if set to true
array
Conditional logic rules controlling field visibility based on other field values
array
Form field group definitions for organizing related fields together
array
Email addresses to receive a copy of all signer emails
string
URL to redirect signers after completing signature
boolean
Display progress stepper UI; set to false to hide
boolean
Set to true to enable auto-detection of merge fields from the document; only applicable for ‘send_document’ type
string
URL to redirect the requester after finalizing the draft (for embedded flows)
array
Predefined form field placements across uploaded documents; each entry defines fields for one document

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: DROPBOX_SIGN_DELETE_API_APPDeletes a Dropbox Sign API App owned by the requesting user, identified by client ID. A 404 response is treated as success, so an empty result does not confirm that an app was deleted.

Input Parameters

string
required
The client ID of the API App to delete. This must be an API App owned by the requesting 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: DROPBOX_SIGN_DELETE_FAXTool to delete a fax from the system by its fax_id. Use when you need to remove a fax from Dropbox Sign. Returns success if the fax is deleted or doesn’t exist.

Input Parameters

string
required
The ID of the Fax to delete from the system.

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: DROPBOX_SIGN_DELETE_TEMPLATEPermanently deletes a template from your Dropbox Sign account by its template_id. Once deleted, the template cannot be recovered. Use this when you need to remove outdated or unused templates. Returns success if template is deleted or doesn’t exist.

Input Parameters

string
required
The ID of the template to permanently delete.

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: DROPBOX_SIGN_DOWNLOAD_SIGNATURE_REQUEST_FILESDownload files for a signature request as PDF (merged) or ZIP (individual documents). Returns immediately if files are ready, or indicates if files are still being prepared (409 status).

Input Parameters

string ("pdf" | "zip")
Output format: ‘pdf’ for merged PDF or ‘zip’ for individual documents.
string
required
ID of the SignatureRequest to download documents for. Example: fa5c8a0b…967

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: DROPBOX_SIGN_EDIT_AND_RESEND_EMBEDDED_SIGNATURE_REQUESTTool to edit and resend an embedded signature request. Use when you need to modify and restart the embedded signing flow for an existing request.

Input Parameters

array
Files to upload; use files or file_urls, not both.
string
Title for the signature request
string
Custom message to signers
array
List of signer definitions; use signers or grouped_signers, not both.
string
Email subject for signers
object
Up to 10 custom key/value metadata entries (keys <=40 chars, values <=1000 chars)
string
required
Client ID for embedded signing (must be exactly 32 characters). Get this from your API app settings at sign.dropbox.com
array
URLs for files; Dropbox Sign will fetch. Use file_urls or files, not both.
boolean
If true, this is a test (non-binding) request
integer
Unix timestamp when request expires; unsigned requests move to expired
array
Signer attachments to collect
boolean
Allow signers to decline (default false)
array
Custom field values for merge fields or text tags
object
Request-level field options
boolean
Enable text tags parsing in documents
boolean
Allow signers to reassign (premium feature, default false)
boolean
Remove text tags in the final document
array
List of grouped signer definitions; use grouped_signers or signers, not both.
object
Allowed signature creation types
array
Email addresses to CC on the request
string
required
ID of the signature request to edit and resend (must be exactly 40 characters)
boolean
Allow auto-fill fields to pre-populate signer info during signing

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: DROPBOX_SIGN_EDIT_AND_RESEND_SIGNATURE_REQUESTEdits and resends an existing non-templated signature request with updated documents, signers, or settings. Use this tool when you need to modify an already-created signature request and resend it to signers. Note: This will reset signatures - anyone who already signed will need to sign again. Important: Edit and resend operations deduct from your signature request quota. Required: You must provide either ‘files’ or ‘file_urls’ (not both) and either ‘signers’ or ‘grouped_signers’ (not both).

Input Parameters

array
Files to upload; use files or file_urls, not both.
string
Title for the signature request
boolean
Require eID identity verification (premium feature)
string
Custom email message to signers
array
List of signer definitions; use signers or grouped_signers, not both.
string
Custom email subject line
object
Up to 10 custom key/value metadata entries (keys ≤40 chars, values ≤1000 chars)
string
API App client_id for branding and callbacks
array
URLs for files; Dropbox Sign will fetch. Use file_urls or files, not both.
boolean
If true, the request is not legally binding
integer
Unix timestamp when request expires
array
Signer attachments to collect
boolean
Allow signers to decline the request
array
Custom field values for merge fields or text tags
object
Request-level field options
boolean
Enable text tags parsing in documents
boolean
Allow signers to reassign (premium feature)
boolean
Remove text tags in the final document
array
List of grouped signer definitions; use grouped_signers or signers, not both.
object
Allowed signature creation types
array
Conditional logic rules for form fields
array
Definitions for form field groups referenced by fields
array
Email addresses to CC on the request
string
required
ID of the signature request to edit and resend
string
URL to redirect signers after signing completes
array
Form fields placement per document

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: DROPBOX_SIGN_EDIT_AND_RESEND_UNCLAIMED_DRAFTTool to edit and resend a previously created unclaimed draft. Use when you have an existing signature_request_id and want to modify the draft before reissuing.

Input Parameters

string
required
Client ID of the app used to create the draft; applies app branding and callback URL (must be exactly 32 characters)
boolean
If true, created request is not legally binding
object
Options for the built-in document editor while preparing the draft
string
required
ID of the signature request to edit and resend (must be exactly 40 characters)
string
URL to redirect signers after they successfully sign
boolean
Show progress stepper; set to false to hide when only one step remains
boolean
If true, the resulting request will be signable in embedded mode
string
Email to designate as the requester; defaults to the original requester if not set
string
URL to redirect users after they successfully request a signature

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: DROPBOX_SIGN_EDIT_RESEND_EMBEDDED_SIGNATURE_REQUEST_TEMPLATETool to edit and resend an embedded signature request using templates. Use when you need to update request details or recipients and resend within an embedded signing flow.

Input Parameters

array
CC recipients matching any CC roles in template
array
Binary file uploads; mutually exclusive with file_urls
string
Title for the signature request (max 255 chars)
string
Custom email message to signers (max 5000 chars)
array
required
Signer definitions matching template roles
string
Email subject to signers (max 255 chars)
object
Key/value metadata (≤10 keys, values ≤1000 chars)
string
required
Client ID of your HelloSign app for embedded requests (must be exactly 32 characters)
array
URLs for Dropbox Sign to fetch file(s); mutually exclusive with files
boolean
If true, signature request is a non-legally binding test
array
required
One or more template IDs in order
boolean
Allow signers to decline
array
Values for merge fields in template
object
Override account signing method options
string
required
The ID of the signature request to edit and resend (must be exactly 40 characters)
boolean
If true, auto-fill fields are pre-populated during embedded signing

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: DROPBOX_SIGN_GET_ACCOUNTRetrieves detailed information about a Dropbox Sign account including quotas, payment status, and settings. Use this tool to: - Check account quota limits (API requests, documents, templates remaining) - Verify account payment status (paid vs free tier) - Get account settings (SMS delivery, authentication options) - Retrieve account identifiers and contact information Requires either account_id (40-character identifier) or email_address, but not both.

Input Parameters

string
The ID of the account (must be exactly 40 characters). Provide either account_id or email_address, but not both.
string
The email address of the account. Provide either account_id or email_address, but not both.

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: DROPBOX_SIGN_GET_API_APPTool to retrieve information about an API App by its client ID. Use when you need to fetch API App configuration, OAuth settings, white labeling options, or owner details.

Input Parameters

string
required
The client ID of the API App to retrieve. This unique identifier is assigned when the app is created.

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: DROPBOX_SIGN_GET_BULK_SEND_JOBTool to retrieve the status of a bulk send job. Use when you need up-to-date job progress and request details.

Input Parameters

integer
Page number of the Bulk Send Job signature requests to return. Defaults to 1.
integer
Number of signature requests per page (1-100). Defaults to 20.
string
required
The ID of the Bulk Send Job to retrieve.

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: DROPBOX_SIGN_GET_CURRENT_TEAMRetrieve the authenticated user’s current team membership status and, when available, team details. Use this to check team membership and view information about team members and invitations.

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: DROPBOX_SIGN_GET_EMBEDDED_SIGN_URLRetrieves an embedded signing URL for a specific signer’s signature. Use this after creating an embedded signature request to get a temporary URL that can be embedded in an iFrame for the signer to complete signing. The URL expires after 60 minutes or upon first access, but you can generate a new URL anytime using the same signature_id. Note: Requires the signature_id (per signer), not the signature_request_id.

Input Parameters

string
required
The 32-character signature ID (not signature_request_id) obtained from creating an embedded signature request. Each signer has a unique signature_id.

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: DROPBOX_SIGN_GET_EMBEDDED_TEMPLATE_EDIT_URLTool to generate an edit URL for embedded template editing. Use after selecting or uploading a template to allow users to modify it in an iframe.

Input Parameters

array
List of CC role names; pass empty list to remove all CC roles.
boolean
Allow editing locked templates when in test mode.
string
required
ID of the template to generate an edit URL for.
array
Merge fields to prefill; pass empty list to clear all existing.
boolean
Preview-only mode with no adding fields; overrides show_preview.
boolean
Enable the editor preview experience.
boolean
Allow adding or changing CC roles during editing.
object
Options to configure the embedded template editor UI.
boolean
Allow users to review or edit signer roles before sending.
boolean
Allow users to review or edit email subject and message.
boolean
Show the progress stepper unless only one step remains.

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: DROPBOX_SIGN_GET_FAX_LINE_AREA_CODESTool to retrieve available fax line area codes for a given country, state/province, and city. Use when you need to determine which area codes are available for purchasing or provisioning a fax line in a specific location.

Input Parameters

string
Filter area codes by city name. Narrows results to a specific city within the selected state or province.
string ("AK" | "AL" | "AR" | "AZ" | "CA" | "CO" | "CT" | "DC" | "DE" | "FL" | "GA" | "HI" | "IA" | "ID" | "IL" | "IN" | "KS" | "KY" | "LA" | "MA" | "MD" | "ME" | "MI" | "MN" | "MO" | "MS" | "MT" | "NC" | "ND" | "NE" | "NH" | "NJ" | "NM" | "NV" | "NY" | "OH" | "OK" | "OR" | "PA" | "RI" | "SC" | "SD" | "TN" | "TX" | "UT" | "VA" | "VT" | "WA" | "WI" | "WV" | "WY")
US state codes.
string ("CA" | "US" | "UK")
required
Filter area codes by country. Required. Must be one of CA (Canada), US (United States), or UK (United Kingdom).
string ("AB" | "BC" | "MB" | "NB" | "NL" | "NT" | "NS" | "NU" | "ON" | "PE" | "QC" | "SK" | "YT")
Canadian province codes.

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: DROPBOX_SIGN_GET_SIGNATURE_REQUESTRetrieves the current status and complete details of a signature request by ID. Use this action to: - Check if signers have viewed, signed, or declined the request - Get signer information and signature timestamps - Access form field responses and custom field values - Retrieve URLs for document downloads and management - Monitor signature request progress and completion status Returns detailed information including signer names, emails, signing status, custom fields, response data, attachments, and signing options. Handles errors gracefully with structured error responses for invalid or non-existent signature request IDs.

Input Parameters

string
required
Unique identifier of the signature request to retrieve (40-character hex string). Obtain this ID from the response when creating a signature request or from the list signature requests endpoint.

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: DROPBOX_SIGN_GET_SIGNATURE_REQUEST_FILES_AS_DATA_URITool to download signature request files as a base64-encoded data URI. Use when you need the document content as a data URI string for embedding or transmission. Returns immediately if files are ready (status 200), or indicates if files are still being prepared (status 409).

Input Parameters

string
required
The ID of the SignatureRequest to retrieve files for as data URI. This is a 40-character hex string obtained when creating a signature request or from the list signature requests endpoint.

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: DROPBOX_SIGN_GET_SIGNATURE_REQUEST_FILES_AS_FILE_URLRetrieves a copy of the current documents and returns a JSON object with a URL to the file (PDFs only). Use this action when you need a temporary download link for signature request documents instead of downloading the files directly. The returned URL will expire after a certain time period indicated by the expires_at field.

Input Parameters

string
required
The ID of the SignatureRequest to retrieve files for (40-character hex string). Obtain this ID from the response when creating a signature request or from the list signature requests endpoint.

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: DROPBOX_SIGN_GET_TEAM_INFORetrieves information about a Dropbox Sign team, including team name, member count, and sub-team count. Use when you need to get team details. If team_id is provided, retrieves info for that specific team; otherwise retrieves info for the authenticated user’s team.

Input Parameters

string
The ID of the team to retrieve information for. Optional — if omitted, the API will return information for the authenticated user’s team.

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: DROPBOX_SIGN_GET_TEMPLATETool to return the specified template. Use when you need to fetch full template details by ID.

Input Parameters

string
required
The unique ID of the template to retrieve.

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: DROPBOX_SIGN_GET_TEMPLATE_FILESTool to download documents associated with a template. Use after confirming the template is created; returns a PDF or ZIP archive of the documents.

Input Parameters

string ("pdf" | "zip")
Format of the output: ‘pdf’ for merged PDF, ‘zip’ for individual docs in a ZIP archive.
string
required
ID of the HelloSign template to download documents for. Example: 3b2f1ac79dfc679ba07de7fa5f3c4e8a0c1b2d3e

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: DROPBOX_SIGN_GET_TEMPLATE_FILES_AS_DATA_URITool to retrieve template documents as base64-encoded data URI. Use when you need template files in data URI format instead of downloading binary files.

Input Parameters

string
required
The id of the Template to get files for. Example: f57db65d3f933b5316d398057a36176831451a35

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: DROPBOX_SIGN_GET_TEMPLATE_FILES_AS_FILE_URLTool to retrieve a copy of template documents and return a JSON object with a URL to the file (PDFs only). Use this action when you need a temporary download link for template documents instead of downloading the files directly.

Input Parameters

string
required
The ID of the template to retrieve files for. Obtain this ID from the response when creating a template or from the list templates endpoint.
integer
By default when opening the file_url a browser will download the PDF and save it locally. When set to 0 the PDF file will be displayed in the browser.

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: DROPBOX_SIGN_LIST_API_APPSTool to list API Apps. Use when you need to retrieve a paginated list of API Apps accessible to your account.

Input Parameters

integer
Page number to return; minimum 1; default is 1.
integer
Number of API Apps per page; minimum 1; maximum 100; default is 20.

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: DROPBOX_SIGN_LIST_BULK_SEND_JOBSList bulk send job summaries accessible to the authenticated user. Results are paginated; choose a page and a page size from 1 to 100, with defaults of page 1 and 20 jobs per page.

Input Parameters

integer
Page number of the Bulk Send Job list (default 1).
integer
Number of Bulk Send Jobs to return per page (1–100, default 20).

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: DROPBOX_SIGN_LIST_FAXESTool to list faxes and their properties. Use when you need to retrieve paginated faxes with information about transmissions and status.

Input Parameters

integer
Page number to return. Defaults to 1.
integer
Number of results per page (1–100). Defaults to 20.

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: DROPBOX_SIGN_LIST_FAX_LINESTool to list fax lines and their properties. Use when you need to retrieve available fax lines for an account, optionally paging or including team lines.

Input Parameters

integer
Page number to return. Defaults to 1.
integer
Number of results per page (1–100). Defaults to 20.
string
Filter fax lines to this account ID.
boolean
Include fax lines belonging to team members.

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: DROPBOX_SIGN_LIST_SIGNATURE_REQUESTSLists paginated signature requests with optional filters. HTTP errors are returned with an error message and an empty result list.

Input Parameters

integer
Page number to return.
string
Search string with optional fielded filters (e.g., ‘from:me AND complete:true’).
integer
Number of objects per page, between 1 and 100.
string
Team account to list requests for; use ‘all’ for all team members; defaults to your 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
Slug: DROPBOX_SIGN_LIST_SUB_TEAMSLists all sub-teams belonging to a parent team with pagination support. Returns team identifiers and names for each sub-team. Use this to discover the organizational structure of teams within Dropbox Sign. Requires a valid team_id from the parent team. Returns empty list if the team has no sub-teams or if team features are not available for the account.

Input Parameters

integer
Page number to return; minimum is 1; default is 1.
string
required
The unique identifier of the parent team whose sub-teams you want to list.
integer
Number of items per page; range is 1 to 100; default is 20.

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: DROPBOX_SIGN_LIST_TEAM_MEMBERSLists all members and their roles for a specific team. Returns a paginated list of team members with their account IDs, email addresses, and roles. Requires team_id which can be obtained from LIST_TEAMS or GET_TEAM_INFO actions. Supports pagination for teams with many members.

Input Parameters

integer
Page number to return (default is 1)
string
required
The ID of the team to retrieve members for
integer
Number of results per page (1-100, default is 20)

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: DROPBOX_SIGN_LIST_TEAMSLists the current Dropbox Sign team and its sub-teams, returning their IDs and names. An empty list is also returned when the current-team lookup receives HTTP 401, 402, or 404.

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: DROPBOX_SIGN_LIST_TEMPLATESTool to list templates. Use when you need to retrieve a paginated list of templates accessible to your account.

Input Parameters

integer
Page number to return; minimum 1; default is 1
string
Search string to filter templates; supports fielded queries per Search guide
integer
Number of templates per page; minimum 1; maximum 100; default is 20
string
Team member account to return templates for; use ‘all’ for all members; defaults to your 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
Slug: DROPBOX_SIGN_O_AUTH_AUTHORIZETool to generate an OAuth authorization URL. Use before directing the user to grant access.

Input Parameters

string
Optional space-delimited list of OAuth scopes. If omitted, default scopes for the app are used.
string
required
Opaque value used to maintain state between the request and callback. Must be unique per auth request.
string
Client ID of the Dropbox Sign API app. If not provided, the value from connection metadata will be used.
string
Optional redirect URI to which the OAuth server will send the user after authorization. Must match a configured callback URL if provided.

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: DROPBOX_SIGN_RELEASE_SIGNATURE_REQUEST_HOLDRelease a held signature request to send it to signers. Use this when a signature request was created from an unclaimed draft with hold_request=true and has been claimed but not yet sent. After releasing, the request will be sent to all designated signers.

Input Parameters

string
required
ID of the held Signature Request to release. Must be exactly 40 characters long.

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: DROPBOX_SIGN_REMOVE_USER_FROM_TEMPLATETool to remove an account’s access to a template. Use when you need to revoke a user’s permission on a template after confirming template ID and target account.

Input Parameters

string
ID of the account to revoke access (must be 40 characters long). Takes precedence over email_address.
string
required
ID of the template from which to remove access.
string
Email of the account to revoke access. Ignored if account_id is provided.

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: DROPBOX_SIGN_SEND_SIGNATURE_REQUESTTool to create and send a new signature request with documents. Use when you need to send documents for electronic signature. The action sends emails to all specified signers with links to view and sign the documents. Supports multiple signers, CC recipients, custom fields, form fields, and various signing options. Documents can be uploaded directly or provided via publicly accessible URLs.

Input Parameters

array
Files to be signed. Either files or file_urls is required.
string
Internal title for the signature request (not shown to signers)
string
Custom message included in the signature request email to signers
array
required
Array of signer objects. Each signer will receive an email to sign the document.
string
Subject line for the signature request email sent to signers
object
Custom metadata key/value pairs (up to 10 pairs). Keys max 40 chars, values max 1000 chars. Included in webhook callbacks.
array
URLs to remote documents to be signed (e.g., publicly accessible PDFs). Either files or file_urls is required.
boolean
Create signature request in test mode (not legally binding, free). Use for testing integrations.
boolean
Allow signers to decline signing the document
array
Pre-filled merge fields for the signature request
boolean
Enable text tag parsing in documents. Text tags are special formatted strings that define form fields.
boolean
Allow signers to reassign the signature request to another person
boolean
Hide text tags from document after parsing. Only applies when use_text_tags is true.
array
CC recipients who will receive a copy when the signature request is completed
string
URL to redirect signers to after they complete signing
array
Form field definitions for each document. Outer list corresponds to documents, inner list contains fields for that document.

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: DROPBOX_SIGN_SEND_SIGNATURE_REQUEST_REMINDERSends an email reminder to a signer about a pending signature request. Use this when a signer needs a reminder to complete their signature. Important constraints: - Cannot send a reminder within 1 hour of the last reminder (automatic or manual) - Cannot be used with embedded signature requests - The signature request must exist and not be completed - The email address must match a signer on the request

Input Parameters

string
Name of the signer. Required only when multiple signers on the request share the same email address, to disambiguate which signer to remind.
string
required
Email address of the signer who should receive the reminder. Must match an existing signer on the signature request.
string
required
The unique ID of the signature request (40-character hexadecimal string). Get this from list or get signature request endpoints.

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: DROPBOX_SIGN_UPDATE_ACCOUNTTool to update Dropbox Sign account properties and settings. Use when you need to modify callback URLs or locale settings for an account.

Input Parameters

string
The locale used in the account (e.g., ‘en_US’, ‘de_DE’, ‘fr_FR’).
string
The ID of the account to update (must be exactly 40 characters).
string
The URL that Dropbox Sign should POST events to. Set to empty string to remove.

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: DROPBOX_SIGN_UPDATE_API_APPTool to update an existing API App in Dropbox Sign. Use when you need to modify API App settings such as name, callback URL, domains, OAuth configuration, branding options, or custom logo.

Input Parameters

string
Name to assign to the API App
object
OAuth configuration for API App
array
Domain names associated with the app
object
Options configuration for API App
string
required
The client ID of the API App to update
string
URL where the API App receives event callbacks
object
An image file to use as a custom logo in embedded contexts.
object
White labeling customization options for API App

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: DROPBOX_SIGN_UPDATE_SIGNATURE_REQUESTUpdates the email address and/or name for a specific signer on a signature request. Use this when you need to correct or update signer contact information before they complete signing. Important: This endpoint only works for signature requests created with explicit form_fields_per_document (no appended signature page). At least one of email_address or name must be provided.

Input Parameters

string
New name for the signer. Provide this and/or email_address to update.
string
required
The signature ID for the signer whose information should be updated. Get this from the signatures list in the signature request object.
string
New email address for the signer. Must be a valid email format. Provide this and/or name to update.
string
required
The unique ID of the signature request to update (40-character hexadecimal string). Get this from list or get signature request endpoints.

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: DROPBOX_SIGN_UPDATE_TEMPLATE_FILESTool to update files for an existing template. Overlays new files with the overlay of an existing template. Use when you need to replace the documents in a template while keeping the field configuration. The update is processed asynchronously; completion is communicated via callback events (template_created or template_error).

Input Parameters

array
Files to upload for the template. Use either files or file_urls, not both.
string
The new default template email message.
string
The new default template email subject.
string
Client ID of the app you are using to update the template.
array
URLs for files to use for the template. Dropbox Sign will download these files. Use either file_urls or files, not both.
boolean
Whether this is a test. Signatures will not be legally binding if set to true. Defaults to false.
string
required
The ID of the template to update files for.

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: DROPBOX_SIGN_VERIFY_ACCOUNTTool to verify whether a Dropbox Sign account exists for the given email. Use when you need to check account existence before sending signature requests.

Input Parameters

string
required
Email address to verify for a Dropbox Sign 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