Dropbox Sign API Changelog

This page tracks changes to the Dropbox Sign API, SDKs, and documentation. The format may change, but the historical information will be kept intact.

2024-11-27

Added boolean property is_signed to Signature Request response to indicate if a signature or initials field was signed.
SDK version update.

2024-09-30

Added SDK MIT license attention banner on Official Dropbox Sign SDKs page.
Removed all references of JWT as the bearer format for OAuth access tokens. Bearer format is not JWT, but a base64 encoded string.

2024-09-04

Documentation Improvements

Added warning banner for HTTPS requirement on the Events Walkthrough.

2024-06-15

Documentation Improvements

Updated Embedded Testing Tool available.

2024-05-29

Features

Document Status Report now includes a column with the Signer's name.

Documentation Improvements

Updated documentation to reflect newer/missing endpoints.

2024-05-15

Features

Compliance report now provides 3 separate reports when initiated:
1. Account & API Key Details
2. API Call Activity
3. Log In Activity

Documentation Improvements

Admin Console Reports updated to reflect the new report information generated by Compliance Reports.

2024-05-03

Documentation Improvements

Added new guide on Admin Console Reports.
Admin Console Compliance report option updated to provide Team Admins with API key information including API key: name, owner, created date, last updated date, last used date, and Primary key status.
Added a Searching section to the API Dashboard overview page which provides guidance for enhanced filtering capabilities.

2024-04-15

Documentation Improvements

Added behavior clarification for signature_request_email_bounce event callback.
SDK version update due to new features added.
Updated Java examples in Java Migration Guide to reflect Java SDK latest version's (v2) use of Jakarta vs v1's Javax.

2024-03-15

Documentation Improvements

Team Admin Global View section added to the API Dashboard Overview.
Additional details on callback failures and retries added to the Events Walkthrough.
Added note in adding eID page clarifying eID is not supported in embedded signing.
Published Migrate DocuSign templates into Dropbox Sign guide.
Fixed general grammatical errors throughout the documentation.
Linked Signature Request Expiration Date documentation to sidebar menu.

Fixes

Navigation to and within users's API Settings page. This addresses previously reported issues with the buttons in the API apps section of the API Settings page.
General bug fixes for unhandled type errors.

2024-02-01

Documentation Improvements

Updated create template response docs for accuracy.

Features

Added force_download parameter to the Get Template Files as File Url endpoint. This allows the requester to download the file locally or in-browser.
Added allow_ccs parameter to the Create Embedded Unclaimed Draft with Template endpoint. This allows the requester to specify if the claiming user is allowed to provide email addresses to CC.

Fixes

Fixed issue with the Node SDK error response handling.

2024-01-15

Fixes

Fixed filtering logic for the List Signature Requests endpoint. The account_id parameter can now filter for any team member.

2023-12-01

Fixes

General code and performance improvements

2023-11-01

Documentation Improvements

Created documentation for adding pre-filled data to documents.

2023-10-10

Features

eID Secure Sign is now available for all premium API customers on following endpoints
- by using the new request parameter is_eid
  - /v3/signature_request/send
  - /v3/signature_request/send_with_template
- by enabling eID during embedded draft claiming process
  - /v3/unclaimed_draft/create_embedded
  - /v3/unclaimed_draft/create_embedded_with_template
  - NOTE: Enable force_signer_roles when using template to see signer step

Documentation Improvements

Added is_eid parameter and deprecated is_qualified_signature

2023-10-01

Features

Added the Feature Set Testing Tool. This allows users to test the new Dropbox Prep and Send page for individual accounts. See the API Help article for more details.

Fixes

General code and performance improvements

2023-09-15

Fixes

General code and performance improvements

2023-09-01

Features

List of IP addresses utilized for webhooks events is now available for download

Documentation Improvements

Added Securing your Callback Handler section to Events and Callbacks Walkthrough page.
Updated OAuth Walkthrough code samples to reference their latest SDK versions.

2023-08-15

Features

Accessibility update for the Signer App
- Improved tabbing
- Better focus states
- Improved screen reader support

Fixes

Fixed premium branding text colors

2023-08-01

Documentation Improvements

Updated premium branding documentation
- Demo page
- Documentation
Updated signature request examples

2023-07-15

Documentation Improvements

Added SMS Tools Walkthrough
Removed beta tags from Team endpoints

2023-07-01

Features

Signature Request Expiration Date is now available for all API customers.
The Signature modal in the Signer App has been updated with improved visuals and drawing canvas.

2023-06-15

Fixes

Test Mode Restrictions
- Free users are now limited to 10 emails every 24 hours
- Each signature request is now limited to 2 signers or CCs

2023-06-01

Fixes

File download endpoints request rate reduced, please see Rate Limits for details.
Signature Request Expiration Date (Beta) project
- Fixed Date Picker bug in the embedded editor page

2023-05-15

Fixes

General code and performance improvements

2023-05-01

Fixes

Signature Request Expiration Date (Beta) fixes
- Improved performance for expiring signature requests

Documentation Improvements

Removed mention of two-dimensional array bug for form_fields_per_document parameter

Features

Added Tool Tip for API Dashboard

2023-04-15

Fixes

Fixed multipart/form-data PUT requests having form data dropped (JSON was unaffected)

Documentation Improvements

Added section in Constants Doc clarifying behavior of new parameter populate_auto_fill_fields
Added client_id on search query for List Signature Request
Added additional API Errors to documentation:
- ? - Error retrieving result. - 500
- unknown - Unknown error. Please contact support@hellosign.com. - 500

2023-04-01

Documentation Improvements

Updated the example console in the Event Payload section of the Events Walkthrough documentation.
Updated code sample consoles in all Walkthroughs to reference new SDKs code snippets.
Updated cURL code sample for embeddedEditUrl API reference doc to reference correct endpoint.

2023-03-15

SDKs

Node SDK - remove limit on file upload size
Node SDK - fixes incorrect instantiation of objects when not using the ::init() method

Fixes

Prevent download for signature requests in an error state If files of signature requests are in error state and a consumer attempts to download them, previously http 409 “Still Process” status code was returned. This status has been changed to 422 “Unprocessable Content”.
Signature Request Expiration Date (Beta) fixes
- Fixed embedded requests not getting expired emails
- Fixed expiration date not showing on Documents page for some signature requests
- Fixed documentation of expires_at for /v3/signature_request/create_embedded
Custom Field Names If custom field name is null, the API will substitute the API ID for the missing name. This patches a bug that used to return an error response.

2023-03-01

SDKs

All SDKs bumped to 1.1.0
- all
  - fixes template.document schema response
  - Adds invited_emails to Team endpoint responses
  - Adds page and page_size parameters Get Bulk Send Job endpoint
  - Removes beta tag for sms_phone_number_type in Signer request object
- java - Support method overloading

Fixes

Fixed bug where some PDF highlights would appear in front of text

Documentation Improvements

Added pagination params to GET /bulk_send_job

2023-02-15

Features

New and Improved API Dashboard
SMS Signature Request Delivery is Out of Beta

SDKs

All SDKs bumped to 1.0.1

2023-01-31

Features

OpenAPI SDKs are officially out of beta and released. The new SDKs significantly improves user experience and their ability to maintain stable integrations with the API. By adopting OpenAPI, the code is autogenerated, ensuring they are in complete parity with the API and automatically updated any time we ship changes. Please find more information on SDKs page.

2022-11-09

changelog starting point

This first entry in the changelog contains updates that occurred over the course of this year. Future entries will have shorter, more specific ranges of time.

Announcements

HelloSign is officially rebranded as Dropbox Sign. [October 25th]

Features

The following features are released in beta:

Enable Dropbox Sign's Auto-Fill Fields in the API using populate_auto_fill_fields. [~ August]
Manage your Team with these new endpoints [~ July]:
- Get Team Info (/team/info)
- List Team Members (/team/members/team_id)
- List Sub Teams (/team/sub_teams/team_id)
Use sms_phone_number_type to deliver signature requests via SMS. [~ September]

Fixes

Resolved an issue where malformed queries on /signature_request/list and /template/list were throwing 500 errors instead of 400. [~ September]
Numerous bug fixes released to new SDKs to improve interactions with files. [~ October]

Documentation

Fully migrated to new documentation. [~ August]
New doc section added for managing multiple API keys. [~ October]
Fixed broken links on the Template schema page. [~ October]
Added an Overview page for Dropbox Sign Events (webhooks) and OAuth. [~ June]
Added a new section for App Approval to help customers get their apps approved for production. [~ July]
Disabled url encoding in Try it console, which was preventing querying on list endpoints. [~ October]