Dropbox Sign actions

Reference for the Dropbox Sign actions: the sign-in connection, each action id, the fields each executor reads, outputs and a complete example.

The Dropbox Sign block sends, reads, lists and cancels signature requests through the Dropbox Sign API. For the plain-language guide, see Dropbox Sign.

When to use it

Use it to send a contract or form for signature from a workflow and to poll whether it has been signed. There is no Dropbox Sign trigger.

Connection

Provider id: dropbox-sign (the legacy id dropboxSign is still accepted in action ids). Sign-in (OAuth) connection.
Pin an account with config.connection. Without it, the step uses the company's default Dropbox Sign connection.

Actions

Action id	Studio label	What it does
`dropbox-sign.sendSignatureRequest`	Send Signature Request	Send documents (by URL) to signers.
`dropbox-sign.getSignatureRequest`	Get Signature Request	Read a signature request and its status.
`dropbox-sign.cancelSignatureRequest`	Cancel Signature Request	Cancel an incomplete signature request.
`dropbox-sign.listSignatureRequests`	List Signature Requests

Settings

The Studio fields:

Field	Studio label	Type	Used by	Required for
`connection`	Dropbox Sign Account	string (connection id)	All	Optional. Without it the step uses the company default connection for this system
`signatureRequestId`	Signature Request ID	string	`getSignatureRequest`, `cancelSignatureRequest`
`title`	Title	string	`sendSignatureRequest`
`subject`	Email Subject	string	`sendSignatureRequest`
`message`	Message	string	`sendSignatureRequest`
`signers`	Signers (JSON)	json	`sendSignatureRequest`
`templateId`	Template ID	string	`sendSignatureRequest`

Fields each action reads

Action	Fields read
`sendSignatureRequest`	`title`, `subject`, `message`, `signers` (array of `{ email_address, name, order? }`), `fileUrls` (array of document URLs), and optional `ccEmailAddresses`, `metadata`, `signingOptions`, `testMode`, `useTextTags`, `hideTextTags`, `allowDecline`, `allowReassign`, `isQualifiedSignature`, `formFieldsPerDocument`, `expiresAt`, `signingRedirectUrl`, `requestingRedirectUrl`
`getSignatureRequest`	`signatureRequestId`
`cancelSignatureRequest`	`signatureRequestId`
`listSignatureRequests`	optional `accountId`, `page`, `pageSize`, `query`

sendSignatureRequest does not read templateId. Studio does not show fileUrls, so set it in the workflow definition. testMode defaults to false.

The step output is the Dropbox Sign response, with the request under signature_request. For example {{steps.send_request.signature_request.signature_request_id}} and {{steps.check_request.signature_request.is_complete}}.

Example

{
  "name": "Send a contract to sign",
  "trigger": { "type": "api" },
  "steps": [
    {
      "id": "send_request",
      "type": "action",
      "name": "Send for signature",
      "action": "dropbox-sign.sendSignatureRequest",
      "config": {
        "title": "Services agreement - {{input.customerName}}",
        "subject": "Please sign your services agreement",
        "message": "Let us know if you have any questions.",
        "signers": [{ "email_address": "{{input.signerEmail}}", "name": "{{input.signerName}}" }],
        "fileUrls": ["{{input.contractUrl}}"]
      }
    }
  ]
}

Other executors

The module also has executors the block does not list, such as dropbox-sign.sendWithTemplate, dropbox-sign.sendReminder and dropbox-sign.downloadFiles. The workflow validator accepts only the operations in the table above.

Live catalog

GET /api/v1/blocks/dropbox-sign returns the actions and fields.
GET /api/v1/blocks/dropbox-sign/actions/<operation>/examples returns stored examples where they exist.

Errors and limits

A Dropbox Sign API error fails the step.
A missing signatureRequestId fails getSignatureRequest and cancelSignatureRequest before the call.