Skip to navigation
Rooms API 101

Upgrading from Docusign Rooms API v1.0 to v2.0

View as Markdown

The release of Docusign Rooms API 2.0 brings a host of new features to enhance and expand your Docusign integration.

Important: The Docusign Developer Center only contains documentation for the latest version of the Rooms API (v2.0). The information on this page pertains to you only if you created your Docusign Rooms integration prior to September 16, 2019.

Why upgrade to Rooms API v2.0?

There are several benefits to upgrading your existing integrations from Rooms API v1.0 to v2.0 but please note that incompatible changes in v2.0 will require you to update your code.

  • All new features and functionality will be made available only in Rooms API v2.0.
  • The following Rooms API v1.0 endpoints do not support Version 6 of the Rooms platform:
  • POST /v1/rooms
  • POST /v1/members
  • PUT /v1/members/{userId}
  • GET /v1/meta/roles

What is the difference between Rooms API v1.0 and v2.0?

Here’s an overview of the differences between Docusign Rooms API versions:

  • Tip: Some endpoints, such as user endpoints, clearly state which version of the Rooms platform they support.
  • The API Account ID is required in the URL in Rooms API v2.0. As a reminder, the API Account ID is a GUID that you can find in your eSignature account. From the top menu, select Admin, then select Apps and Keys.
  • v1.0 Meta endpoints are under the Global Resources category in Rooms API v2.0.
  • v1.0 Members endpoints are under the Users category in Rooms API v2.0.
  • In Rooms API v2.0, Roles is a separate category, and is not included in the Global Resources category. In Version 6 of Rooms, Roles are configurable per account. As a result, we created a new category with endpoints that enable you to manage roles, including but not limited to getting a list of roles, getting the details about a specific role, and creating and deleting roles.
  • Room details are handled differently in v2.0 to support the advanced configurability of Version 6. There is a new fieldSet object that contains a preconfigured list of fields that appear on a room’s Details tab. Each fieldset is identified by a fieldSetId. A fieldset helps you make sense of the field data that you can include when creating a room, updating a room, or pulling data from a room.