The Dropbox Sign connector lets your AI agent act in each user's Dropbox Sign account. Each user connects their own Dropbox Sign API key once, and Scalekit sends it with every call, so your agent never handles credentials. It comes with 39 tools.
- Tools
- 39
- What they doRead · write · destructive
- 20 · 15 · 420 read15 write4 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 Dropbox Sign connection
In AgentKit > Connections, create a Dropbox Sign connection. The name you give it is the
connection_nameyour code passes. See Configure connections.
Tools
Pass the exact name toexecute_tooldropboxsign_account_getGet a Dropbox Sign account's details and quotas.Read-onlyGet Account
Get a Dropbox Sign account's details and quotas. Returns account_id, email_address, role_code, team_id, quotas, usage, and the is_paid_hs / is_paid_hf plan flags. Use it with no inputs to identify the connected account, or pass an account ID or email to look up a team member. Use dropboxsign_account_verify to check whether an email has any Dropbox Sign account.
Inputs
account_idstring- ID of the account to return. Leave empty (and email_address empty) to get the connected account. If both are set, account_id wins. Example: "5008b25c7f67153e57d5a357b1687968068fb465".
email_addressstring- Email address of the account to return. Leave empty (and account_id empty) to get the connected account. Example: "jane@example.com".
dropboxsign_bulk_send_job_getGet one bulk send job and a page of the signature requests it created.Read-onlyGet Bulk Send Job
Get one bulk send job and a page of the signature requests it created. Returns bulk_send_job, signature_requests with each signer's status, and list_info for paging. Use it to track a bulk send. Use dropboxsign_bulk_send_jobs_list to find job IDs.
Inputs
bulk_send_job_idstringrequired- ID of the bulk send job, from dropboxsign_bulk_send_jobs_list. Example: "6e683bc0369ba3d5b6f43c2c22a8031dbf6bd174".
pageinteger- Page number of results to return, starting at 1. Defaults to 1. Use list_info.num_pages in the response to see how many pages exist. Example: 2.
page_sizeinteger- Number of results per page, between 1 and 100. Defaults to 20. Example: 50.
dropboxsign_bulk_send_jobs_listList bulk send jobs you can access.Read-onlyList Bulk Send Jobs
List bulk send jobs you can access. Returns bulk_send_jobs (bulk_send_job_id, total, is_creator, created_at) and list_info for paging. Use it to find a bulk send job. Use dropboxsign_bulk_send_job_get to see the signature requests inside one job.
Inputs
pageinteger- Page number of results to return, starting at 1. Defaults to 1. Use list_info.num_pages in the response to see how many pages exist. Example: 2.
page_sizeinteger- Number of results per page, between 1 and 100. Defaults to 20. Example: 50.
dropboxsign_fax_getGet one fax by ID.Read-onlyGet Fax
Get one fax by ID. Returns fax with title, sender, files_url and transmissions (recipient, status_code, sent_at). Use it to check delivery of a fax sent with dropboxsign_fax_send. Use dropboxsign_faxes_list to find IDs.
Inputs
fax_idstringrequired- ID of the fax. Get it from dropboxsign_faxes_list or the response of dropboxsign_fax_send. Example: "fa5c8a0b0f492d768749333ad6fcc214c111e967".
dropboxsign_fax_line_getGet one fax line by its number.Read-onlyGet Fax Line
Get one fax line by its number. Returns fax_line with number, created_at, updated_at and the accounts that can use it. Use it to check who can use a line. Use dropboxsign_fax_lines_list to see all lines.
Inputs
numberstringrequired- The fax line number, in E.164 format. Example: "+14155550199".
dropboxsign_fax_lines_listList the fax lines (numbers) on the account.Read-onlyList Fax Lines
List the fax lines (numbers) on the account. Needs the Dropbox Fax API. Returns fax_lines (number, created_at, accounts that can use the line) and list_info for paging. Use it to find a sender number for dropboxsign_fax_send. Use dropboxsign_fax_line_get for one line.
Inputs
account_idstring- Only list fax lines for this account ID. Example: "5008b25c7f67153e57d5a357b1687968068fb465".
pageinteger- Page number of results to return, starting at 1. Defaults to 1. Use list_info.num_pages in the response to see how many pages exist. Example: 2.
page_sizeinteger- Number of results per page, between 1 and 100. Defaults to 20. Example: 50.
show_team_linesboolean- Set to true to include fax lines that belong to your team members. Example: true.
dropboxsign_faxes_listList faxes sent and received on the account.Read-onlyList Faxes
List faxes sent and received on the account. Needs the Dropbox Fax API. Returns faxes (fax_id, title, sender, created_at, transmissions with each recipient's status_code) and list_info for paging. Use it to browse faxes. Use dropboxsign_fax_get for one fax by ID.
Inputs
pageinteger- Page number of results to return, starting at 1. Defaults to 1. Use list_info.num_pages in the response to see how many pages exist. Example: 2.
page_sizeinteger- Number of results per page, between 1 and 100. Defaults to 20. Example: 50.
dropboxsign_signature_request_files_data_uri_getGet a signature request's documents as one PDF, base64-encoded in a data URI.Read-onlyGet Signature Request PDF Data
Get a signature request's documents as one PDF, base64-encoded in a data URI. Returns data_uri (data:application/pdf;base64,...), which can be large. Use it when you need the file content itself. Use dropboxsign_signature_request_files_url_get for a smaller response with a download link. Returns HTTP 409 while files are still being prepared; retry later.
Inputs
signature_request_idstringrequired- ID of the signature request. Get it from dropboxsign_signature_requests_list or from the response of a send tool. Example: "fa5c8a0b0f492d768749333ad6fcc214c111e967".
dropboxsign_signature_request_files_url_getGet a temporary download URL for a signature request's documents as one PDF.Read-onlyGet Signature Request PDF URL
Get a temporary download URL for a signature request's documents as one PDF. Returns file_url and expires_at (Unix time when the URL stops working). Use it to share or fetch the signed PDF. Use dropboxsign_signature_request_files_data_uri_get to get the PDF content inline instead. Returns HTTP 409 while files are still being prepared; retry later.
Inputs
signature_request_idstringrequired- ID of the signature request. Get it from dropboxsign_signature_requests_list or from the response of a send tool. Example: "fa5c8a0b0f492d768749333ad6fcc214c111e967".
force_downloadinteger- Set to 0 to make the returned file_url open the PDF in the browser instead of downloading it. Defaults to 1 (download). Example: 0.one of
01
dropboxsign_signature_request_getGet one signature request by ID.Read-onlyGet Signature Request
Get one signature request by ID. Returns the request's title, status flags, metadata, files_url, and signatures with each signer's signature_id, status_code and signed_at. Use it to check progress or to get a signer's signature_id for dropboxsign_signature_request_update. Use dropboxsign_signature_requests_list to find IDs.
Inputs
signature_request_idstringrequired- ID of the signature request. Get it from dropboxsign_signature_requests_list or from the response of a send tool. Example: "fa5c8a0b0f492d768749333ad6fcc214c111e967".
dropboxsign_signature_requests_listList signature requests you sent or received, newest first, with optional search.Read-onlyList Signature Requests
List signature requests you sent or received, newest first, with optional search. Returns signature_requests (signature_request_id, title, is_complete, is_declined, signatures with each signer's status_code) and list_info for paging. Use it to browse or search by title, signer, status or date. Use dropboxsign_signature_request_get for one request by ID.
Inputs
account_idstring- Whose signature requests to return. Pass a team member's account ID, or "all" for every team member. Defaults to your own account. Get account IDs from dropboxsign_team_get. Example: "all".
pageinteger- Page number of results to return, starting at 1. Defaults to 1. Use list_info.num_pages in the response to see how many pages exist. Example: 2.
page_sizeinteger- Number of results per page, between 1 and 100. Defaults to 20. Example: 50.
querystring- Search terms in Dropbox Sign search syntax: field:value pairs joined with AND or OR (case-sensitive). Fields include to, from, title, subject, message, metadata, filename, created (date range), complete, declined, expired, awaiting_my_signature, test_mode and template. A bare word searches to, from, title, subject, message, metadata and filename. Examples: "complete:true", "title:NDA AND from:me", "created:[2024-01-01 TO 2024-12-31]".
dropboxsign_sub_teams_listList the sub teams of a team.Read-onlyList Sub Teams
List the sub teams of a team. Returns sub_teams (team_id, name) and list_info for paging. Use it to walk a team hierarchy. Use dropboxsign_team_members_list for a team's members.
Inputs
team_idstringrequired- ID of the team whose sub teams to list. Get your team's ID from dropboxsign_account_get (account.team_id) or dropboxsign_team_info_get, and sub team IDs from dropboxsign_sub_teams_list. Example: "4fea99bfcf2b26bfccf6cea3e127fb8bb74d8d9c".
pageinteger- Page number of results to return, starting at 1. Defaults to 1. Use list_info.num_pages in the response to see how many pages exist. Example: 2.
page_sizeinteger- Number of results per page, between 1 and 100. Defaults to 20. Example: 50.
dropboxsign_team_getGet your team and its members.Read-onlyGet Team
Get your team and its members. Returns team with name, accounts (account_id, email_address, role_code), invited_accounts and invited_emails. Use it to find team members' account IDs. Returns 404 not_found if the account is not on a team. Use dropboxsign_team_info_get for a team's ID and member counts.
Inputs
This tool takes no inputs.
dropboxsign_team_info_getGet a team's details by ID.Read-onlyGet Team Info
Get a team's details by ID. Returns team_id, name, num_members and num_sub_teams. Use it to look up a parent or sub team. Use dropboxsign_team_get for your own team and its member list.
Inputs
team_idstring- ID of the team. Leave empty for your own team. Example: "4fea99bfcf2b26bfccf6cea3e127fb8bb74d8d9c".
dropboxsign_team_invites_listList pending invitations to join a team.Read-onlyList Team Invites
List pending invitations to join a team. Returns team_invites (email_address, team_id, role, sent_at, redeemed_at, expires_at). Use it to see who has been invited. Pass email_address to see the invites sent to one person.
Inputs
email_addressstring- Email address whose invites to list. Leave empty for the connected account's invites. Example: "jane@example.com".
dropboxsign_team_members_listList the members of a team and their roles.Read-onlyList Team Members
List the members of a team and their roles. Returns team_members (account_id, email_address, role) and list_info for paging. Use it to page through a large team. Use dropboxsign_team_get for your own team in one call.
Inputs
team_idstringrequired- ID of the team whose members to list. Get your team's ID from dropboxsign_account_get (account.team_id) or dropboxsign_team_info_get, and sub team IDs from dropboxsign_sub_teams_list. Example: "4fea99bfcf2b26bfccf6cea3e127fb8bb74d8d9c".
pageinteger- Page number of results to return, starting at 1. Defaults to 1. Use list_info.num_pages in the response to see how many pages exist. Example: 2.
page_sizeinteger- Number of results per page, between 1 and 100. Defaults to 20. Example: 50.
dropboxsign_template_files_data_uri_getGet a template's documents as one PDF, base64-encoded in a data URI.Read-onlyGet Template PDF Data
Get a template's documents as one PDF, base64-encoded in a data URI. Returns data_uri (data:application/pdf;base64,...), which can be large. Use it when you need the file content itself. Use dropboxsign_template_files_url_get for a smaller response with a download link. Returns HTTP 409 while a new template's files are still being prepared; retry later.
Inputs
template_idstringrequired- ID of the template. Get it from dropboxsign_templates_list. Example: "f57db65d3f933b5316d398057a36176831451a35".
dropboxsign_template_files_url_getGet a temporary download URL for a template's documents as one PDF.Read-onlyGet Template PDF URL
Get a temporary download URL for a template's documents as one PDF. Returns file_url and expires_at (Unix time when the URL stops working). Use it to review a template's documents. Use dropboxsign_template_files_data_uri_get to get the PDF content inline instead. Returns HTTP 409 while a new template's files are still being prepared; retry later.
Inputs
template_idstringrequired- ID of the template. Get it from dropboxsign_templates_list. Example: "f57db65d3f933b5316d398057a36176831451a35".
force_downloadinteger- Set to 0 to make the returned file_url open the PDF in the browser instead of downloading it. Defaults to 1 (download). Example: 0.one of
01
dropboxsign_template_getGet one template by ID.Read-onlyGet Template
Get one template by ID. Returns the template's title, signer_roles, cc_roles, documents with their form fields, custom_fields (merge fields) and accounts it is shared with. Use it to learn the role names and merge fields to pass to dropboxsign_signature_request_send_with_template. Use dropboxsign_templates_list to find IDs.
Inputs
template_idstringrequired- ID of the template. Get it from dropboxsign_templates_list. Example: "f57db65d3f933b5316d398057a36176831451a35".
dropboxsign_templates_listList templates you can use, with optional search.Read-onlyList Templates
List templates you can use, with optional search. Returns templates (template_id, title, signer_roles, cc_roles, custom_fields, documents) and list_info for paging. Use it to find a template to send. Use dropboxsign_template_get for one template by ID.
Inputs
account_idstring- Whose templates to return. Pass a team member's account ID, or "all" for every team member. Defaults to your own account. Get account IDs from dropboxsign_team_get. Example: "all".
pageinteger- Page number of results to return, starting at 1. Defaults to 1. Use list_info.num_pages in the response to see how many pages exist. Example: 2.
page_sizeinteger- Number of results per page, between 1 and 100. Defaults to 20. Example: 50.
querystring- Search terms in Dropbox Sign search syntax: field:value pairs joined with AND or OR (case-sensitive). Template fields include title, message, metadata, filename, owner (email) and created (date range). A bare word searches all text fields. Examples: "title:NDA", "owner:jane@example.com".
dropboxsign_account_verifyCheck whether a Dropbox Sign account exists for an email address.WriteVerify Account
Check whether a Dropbox Sign account exists for an email address. Returns account.email_address when an account exists; account is absent when it does not. Use it before inviting or sharing with someone. Use dropboxsign_account_get to read the full account details.
- Idempotent
Inputs
email_addressstringrequired- Email address to check. Example: "jane@example.com".
dropboxsign_document_fields_detectFind form fields in a PDF, given by public URL, from its PDF form annotations or Dropbox Sign text tags.WriteDetect Document Fields
Find form fields in a PDF, given by public URL, from its PDF form annotations or Dropbox Sign text tags. Returns detection_result with page_count and form_fields_per_document (each field's type, page, position, size and signer), plus any errors. Use it to build form_fields_per_document for dropboxsign_signature_request_send or dropboxsign_template_create from fields already in the PDF.
Inputs
detection_modestringrequired- annotations detects PDF form fields; text_tags detects Dropbox Sign text tags such as [sig|req|signer1]. Example: "annotations".one of
annotationstext_tags file_urlstringrequired- Public URL of the PDF to analyze. Example: "https://www.example.com/contracts/nda.pdf".
page_rangestring- Zero-based pages to analyze: all, single pages, ranges, or a comma-separated mix. Defaults to all. Example: "0-2,5".
dropboxsign_fax_sendSend a fax of one or more documents, given by public URL.WriteSend Fax
Send a fax of one or more documents, given by public URL. Needs the Dropbox Fax API. Returns fax with its fax_id and transmissions showing the recipient's status_code. Use it to fax documents to a number or email. Use dropboxsign_fax_get to check delivery.
Inputs
file_urlsarrayrequired- Public URLs of the documents to fax. Dropbox Sign downloads each file, so the URLs must be reachable without login. PDF, Word, images and other common formats are accepted. Example: ["https://www.example.com/contracts/nda.pdf"].
recipientstringrequired- Fax number in E.164 format, or an email address. Example: "+14155550123".
cover_page_fromstring- Sender details for the cover page. Example: "Jane Doe, Example Inc".
cover_page_messagestring- Message printed on the cover page. Example: "Please see the attached lease.".
cover_page_tostring- Recipient details for the cover page. Example: "Jack Smith, Acme Corp".
senderstring- Your fax line number to send from, in E.164 format. Used only when faxing to a number. Get numbers from dropboxsign_fax_lines_list. Example: "+14155550199".
test_modeboolean- Set to true to send the fax in API test mode. Defaults to false. Example: true.
titlestring- Title of the fax. Example: "Signed lease".
dropboxsign_signature_request_editReplace the documents, signers and settings of a pending signature request and resend it.WriteEdit Signature Request
Replace the documents, signers and settings of a pending signature request and resend it. Returns the updated signature_request. Use it to correct a sent request without cancelling it. Use dropboxsign_signature_request_update to change only a signer's email or name. Editing uses a signature request from your quota.
- Idempotent
Inputs
file_urlsarrayrequired- Public URLs of the documents to send for signature. Dropbox Sign downloads each file, so the URLs must be reachable without login. PDF, Word, images and other common formats are accepted. Example: ["https://www.example.com/contracts/nda.pdf"].
signature_request_idstringrequired- ID of the signature request. Get it from dropboxsign_signature_requests_list or from the response of a send tool. The request must not be fully signed yet. Example: "fa5c8a0b0f492d768749333ad6fcc214c111e967".
signersarrayrequired- People who must sign, in signing order if you set order. Each signer needs a name and an email_address. You can also set order (0-based position when signing in sequence), a pin (4 to 12 character access code the signer must enter) and an sms_phone_number in E.164 format with sms_phone_number_type authentication (default) or delivery. Example: [{"name": "Jack Smith", "email_address": "jack@example.com", "order": 0}, {"name": "Jill Lee", "email_address": "jill@example.com", "order": 1}].
allow_declineboolean- Set to true to let signers decline to sign. Defaults to false. Example: true.
allow_reassignboolean- Set to true to let signers reassign their part to someone else. Premium plan and higher only. Defaults to false. Example: false.
attachmentsarray- Files signers must or may upload while signing. Each item needs a name and the signer_index (0-based position in signers); you can add instructions and set required to true. Example: [{"name": "Photo ID", "signer_index": 0, "instructions": "Upload a photo of your ID", "required": true}].
cc_email_addressesarray- Email addresses to copy on the request. CCs get the completed documents but do not sign. Example: ["legal@example.com"].
client_idstring- Client ID of one of your Dropbox Sign API apps. Applies that app's branding and callback URL to the request. Example: "b6b8e7deaf8f0b95c029dca049356d4a2cf9710a".
custom_fieldsarray- Values that pre-fill merge fields in the documents. Each item needs the name of the merge field and the value to fill in. To let a signer edit a pre-filled value, set editor to that signer's role and optionally required to true. Works with merge fields or text tags in the documents. Example: [{"name": "Cost", "value": "$20,000"}].
expires_atinteger- When the request expires, as a Unix timestamp in seconds. Unsigned signatures then move to expired and can no longer be signed. Example: 1735689600.
field_optionsobject- Date format for date fields, as an object with date_format set to one of "MM / DD / YYYY", "MM - DD - YYYY", "DD / MM / YYYY", "DD - MM - YYYY", "YYYY / MM / DD" or "YYYY - MM - DD". Example: {"date_format": "DD - MM - YYYY"}.
form_fields_per_documentarray- Fields to place on the documents, one object per field. Each field needs document_index (0-based position in file_urls), a unique api_id, a type (text, checkbox, signature, date_signed, initials, radio, dropdown, text-merge, checkbox-merge or hyperlink), required (true or false), the signer, and its position and size in pixels (x, y, width, height). Set page to place it on a specific page. signer is the 0-based index of the signer in the signers list, as a string; use "me_now" for a field the sender fills now, and "sender" for text-merge or checkbox-merge fields. If you leave this out, Dropbox Sign adds a signature page for all signers. Text, dropdown, checkbox, radio and hyperlink fields take extra settings; see the form fields guide. Example: [{"document_index": 0, "api_id": "sig1", "name": "Signature", "type": "signature", "required": true, "signer": "0", "x": 100, "y": 600, "width": 200, "height": 30, "page": 1}].
hide_text_tagsboolean- Set to true to remove text tags from the final documents automatically. This can clip nearby content, so the vendor recommends hiding tags with white text instead. Defaults to false. Example: false.
is_eidboolean- Set to true to require signers to verify their identity with electronic identification (eID). Needs an eID-enabled plan and test_mode false. Defaults to false. Example: false.
messagestring- Custom message included in the email sent to signers. Example: "Hi Jack, please review and sign by Friday.".
metadataobject- Your own key-value data to attach, returned in every API response and event for this request. Up to 10 keys; keys up to 40 characters, values up to 1000 characters. Example: {"customer_id": "1234", "deal": "Acme renewal"}.
signing_optionsobject- Which ways signers can create their signature. default_type is required and is one of draw, phone, type or upload; set draw, phone, type and upload to true or false to allow each method. If not set, your account's settings apply. Example: {"default_type": "draw", "draw": true, "type": true, "upload": false, "phone": false}.
signing_redirect_urlstring- URL signers are sent to after they finish signing. Example: "https://www.example.com/thanks".
subjectstring- Subject line of the signature request email sent to signers. Example: "Please sign the NDA".
test_modeboolean- Set to true to make the signature request a test that is not legally binding. Use it while trying out a workflow. Defaults to false. Example: true.
titlestring- Title of the signature request, shown in Dropbox Sign and used in search. Example: "NDA with Acme".
use_text_tagsboolean- Set to true to turn text tags in the documents (for example [sig|req|signer1]) into fields. Defaults to false. Example: true.
dropboxsign_signature_request_edit_with_templateRebuild a pending signature request from one or more templates and resend it.WriteEdit Signature Request With Template
Rebuild a pending signature request from one or more templates and resend it. Returns the updated signature_request. Use it to correct a template-based request. Use dropboxsign_signature_request_edit for ad hoc documents. Editing uses a signature request from your quota.
- Idempotent
Inputs
signature_request_idstringrequired- ID of the signature request. Get it from dropboxsign_signature_requests_list or from the response of a send tool. The request must not be fully signed yet. Example: "fa5c8a0b0f492d768749333ad6fcc214c111e967".
signersarrayrequired- One signer per signer role defined in the template(s). Each item needs the role (must match a template role exactly, case-sensitive), the signer's name and email_address. You can also set a pin access code and an sms_phone_number. Get the role names from dropboxsign_template_get (template.signer_roles). Example: [{"role": "Client", "name": "Jack Smith", "email_address": "jack@example.com"}].
template_idsarrayrequired- IDs of the templates to use, in the order their documents should appear. Get them from dropboxsign_templates_list. Example: ["f57db65d3f933b5316d398057a36176831451a35"].
allow_declineboolean- Set to true to let signers decline to sign. Defaults to false. Example: true.
ccsarray- People to copy on the request, one per CC role defined in the template. Each item needs the role (must match a template CC role) and an email_address. Required when the template has a CC role. Example: [{"role": "Accounting", "email_address": "accounting@example.com"}].
client_idstring- Client ID of one of your Dropbox Sign API apps. Applies that app's branding and callback URL to the request. Example: "b6b8e7deaf8f0b95c029dca049356d4a2cf9710a".
custom_fieldsarray- Values that pre-fill merge fields in the documents. Each item needs the name of the merge field and the value to fill in. To let a signer edit a pre-filled value, set editor to that signer's role and optionally required to true. Required when the template has merge fields you want filled. Example: [{"name": "Cost", "value": "$20,000"}].
file_urlsarray- Public URLs of the documents to append after the template documents. Dropbox Sign downloads each file, so the URLs must be reachable without login. PDF, Word, images and other common formats are accepted. Example: ["https://www.example.com/contracts/nda.pdf"].
is_eidboolean- Set to true to require signers to verify their identity with electronic identification (eID). Needs an eID-enabled plan and test_mode false. Defaults to false. Example: false.
messagestring- Custom message included in the email sent to signers. Example: "Hi Jack, please review and sign by Friday.".
metadataobject- Your own key-value data to attach, returned in every API response and event for this request. Up to 10 keys; keys up to 40 characters, values up to 1000 characters. Example: {"customer_id": "1234", "deal": "Acme renewal"}.
signing_optionsobject- Which ways signers can create their signature. default_type is required and is one of draw, phone, type or upload; set draw, phone, type and upload to true or false to allow each method. If not set, your account's settings apply. Example: {"default_type": "draw", "draw": true, "type": true, "upload": false, "phone": false}.
signing_redirect_urlstring- URL signers are sent to after they finish signing. Example: "https://www.example.com/thanks".
subjectstring- Subject line of the signature request email sent to signers. Example: "Please sign the NDA".
test_modeboolean- Set to true to make the signature request a test that is not legally binding. Use it while trying out a workflow. Defaults to false. Example: true.
titlestring- Title of the signature request, shown in Dropbox Sign and used in search. Example: "NDA with Acme".
dropboxsign_signature_request_release_holdRelease a signature request that was held when its unclaimed draft was claimed, so it is sent to all signers.WriteRelease Held Signature Request
Release a signature request that was held when its unclaimed draft was claimed, so it is sent to all signers. Returns the released signature_request. Use it only for requests created from an unclaimed draft that was set to hold the request.
Inputs
signature_request_idstringrequired- ID of the signature request. Get it from dropboxsign_signature_requests_list or from the response of a send tool. Example: "fa5c8a0b0f492d768749333ad6fcc214c111e967".
dropboxsign_signature_request_remindEmail a reminder to one signer who has not signed yet.WriteSend Reminder
Email a reminder to one signer who has not signed yet. Returns the updated signature_request. Use it to nudge a pending signer. You cannot remind the same request within 1 hour of the last reminder, and embedded requests cannot be reminded.
Inputs
email_addressstringrequired- Email address of the signer to remind. Example: "jack@example.com".
signature_request_idstringrequired- ID of the signature request. Get it from dropboxsign_signature_requests_list or from the response of a send tool. Example: "fa5c8a0b0f492d768749333ad6fcc214c111e967".
namestring- Name of the signer to remind. Only needed when two or more signers share the same email address. Example: "Jack Smith".
dropboxsign_signature_request_sendSend one or more documents, given by public URL, to signers by email.WriteSend Signature Request
Send one or more documents, given by public URL, to signers by email. Returns the new signature_request with its signature_request_id and a signature_id per signer. Use it for ad hoc documents. Use dropboxsign_signature_request_send_with_template to send a saved template, or dropboxsign_unclaimed_draft_create to let a user finish setup in Dropbox Sign. Without form_fields_per_document or text tags, Dropbox Sign appends a signature page for all signers.
Inputs
file_urlsarrayrequired- Public URLs of the documents to send for signature. Dropbox Sign downloads each file, so the URLs must be reachable without login. PDF, Word, images and other common formats are accepted. Example: ["https://www.example.com/contracts/nda.pdf"].
signersarrayrequired- People who must sign, in signing order if you set order. Each signer needs a name and an email_address. You can also set order (0-based position when signing in sequence), a pin (4 to 12 character access code the signer must enter) and an sms_phone_number in E.164 format with sms_phone_number_type authentication (default) or delivery. Example: [{"name": "Jack Smith", "email_address": "jack@example.com", "order": 0}, {"name": "Jill Lee", "email_address": "jill@example.com", "order": 1}].
allow_declineboolean- Set to true to let signers decline to sign. Defaults to false. Example: true.
allow_reassignboolean- Set to true to let signers reassign their part to someone else. Premium plan and higher only. Defaults to false. Example: false.
attachmentsarray- Files signers must or may upload while signing. Each item needs a name and the signer_index (0-based position in signers); you can add instructions and set required to true. Example: [{"name": "Photo ID", "signer_index": 0, "instructions": "Upload a photo of your ID", "required": true}].
cc_email_addressesarray- Email addresses to copy on the request. CCs get the completed documents but do not sign. Example: ["legal@example.com"].
client_idstring- Client ID of one of your Dropbox Sign API apps. Applies that app's branding and callback URL to the request. Example: "b6b8e7deaf8f0b95c029dca049356d4a2cf9710a".
custom_fieldsarray- Values that pre-fill merge fields in the documents. Each item needs the name of the merge field and the value to fill in. To let a signer edit a pre-filled value, set editor to that signer's role and optionally required to true. Works with merge fields or text tags in the documents. Example: [{"name": "Cost", "value": "$20,000"}].
expires_atinteger- When the request expires, as a Unix timestamp in seconds. Unsigned signatures then move to expired and can no longer be signed. Example: 1735689600.
field_optionsobject- Date format for date fields, as an object with date_format set to one of "MM / DD / YYYY", "MM - DD - YYYY", "DD / MM / YYYY", "DD - MM - YYYY", "YYYY / MM / DD" or "YYYY - MM - DD". Example: {"date_format": "DD - MM - YYYY"}.
form_fields_per_documentarray- Fields to place on the documents, one object per field. Each field needs document_index (0-based position in file_urls), a unique api_id, a type (text, checkbox, signature, date_signed, initials, radio, dropdown, text-merge, checkbox-merge or hyperlink), required (true or false), the signer, and its position and size in pixels (x, y, width, height). Set page to place it on a specific page. signer is the 0-based index of the signer in the signers list, as a string; use "me_now" for a field the sender fills now, and "sender" for text-merge or checkbox-merge fields. If you leave this out, Dropbox Sign adds a signature page for all signers. Text, dropdown, checkbox, radio and hyperlink fields take extra settings; see the form fields guide. Example: [{"document_index": 0, "api_id": "sig1", "name": "Signature", "type": "signature", "required": true, "signer": "0", "x": 100, "y": 600, "width": 200, "height": 30, "page": 1}].
hide_text_tagsboolean- Set to true to remove text tags from the final documents automatically. This can clip nearby content, so the vendor recommends hiding tags with white text instead. Defaults to false. Example: false.
is_eidboolean- Set to true to require signers to verify their identity with electronic identification (eID). Needs an eID-enabled plan and test_mode false. Defaults to false. Example: false.
messagestring- Custom message included in the email sent to signers. Example: "Hi Jack, please review and sign by Friday.".
metadataobject- Your own key-value data to attach, returned in every API response and event for this request. Up to 10 keys; keys up to 40 characters, values up to 1000 characters. Example: {"customer_id": "1234", "deal": "Acme renewal"}.
signing_optionsobject- Which ways signers can create their signature. default_type is required and is one of draw, phone, type or upload; set draw, phone, type and upload to true or false to allow each method. If not set, your account's settings apply. Example: {"default_type": "draw", "draw": true, "type": true, "upload": false, "phone": false}.
signing_redirect_urlstring- URL signers are sent to after they finish signing. Example: "https://www.example.com/thanks".
subjectstring- Subject line of the signature request email sent to signers. Example: "Please sign the NDA".
test_modeboolean- Set to true to make the signature request a test that is not legally binding. Use it while trying out a workflow. Defaults to false. Example: true.
titlestring- Title of the signature request, shown in Dropbox Sign and used in search. Example: "NDA with Acme".
use_text_tagsboolean- Set to true to turn text tags in the documents (for example [sig|req|signer1]) into fields. Defaults to false. Example: true.
dropboxsign_signature_request_send_with_templateSend a signature request built from one or more saved templates.WriteSend With Template
Send a signature request built from one or more saved templates. Returns the new signature_request with its signature_request_id and a signature_id per signer. Use it when the documents and fields already live in a template. Use dropboxsign_signature_request_send for ad hoc documents. Get template IDs and role names from dropboxsign_templates_list and dropboxsign_template_get first.
Inputs
signersarrayrequired- One signer per signer role defined in the template(s). Each item needs the role (must match a template role exactly, case-sensitive), the signer's name and email_address. You can also set a pin access code and an sms_phone_number. Get the role names from dropboxsign_template_get (template.signer_roles). Example: [{"role": "Client", "name": "Jack Smith", "email_address": "jack@example.com"}].
template_idsarrayrequired- IDs of the templates to use, in the order their documents should appear. Get them from dropboxsign_templates_list. Example: ["f57db65d3f933b5316d398057a36176831451a35"].
allow_declineboolean- Set to true to let signers decline to sign. Defaults to false. Example: true.
ccsarray- People to copy on the request, one per CC role defined in the template. Each item needs the role (must match a template CC role) and an email_address. Required when the template has a CC role. Example: [{"role": "Accounting", "email_address": "accounting@example.com"}].
client_idstring- Client ID of one of your Dropbox Sign API apps. Applies that app's branding and callback URL to the request. Example: "b6b8e7deaf8f0b95c029dca049356d4a2cf9710a".
custom_fieldsarray- Values that pre-fill merge fields in the documents. Each item needs the name of the merge field and the value to fill in. To let a signer edit a pre-filled value, set editor to that signer's role and optionally required to true. Required when the template has merge fields you want filled. Example: [{"name": "Cost", "value": "$20,000"}].
expires_atinteger- When the request expires, as a Unix timestamp in seconds. Unsigned signatures then move to expired and can no longer be signed. Example: 1735689600.
file_urlsarray- Public URLs of the documents to append after the template documents. Dropbox Sign downloads each file, so the URLs must be reachable without login. PDF, Word, images and other common formats are accepted. Example: ["https://www.example.com/contracts/nda.pdf"].
is_eidboolean- Set to true to require signers to verify their identity with electronic identification (eID). Needs an eID-enabled plan and test_mode false. Defaults to false. Example: false.
messagestring- Custom message included in the email sent to signers. Example: "Hi Jack, please review and sign by Friday.".
metadataobject- Your own key-value data to attach, returned in every API response and event for this request. Up to 10 keys; keys up to 40 characters, values up to 1000 characters. Example: {"customer_id": "1234", "deal": "Acme renewal"}.
signing_optionsobject- Which ways signers can create their signature. default_type is required and is one of draw, phone, type or upload; set draw, phone, type and upload to true or false to allow each method. If not set, your account's settings apply. Example: {"default_type": "draw", "draw": true, "type": true, "upload": false, "phone": false}.
signing_redirect_urlstring- URL signers are sent to after they finish signing. Example: "https://www.example.com/thanks".
subjectstring- Subject line of the signature request email sent to signers. Example: "Please sign the NDA".
test_modeboolean- Set to true to make the signature request a test that is not legally binding. Use it while trying out a workflow. Defaults to false. Example: true.
titlestring- Title of the signature request, shown in Dropbox Sign and used in search. Example: "NDA with Acme".
dropboxsign_signature_request_updateChange a signer's email address or name, or the request's expiry date, on a pending signature request.WriteUpdate Signature Request
Change a signer's email address or name, or the request's expiry date, on a pending signature request. Returns the updated signature_request. Changing the email generates a new signature_id for that signer. Use it to fix a bounced or wrong signer email. Use dropboxsign_signature_request_edit to change documents or the signer list. Get the signer's signature_id from dropboxsign_signature_request_get first.
Inputs
signature_idstringrequired- signature_id of the signer to update, from signatures[].signature_id in dropboxsign_signature_request_get. Example: "78caf2a1d01cd39cea2bc1cbb340dac3".
signature_request_idstringrequired- ID of the signature request. Get it from dropboxsign_signature_requests_list or from the response of a send tool. Example: "fa5c8a0b0f492d768749333ad6fcc214c111e967".
email_addressstring- New email address for the signer. Set this, name, or both. Example: "jack.smith@example.com".
expires_atinteger- When the request expires, as a Unix timestamp in seconds. Unsigned signatures then move to expired and can no longer be signed. Example: 1735689600.
namestring- New name for the signer. Set this, email_address, or both. Example: "Jack Smith".
dropboxsign_template_createCreate a reusable template from documents given by public URL, with signer roles and fields.WriteCreate Template
Create a reusable template from documents given by public URL, with signer roles and fields. Returns template.template_id. Creation can finish asynchronously; the template is usable once its files are processed. Use it to save a document layout for repeated sends. Use dropboxsign_signature_request_send_with_template to send it later.
Inputs
file_urlsarrayrequired- Public URLs of the documents to use for the template. Dropbox Sign downloads each file, so the URLs must be reachable without login. PDF, Word, images and other common formats are accepted. Example: ["https://www.example.com/contracts/nda.pdf"].
form_fields_per_documentarrayrequired- Fields to place on the documents, one object per field. Each field needs document_index (0-based position in file_urls), a unique api_id, a type (text, checkbox, signature, date_signed, initials, radio, dropdown, text-merge, checkbox-merge or hyperlink), required (true or false), the signer, and its position and size in pixels (x, y, width, height). Set page to place it on a specific page. signer is the 0-based index of the signer role in signer_roles. Text, dropdown, checkbox, radio and hyperlink fields take extra settings; see the form fields guide. Example: [{"document_index": 0, "api_id": "sig1", "name": "Signature", "type": "signature", "required": true, "signer": "0", "x": 100, "y": 600, "width": 200, "height": 30, "page": 1}].
signer_rolesarrayrequired- Signer roles that must be filled when the template is sent, in signing order. Each item needs a name and can set order (0-based). Example: [{"name": "Client", "order": 0}, {"name": "Witness", "order": 1}].
allow_reassignboolean- Set to true to let signers reassign their part to someone else. Premium plan and higher only. Defaults to false. Example: false.
attachmentsarray- Files signers must or may upload while signing. Each item needs a name and the signer_index (0-based position in signers); you can add instructions and set required to true. Example: [{"name": "Photo ID", "signer_index": 0, "instructions": "Upload a photo of your ID", "required": true}].
cc_rolesarray- Names of CC roles that must be filled when the template is sent. Example: ["Accounting"].
client_idstring- Client ID of one of your Dropbox Sign API apps. Applies that app's branding and callback URL to the request. Example: "b6b8e7deaf8f0b95c029dca049356d4a2cf9710a".
field_optionsobject- Date format for date fields, as an object with date_format set to one of "MM / DD / YYYY", "MM - DD - YYYY", "DD / MM / YYYY", "DD - MM - YYYY", "YYYY / MM / DD" or "YYYY - MM - DD". Example: {"date_format": "DD - MM - YYYY"}.
merge_fieldsarray- Merge fields you can pre-fill with custom_fields when sending. Each item needs a unique name and a type of text or checkbox. Example: [{"name": "Cost", "type": "text"}].
messagestring- Custom message included in the email sent to signers. Example: "Hi Jack, please review and sign by Friday.".
metadataobject- Your own key-value data to attach, returned in every API response and event for this request. Up to 10 keys; keys up to 40 characters, values up to 1000 characters. Example: {"customer_id": "1234", "deal": "Acme renewal"}.
subjectstring- Subject line of the default email sent to signers. Example: "Please sign the NDA".
test_modeboolean- Set to true to make the template a test that is not legally binding. Use it while trying out a workflow. Defaults to false. Example: true.
titlestring- Title of the signature request, shown in Dropbox Sign and used in search. Example: "NDA with Acme".
use_preexisting_fieldsboolean- Set to true to turn fillable fields already in the PDF into template fields. Defaults to false. Example: true.
dropboxsign_template_files_updateCreate a new template that copies an existing template's fields onto new documents.WriteUpdate Template Files
Create a new template that copies an existing template's fields onto new documents. Returns template.template_id of the new template; the original template is unchanged and stays usable. Use it to swap in a revised document. The new files must have at least as many pages and the same orientation. Uses a template from your quota.
Inputs
file_urlsarrayrequired- Public URLs of the documents to use in the new template. Dropbox Sign downloads each file, so the URLs must be reachable without login. PDF, Word, images and other common formats are accepted. Example: ["https://www.example.com/contracts/nda.pdf"].
template_idstringrequired- ID of the template. Get it from dropboxsign_templates_list. Example: "f57db65d3f933b5316d398057a36176831451a35".
client_idstring- Client ID of one of your Dropbox Sign API apps. Applies that app's branding and callback URL to the request. Example: "b6b8e7deaf8f0b95c029dca049356d4a2cf9710a".
messagestring- New default email message for the template. Example: "Please sign the updated agreement.".
subjectstring- Subject line of the new default email sent to signers. Example: "Please sign the NDA".
test_modeboolean- Set to true to make the template a test that is not legally binding. Use it while trying out a workflow. Defaults to false. Example: true.
dropboxsign_template_user_addGive a member of your team access to a template.WriteShare Template With User
Give a member of your team access to a template. Returns the updated template, including its accounts list. Use it to share a template with a teammate. Use dropboxsign_template_user_remove to take access away. Provide account_id or email_address; the account must be on your team.
- Idempotent
Inputs
template_idstringrequired- ID of the template. Get it from dropboxsign_templates_list. Example: "f57db65d3f933b5316d398057a36176831451a35".
account_idstring- Account ID of the team member to give access. Provide this or email_address; account_id wins if both are set. Get IDs from dropboxsign_team_get. Example: "5008b25c7f67153e57d5a357b1687968068fb465".
email_addressstring- Email address of the team member to give access. Provide this or account_id. Example: "jane@example.com".
skip_notificationboolean- Set to true to share without emailing the user. Defaults to false. Example: true.
dropboxsign_template_user_removeRemove a user's access to a template.WriteRemove User From Template
Remove a user's access to a template. Returns the updated template, including its accounts list. Use it to stop sharing a template. Use dropboxsign_template_user_add to share it. Provide account_id or email_address.
- Idempotent
Inputs
template_idstringrequired- ID of the template. Get it from dropboxsign_templates_list. Example: "f57db65d3f933b5316d398057a36176831451a35".
account_idstring- Account ID of the user to remove. Provide this or email_address; account_id wins if both are set. Example: "5008b25c7f67153e57d5a357b1687968068fb465".
email_addressstring- Email address of the user to remove. Provide this or account_id. Example: "jane@example.com".
dropboxsign_unclaimed_draft_createCreate a draft from documents given by public URL that a Dropbox Sign user claims and finishes in the web app.WriteCreate Unclaimed Draft
Create a draft from documents given by public URL that a Dropbox Sign user claims and finishes in the web app. Returns unclaimed_draft with claim_url (single use), signature_request_id and expires_at. Use it when a person should place fields or review before sending. Use dropboxsign_signature_request_send to send directly.
Inputs
file_urlsarrayrequired- Public URLs of the documents to include in the draft. Dropbox Sign downloads each file, so the URLs must be reachable without login. PDF, Word, images and other common formats are accepted. Example: ["https://www.example.com/contracts/nda.pdf"].
typestringrequired- send_document creates a claimable file the claimer signs or sends; request_signature creates a claimable signature request for the listed signers. With request_signature, signers is required. Example: "request_signature".one of
send_documentrequest_signature allow_declineboolean- Set to true to let signers decline to sign. Defaults to false. Example: true.
attachmentsarray- Files signers must or may upload while signing. Each item needs a name and the signer_index (0-based position in signers); you can add instructions and set required to true. Example: [{"name": "Photo ID", "signer_index": 0, "instructions": "Upload a photo of your ID", "required": true}].
cc_email_addressesarray- Email addresses to copy on the request. CCs get the completed documents but do not sign. Example: ["legal@example.com"].
client_idstring- Client ID of one of your Dropbox Sign API apps. Applies that app's branding and callback URL to the request. Example: "b6b8e7deaf8f0b95c029dca049356d4a2cf9710a".
custom_fieldsarray- Values that pre-fill merge fields in the documents. Each item needs the name of the merge field and the value to fill in. To let a signer edit a pre-filled value, set editor to that signer's role and optionally required to true. Works with merge fields or text tags in the documents. Example: [{"name": "Cost", "value": "$20,000"}].
expires_atinteger- When the request expires, as a Unix timestamp in seconds. Unsigned signatures then move to expired and can no longer be signed. Example: 1735689600.
field_optionsobject- Date format for date fields, as an object with date_format set to one of "MM / DD / YYYY", "MM - DD - YYYY", "DD / MM / YYYY", "DD - MM - YYYY", "YYYY / MM / DD" or "YYYY - MM - DD". Example: {"date_format": "DD - MM - YYYY"}.
form_fields_per_documentarray- Fields to place on the documents, one object per field. Each field needs document_index (0-based position in file_urls), a unique api_id, a type (text, checkbox, signature, date_signed, initials, radio, dropdown, text-merge, checkbox-merge or hyperlink), required (true or false), the signer, and its position and size in pixels (x, y, width, height). Set page to place it on a specific page. signer is the 0-based index of the signer in the signers list, as a string; use "me_now" for a field the sender fills now, and "sender" for text-merge or checkbox-merge fields. If you leave this out, Dropbox Sign adds a signature page for all signers. Text, dropdown, checkbox, radio and hyperlink fields take extra settings; see the form fields guide. Example: [{"document_index": 0, "api_id": "sig1", "name": "Signature", "type": "signature", "required": true, "signer": "0", "x": 100, "y": 600, "width": 200, "height": 30, "page": 1}].
hide_text_tagsboolean- Set to true to remove text tags from the final documents automatically. This can clip nearby content, so the vendor recommends hiding tags with white text instead. Defaults to false. Example: false.
messagestring- Custom message included in the email sent to signers. Example: "Hi Jack, please review and sign by Friday.".
metadataobject- Your own key-value data to attach, returned in every API response and event for this request. Up to 10 keys; keys up to 40 characters, values up to 1000 characters. Example: {"customer_id": "1234", "deal": "Acme renewal"}.
show_progress_stepperboolean- Set to false to hide the progress stepper when only one step remains. Defaults to true. Example: true.
signersarray- People who must sign. Required when type is request_signature; leave empty for send_document. Each signer needs a name and an email_address, and can set order (0-based position when signing in sequence). Example: [{"name": "Jack Smith", "email_address": "jack@example.com", "order": 0}].
signing_optionsobject- Which ways signers can create their signature. default_type is required and is one of draw, phone, type or upload; set draw, phone, type and upload to true or false to allow each method. If not set, your account's settings apply. Example: {"default_type": "draw", "draw": true, "type": true, "upload": false, "phone": false}.
signing_redirect_urlstring- URL signers are sent to after they finish signing. Example: "https://www.example.com/thanks".
subjectstring- Subject line of the signature request email sent to signers. Example: "Please sign the NDA".
test_modeboolean- Set to true to make the resulting signature request a test that is not legally binding. Use it while trying out a workflow. Defaults to false. Example: true.
use_preexisting_fieldsboolean- Set to true to turn fillable fields already in the PDF into signing fields. Defaults to false. Example: true.
use_text_tagsboolean- Set to true to turn text tags in the documents (for example [sig|req|signer1]) into fields. Defaults to false. Example: true.
dropboxsign_fax_deleteDelete a fax from the account.DestructiveDelete Fax
Delete a fax from the account. Returns an empty response (HTTP 204). Use it to remove a fax record. Use dropboxsign_faxes_list to find IDs.
- Idempotent
Inputs
fax_idstringrequired- ID of the fax. Get it from dropboxsign_faxes_list or the response of dropboxsign_fax_send. Example: "fa5c8a0b0f492d768749333ad6fcc214c111e967".
dropboxsign_signature_request_cancelCancel an incomplete signature request so no one can sign it.DestructiveCancel Signature Request
Cancel an incomplete signature request so no one can sign it. This cannot be undone. Returns an empty response; cancellation completes asynchronously. Use it to withdraw a request that is still pending. Use dropboxsign_signature_request_remove instead for a request that is already complete.
- Idempotent
Inputs
signature_request_idstringrequired- ID of the signature request. Get it from dropboxsign_signature_requests_list or from the response of a send tool. Example: "fa5c8a0b0f492d768749333ad6fcc214c111e967".
dropboxsign_signature_request_removeRemove your access to a completed signature request.DestructiveRemove Signature Request Access
Remove your access to a completed signature request. This cannot be undone; other parties keep their copies. Returns an empty response. Use it only on requests that every party has signed or declined. Use dropboxsign_signature_request_cancel for a pending request.
- Idempotent
Inputs
signature_request_idstringrequired- ID of the signature request. Get it from dropboxsign_signature_requests_list or from the response of a send tool. Example: "fa5c8a0b0f492d768749333ad6fcc214c111e967".
dropboxsign_template_deletePermanently delete a template from the account.DestructiveDelete Template
Permanently delete a template from the account. Returns an empty response. Use it to remove a template that is no longer needed. Signature requests already sent from it are not affected.
- Idempotent
Inputs
template_idstringrequired- ID of the template. Get it from dropboxsign_templates_list. Example: "f57db65d3f933b5316d398057a36176831451a35".
No tools match.
