Dropbox Sign

App · E-Signatures · 8 actions

Send documents for electronic signature with Dropbox Sign: send a file or a saved template out for signing, track where each signer has got to, remind whoever is holding things up, cancel a request, and download the finished PDF.

Actions

ActionWhat it does
Cancel Dropbox Sign signature requestCancel an incomplete signature request so no one can sign it any more.
Get Dropbox Sign file linkGet a temporary download link for a signature request's PDF.
Get Dropbox Sign signature requestGet one signature request, including how far each signer has got.
List Dropbox Sign signature requestsList signature requests on the account, newest first.
List Dropbox Sign templatesList the saved templates with the signer roles and custom fields each one expects, which is what Send Dropbox Sign template needs to fill in.
Remind Dropbox Sign signerEmail a reminder to one signer who has not signed yet.
Send Dropbox Sign signature requestSend a document out for signature.
Send Dropbox Sign templateSend a signature request built from one or more saved templates, filling in each template role and any custom fields.

Cancel Dropbox Sign signature request

Cancel an incomplete signature request so no one can sign it any more. Signers are not told. This cannot be undone, and a request that is already complete cannot be cancelled.

Inputs

Signature request IDsignature_request_idtextRequired
The signature request's id. You can get this from the send or list actions.

Outputs

None.

Example output
{}

Get a temporary download link for a signature request's PDF. Use this after a request completes to file the signed copy somewhere. The link expires, so download it in the same run.

Inputs

Signature request IDsignature_request_idtextRequired
The signature request's id. You can get this from the send or list actions.

Outputs

expires_atnumber
When the link stops working, as a Unix timestamp.
file_urltext
Temporary link to download the PDF from.
Example output
{
  "expires_at": 1769613300,
  "file_url": "https://api.hellosign.com/v3/signature_request/files/fa5c8a0b?get_url=1"
}

Get Dropbox Sign signature request

Get one signature request, including how far each signer has got. Poll this to hold a workflow until everyone has signed.

Inputs

Signature request IDsignature_request_idtextRequired
The signature request's id. You can get this from the send or list actions.

Outputs

signature_requestobject
Example output
{
  "signature_request": {
    "cc_email_addresses": [
      "legal@example.com"
    ],
    "created_at": 1769609700,
    "details_url": "https://app.hellosign.com/home/manage?guid=fa5c8a0b",
    "expires_at": 1772201700,
    "files_url": "https://api.hellosign.com/v3/signature_request/files/fa5c8a0b",
    "final_copy_uri": "/v3/signature_request/final_copy/fa5c8a0b",
    "has_error": false,
    "is_complete": false,
    "is_declined": false,
    "message": "Happy to answer any questions before you sign.",
    "metadata": {
      "deal_id": "4821"
    },
    "requester_email_address": "grace@example.com",
    "signature_request_id": "fa5c8a0b0f492d768749333ad6fcc214c111e967",
    "signatures": [
      {
        "decline_reason": null,
        "error": null,
        "last_reminded_at": null,
        "last_viewed_at": 1769610600,
        "order": 1,
        "signature_id": "78caf2a1d01cd39cea2bc1cbb340dac3",
        "signed_at": null,
        "signer_email_address": "ada@example.com",
        "signer_name": "Ada Lovelace",
        "signer_role": "Client",
        "status_code": "awaiting_signature"
      }
    ],
    "signing_redirect_url": null,
    "signing_url": null,
    "subject": "Please countersign the NDA",
    "template_ids": [],
    "test_mode": true,
    "title": "Mutual NDA"
  }
}

List Dropbox Sign signature requests

List signature requests on the account, newest first. Search with Dropbox Sign's own syntax to find, for example, everything still outstanding.

Inputs

Queryquerytext
Search text, using Dropbox Sign's own search syntax such as 'complete:false' or 'title:Contract'.
Pagepagenumber
Which page of results to return, starting at 1.
Page sizepage_sizenumber
How many records to return per page, 1 to 100.
Account IDaccount_idtext
Show another team member's requests instead of your own, by their account id.

Outputs

countnumber
Number of requests on this page.
pagenumber
Which page this is, starting at 1.
page_sizenumber
How many records each page holds.
pagesnumber
How many pages there are in total.
signature_requestslist
Requests on this page.
totalnumber
How many records match in total.
Example output
{
  "count": 1,
  "page": 1,
  "page_size": 20,
  "pages": 2,
  "signature_requests": [
    {
      "cc_email_addresses": [
        "legal@example.com"
      ],
      "created_at": 1769609700,
      "details_url": "https://app.hellosign.com/home/manage?guid=fa5c8a0b",
      "expires_at": 1772201700,
      "files_url": "https://api.hellosign.com/v3/signature_request/files/fa5c8a0b",
      "final_copy_uri": "/v3/signature_request/final_copy/fa5c8a0b",
      "has_error": false,
      "is_complete": false,
      "is_declined": false,
      "message": "Happy to answer any questions before you sign.",
      "metadata": {
        "deal_id": "4821"
      },
      "requester_email_address": "grace@example.com",
      "signature_request_id": "fa5c8a0b0f492d768749333ad6fcc214c111e967",
      "signatures": [
        {
          "decline_reason": null,
          "error": null,
          "last_reminded_at": null,
          "last_viewed_at": 1769610600,
          "order": 1,
          "signature_id": "78caf2a1d01cd39cea2bc1cbb340dac3",
          "signed_at": null,
          "signer_email_address": "ada@example.com",
          "signer_name": "Ada Lovelace",
          "signer_role": "Client",
          "status_code": "awaiting_signature"
        }
      ],
      "signing_redirect_url": null,
      "signing_url": null,
      "subject": "Please countersign the NDA",
      "template_ids": [],
      "test_mode": true,
      "title": "Mutual NDA"
    }
  ],
  "total": 34
}

List Dropbox Sign templates

List the saved templates with the signer roles and custom fields each one expects, which is what Send Dropbox Sign template needs to fill in.

Inputs

Queryquerytext
Search text, using Dropbox Sign's own search syntax such as 'complete:false' or 'title:Contract'.
Pagepagenumber
Which page of results to return, starting at 1.
Page sizepage_sizenumber
How many records to return per page, 1 to 100.
Account IDaccount_idtext
Show another team member's templates instead of your own, by their account id.

Outputs

countnumber
Number of templates on this page.
pagenumber
Which page this is, starting at 1.
page_sizenumber
How many records each page holds.
pagesnumber
How many pages there are in total.
templateslist
Templates on this page.
totalnumber
How many records match in total.
Example output
{
  "count": 1,
  "page": 1,
  "page_size": 20,
  "pages": 1,
  "templates": [
    {
      "can_edit": true,
      "cc_roles": [
        "Legal"
      ],
      "custom_fields": [
        "company_name"
      ],
      "is_embedded": false,
      "is_locked": false,
      "message": "Please review and sign.",
      "metadata": {},
      "signer_roles": [
        "Client",
        "Counterparty"
      ],
      "template_id": "61a832ff0d8423f91d503e76bfbcc750f7417c78",
      "title": "Mutual NDA",
      "updated_at": 1769523300
    }
  ],
  "total": 1
}

Remind Dropbox Sign signer

Email a reminder to one signer who has not signed yet. Dropbox Sign reminds a named person rather than everyone at once, so give the signer's email address.

Inputs

Signature request IDsignature_request_idtextRequired
The signature request's id. You can get this from the send or list actions.
Email addressemail_addresstextRequired
Email address of the signer to remind. It has to match one of the signers on the request.
Namenametext
The signer's name, needed only when two signers share an email address.

Outputs

signature_requestobject
Example output
{
  "signature_request": {
    "cc_email_addresses": [
      "legal@example.com"
    ],
    "created_at": 1769609700,
    "details_url": "https://app.hellosign.com/home/manage?guid=fa5c8a0b",
    "expires_at": 1772201700,
    "files_url": "https://api.hellosign.com/v3/signature_request/files/fa5c8a0b",
    "final_copy_uri": "/v3/signature_request/final_copy/fa5c8a0b",
    "has_error": false,
    "is_complete": false,
    "is_declined": false,
    "message": "Happy to answer any questions before you sign.",
    "metadata": {
      "deal_id": "4821"
    },
    "requester_email_address": "grace@example.com",
    "signature_request_id": "fa5c8a0b0f492d768749333ad6fcc214c111e967",
    "signatures": [
      {
        "decline_reason": null,
        "error": null,
        "last_reminded_at": null,
        "last_viewed_at": 1769610600,
        "order": 1,
        "signature_id": "78caf2a1d01cd39cea2bc1cbb340dac3",
        "signed_at": null,
        "signer_email_address": "ada@example.com",
        "signer_name": "Ada Lovelace",
        "signer_role": "Client",
        "status_code": "awaiting_signature"
      }
    ],
    "signing_redirect_url": null,
    "signing_url": null,
    "subject": "Please countersign the NDA",
    "template_ids": [],
    "test_mode": true,
    "title": "Mutual NDA"
  }
}

Send Dropbox Sign signature request

Send a document out for signature. The document is fetched from a public URL, so point this at a file your workflow has already produced or stored somewhere reachable.

Inputs

TitletitletextRequired
The document's title, shown to signers.
SignerssignerslistRequired
Who needs to sign, as a list of objects. Each needs a name and an email_address, and may set a pin to require a code before signing. Set order to a number on each to make people sign one after another.
File URLSfile_urlstextRequired
Publicly reachable links to the documents to send, as a list or a comma-separated string. Dropbox Sign downloads them itself, so they must not need a login.
Subjectsubjecttext
Subject line of the email sent to signers.
Messagemessagetext
Message shown in the email sent to signers.
CC email addressescc_email_addressestext
Addresses to copy on the request, as a comma-separated string. They get a copy but do not sign.
Allow declineallow_declinetrue/false
Let signers decline instead of signing.
Signing redirect URLsigning_redirect_urltext
Where to send signers after they finish signing.
Test modetest_modetrue/false
Send as a test. Test requests are free and are never legally binding, and are the only kind a free Dropbox Sign account can send over the API. Off by default.

Outputs

signature_requestobject
Example output
{
  "signature_request": {
    "cc_email_addresses": [
      "legal@example.com"
    ],
    "created_at": 1769609700,
    "details_url": "https://app.hellosign.com/home/manage?guid=fa5c8a0b",
    "expires_at": 1772201700,
    "files_url": "https://api.hellosign.com/v3/signature_request/files/fa5c8a0b",
    "final_copy_uri": "/v3/signature_request/final_copy/fa5c8a0b",
    "has_error": false,
    "is_complete": false,
    "is_declined": false,
    "message": "Happy to answer any questions before you sign.",
    "metadata": {
      "deal_id": "4821"
    },
    "requester_email_address": "grace@example.com",
    "signature_request_id": "fa5c8a0b0f492d768749333ad6fcc214c111e967",
    "signatures": [
      {
        "decline_reason": null,
        "error": null,
        "last_reminded_at": null,
        "last_viewed_at": 1769610600,
        "order": 1,
        "signature_id": "78caf2a1d01cd39cea2bc1cbb340dac3",
        "signed_at": null,
        "signer_email_address": "ada@example.com",
        "signer_name": "Ada Lovelace",
        "signer_role": "Client",
        "status_code": "awaiting_signature"
      }
    ],
    "signing_redirect_url": null,
    "signing_url": null,
    "subject": "Please countersign the NDA",
    "template_ids": [],
    "test_mode": true,
    "title": "Mutual NDA"
  }
}

Send Dropbox Sign template

Send a signature request built from one or more saved templates, filling in each template role and any custom fields. Use List Dropbox Sign templates to find the template id and the roles it expects.

Inputs

Template IDStemplate_idstextRequired
Which templates to use, as a comma-separated string of template ids.
SignerssignerslistRequired
Who needs to sign, as a list of objects. Each needs a name and an email_address, and may set a pin to require a code before signing. Each also needs a role naming the template role they fill. Dropbox Sign requires exactly one signer per role the template defines: List Dropbox Sign templates shows a template's roles in signer_roles, so a two-role template needs two entries here, one per role, or the request is rejected as having no recipients. If the same person fills more than one role, give each entry a distinct name; Dropbox Sign also rejects two signers that share both the same name and email address.
Titletitletext
Override the template's title for this request.
Subjectsubjecttext
Subject line of the email sent to signers.
Messagemessagetext
Message shown in the email sent to signers.
Custom fieldscustom_fieldsobject
Values for the template's custom fields. Add one entry per field: the key is the field name, which List Dropbox Sign templates shows, and the value is what to fill in.
Signing redirect URLsigning_redirect_urltext
Where to send signers after they finish signing.
Test modetest_modetrue/false
Send as a test. Test requests are free and are never legally binding, and are the only kind a free Dropbox Sign account can send over the API. Off by default.

Outputs

signature_requestobject
Example output
{
  "signature_request": {
    "cc_email_addresses": [
      "legal@example.com"
    ],
    "created_at": 1769609700,
    "details_url": "https://app.hellosign.com/home/manage?guid=fa5c8a0b",
    "expires_at": 1772201700,
    "files_url": "https://api.hellosign.com/v3/signature_request/files/fa5c8a0b",
    "final_copy_uri": "/v3/signature_request/final_copy/fa5c8a0b",
    "has_error": false,
    "is_complete": false,
    "is_declined": false,
    "message": "Happy to answer any questions before you sign.",
    "metadata": {
      "deal_id": "4821"
    },
    "requester_email_address": "grace@example.com",
    "signature_request_id": "fa5c8a0b0f492d768749333ad6fcc214c111e967",
    "signatures": [
      {
        "decline_reason": null,
        "error": null,
        "last_reminded_at": null,
        "last_viewed_at": 1769610600,
        "order": 1,
        "signature_id": "78caf2a1d01cd39cea2bc1cbb340dac3",
        "signed_at": null,
        "signer_email_address": "ada@example.com",
        "signer_name": "Ada Lovelace",
        "signer_role": "Client",
        "status_code": "awaiting_signature"
      }
    ],
    "signing_redirect_url": null,
    "signing_url": null,
    "subject": "Please countersign the NDA",
    "template_ids": [],
    "test_mode": true,
    "title": "Mutual NDA"
  }
}

On this page