How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Docusign Rooms API

A room can hold documents, envelopes, a list of tasks comprising a workflow, and other related information. You can invite others to this space and assign them permissions on a per-room basis.

Docusign Rooms API is one of 134 APIs that Docusign publishes on the APIs.io network, described by a machine-readable OpenAPI specification and an AsyncAPI event-driven specification.

This API exposes 1 JSON Schema definition.

Tagged areas include Rooms. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an AsyncAPI specification, a JSON-LD context, a getting-started guide, rate-limit docs, and 1 JSON Schema.

This API exposes 19 operations across 14 paths, and defines 31 schemas. It is described by OpenAPI 3.2.0, at version v2.

Requests are made against a single base URL, https://rooms.docusign.com/restapi.

19 operations 14 paths 31 schemas 1 DELETE7 GET8 POST3 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
v2
Base URL
https://demo.docusign.net/restapi
Authentication
API Key
Terms of Service
Resource Areas
1

Authentication & Security 1

Docusign Rooms API declares 1 security scheme for authenticating requests. An API key is passed in the header as Authorization (Bearer). By default, every request must be authenticated.

  • Bearer — JWT Authorization header using the Bearer scheme. Example: "Authorization: Bearer {token}"

Paths & Operations 19

Across 14 paths, the API surfaces 19 operations — 1 DELETE, 7 GET, 8 POST, 3 PUT. Each is listed below with its method, path, parameters, and response codes.

Rooms 19

A room can hold documents, envelopes, a list of tasks comprising a workflow, and other related information. You can invite others to this space and assign them permissions on a pe…

POST
/v2/accounts/{accountId}/rooms/{roomId}/envelopes
Docusign Creates an envelope with the given documents. Returns the eSignature envelope ID of the envelope that was created.
RoomEnvelopes_CreateRoomEnvelope 2 params body → 200201400401
GET
/v2/accounts/{accountId}/rooms/{roomId}/field_data
Docusign Gets a room's field data.
Rooms_GetRoomFieldData 2 params → 200400401
PUT
/v2/accounts/{accountId}/rooms/{roomId}/field_data
Docusign Updates a room's field data.
Rooms_UpdateRoomFieldData 2 params body → 200400401
POST
/v2/accounts/{accountId}/rooms/{roomId}/forms
Docusign Adds a form to a room.
Rooms_AddFormToRoom 2 params body → 200201400401
GET
/v2/accounts/{accountId}/rooms/{roomId}/users
Docusign Gets a room's users.
Rooms_GetRoomUsers 6 params → 200400401404
POST
/v2/accounts/{accountId}/rooms/{roomId}/users
Docusign Invites a user to a room.
Rooms_InviteUser 2 params body → 200201400401
PUT
/v2/accounts/{accountId}/rooms/{roomId}/users/{userId}
Docusign Updates a room user.
Rooms_PutRoomUser 3 params body → 200400401
POST
/v2/accounts/{accountId}/rooms/{roomId}/users/{userId}/revoke_access
Docusign Revokes the specified user's access to the room.
Rooms_RevokeRoomUserAccess 3 params body → 204400401
POST
/v2/accounts/{accountId}/rooms/{roomId}/users/{userId}/restore_access
Docusign Restores the specified user's access to the room.
Rooms_RestoreRoomUserAccess 3 params → 204400401
GET
/v2/accounts/{accountId}/rooms
Docusign Returns a list of rooms.
Rooms_GetRooms 9 params → 200400401
POST
/v2/accounts/{accountId}/rooms
Docusign Creates a room.
Rooms_CreateRoom 1 param body → 201400401
GET
/v2/accounts/{accountId}/rooms/{roomId}
Docusign Gets a room.
Rooms_GetRoom 3 params → 200400401
DELETE
/v2/accounts/{accountId}/rooms/{roomId}
Docusign Deletes a room.
Rooms_DeleteRoom 2 params → 204400401
GET
/v2/accounts/{accountId}/rooms/{roomId}/assignable_roles
Docusign Gets assignable room-level roles in v6.
Rooms_GetAssignableRoles 6 params → 200400401
GET
/v2/accounts/{accountId}/rooms/{roomId}/documents
Docusign Gets a list of documents in a room.
Rooms_GetDocuments 8 params → 200400401
POST
/v2/accounts/{accountId}/rooms/{roomId}/documents
Docusign Adds a document to a room.
Rooms_AddDocumentToRoom 2 params body → 201400401
POST
/v2/accounts/{accountId}/rooms/{roomId}/documents/contents
Docusign Uploads the contents of a file as a document to a room.
Rooms_AddDocumentToRoomViaFileUpload 2 params body → 201400401
PUT
/v2/accounts/{accountId}/rooms/{roomId}/picture
Docusign Updates the picture for a room.
Rooms_UpdatePicture 2 params body → 200400401
GET
/v2/accounts/{accountId}/rooms/{roomId}/field_set
Docusign Gets the field set for a room.
Rooms_GetRoomFieldSet 2 params → 200400401

Schemas 31

The contract defines 31 schemas that model the data the API accepts and returns. The most detailed are Room (14 properties), RoomDocument (12 properties), Document (11 properties), RoomSummary (11 properties). Each schema is shown below with its type and property counts.

Document
object
Contains information about a document.
11 properties 2 required
EnvelopeForCreate
object
2 properties
RoleSummary
object
Contains details about a role.
6 properties
FieldSet
object
Contains details about a field set.
3 properties
Field
object
Contains details about a field in a field set.
8 properties
ApiError
object
This object describes errors that occur. It is valid only for responses and ignored in requests.
3 properties
RoomDocumentOwner
object
5 properties
CustomData
object
Contains information about whether the field is required when a room is created or submitted for review.
2 properties
RoomDocumentList
object
A list of documents in a room.
7 properties
FieldDataForCreate
object
Contains key-value pairs that specify the properties of the room and their values.
1 property
RoomUserSummary
object
Contains details about a room user.
9 properties
RoomUsersResult
object
This complex type contains details about the users associated with a room.
7 properties
RoomSummary
object
This object contains details about a room.
11 properties
RoomUserForUpdate
object
This request object contains the information that you want to update for the room user.
2 properties
RoomPicture
object
This response object contains the URL for the uploaded picture.
1 property
RoomInviteResponse
object
Information about the sent invitation.
7 properties
RoomForCreate
object
This request object contains the details about the new room.
8 properties 2 required
Envelope
object
1 property
RoomSummaryList
object
This complex type contains details about rooms.
7 properties
Room
object
Contains details about a room.
14 properties
FieldDataForUpdate
object
The field data to update. When updating field data, specify only the fields being updated.
1 property
SelectListFieldOption
object
Contains details about an option in a list.
3 properties
FormForAdd
object
Contains details about the form that you want to add.
1 property 1 required
AssignableRoles
object
This complex type contains information about assignable roles.
8 properties
RoomInvite
object
The information to use for the invitation.
5 properties 4 required
FieldConfiguration
object
Contains details about how a field is configured.
9 properties
FieldData
object
The field data associated with a room. See [Rooms: GetRoomFieldData](/docs/rooms-api/reference/rooms/rooms/getroomfielddata/).
1 property
RoomUser
object
This object contains details about a specific room member.
8 properties
RoomUserRemovalDetail
object
Details for removal.
1 property
RoomDocument
object
An individual document in a room.
12 properties
DependsOn
object
Contains information about a parent field on which this field depends.
2 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

docusign-rooms-api-openapi.yml Raw ↑

Other APIs Docusign publishes across the network.

Docusign Web Forms API
Docusign Notary API
Docusign Navigator API
Docusign Workspaces API
Docusign CLM API
Docusign Connected Fields API
Docusign AccountBrands API
Docusign AccountConsumerDisclosures API
Docusign AccountCustomFields API
Docusign AccountPasswordRules API
Docusign AccountPermissionProfiles API
Docusign Accounts API
Where this information came from

This is an independent, third-party profile of Docusign Rooms API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.