API template library

Simulate the DocuSign Rooms API

A WireMock simulation of DocuSign's REST API — covering real estate transaction rooms with members, documents, field data, folders, task lists and envelopes, plus company users, offices, regions, roles and form libraries.

Vendor
DocuSign
Functionality
Rooms, offices, users, roles, task lists
Spec version
1.0.0
Endpoints
89
Stubs
325
Protocol
REST
Validation
AI-validated Before publication, an AI agent exercised these endpoints against the real DocuSign API through WireMock's recording proxy, and the recorded traffic was used to verify each stub's request and response shapes.

Live sandbox · no signup, no API key

DocuSign Rooms API

A running WireMock Cloud instance of this template, callable right now from a terminal, a script, or an AI agent.

Base URL
https://jg962q.wiremockapi.cloud

GET List room templates

curl -s -X GET 'https://jg962q.wiremockapi.cloud/restapi/v2/accounts/2f5a7c9e-1b3d-4f6a-8c2e-4a6b8d0f2a41/room_templates' \
  -H 'Authorization: Bearer YOUR_ACCESS_TOKEN'

POST Create a listing room from the Residential Listing template

curl -s -X POST 'https://jg962q.wiremockapi.cloud/restapi/v2/accounts/2f5a7c9e-1b3d-4f6a-8c2e-4a6b8d0f2a41/rooms' \
  -H 'Authorization: Bearer YOUR_ACCESS_TOKEN' \
  -H 'Content-Type: application/json' \
  -d '{"name":"42 Juniper Lane","roleId":103,"templateId":301,"fieldData":{"data":{"address1":"42 Juniper Lane","city":"Portland","state":"US-OR","propertyType":"single_family","listingPrice":650000}}}'

GET List company and external roles

curl -s -X GET 'https://jg962q.wiremockapi.cloud/restapi/v2/accounts/2f5a7c9e-1b3d-4f6a-8c2e-4a6b8d0f2a41/roles' \
  -H 'Authorization: Bearer YOUR_ACCESS_TOKEN'
Method Path Summary
GET /restapi/v2/accounts/{accountId} Gets account information.
DELETE /restapi/v2/accounts/{accountId}/documents/{documentId} Deletes a specified document.
GET /restapi/v2/accounts/{accountId}/documents/{documentId} Gets information about or the contents of a document.
POST /restapi/v2/accounts/{accountId}/documents/{documentId}/users Grants a user access to a document.
GET /restapi/v2/accounts/{accountId}/esign_permission_profiles Gets eSignature Permission Profiles.
POST /restapi/v2/accounts/{accountId}/external_form_fill_sessions Creates an external form fill session.
GET /restapi/v2/accounts/{accountId}/field_sets/{fieldSetId} Gets a field set.
GET /restapi/v2/accounts/{accountId}/form_groups Gets form groups.
POST /restapi/v2/accounts/{accountId}/form_groups Creates a form group.
DELETE /restapi/v2/accounts/{accountId}/form_groups/{formGroupId} Deletes a form group.
GET /restapi/v2/accounts/{accountId}/form_groups/{formGroupId} Gets a form group.
PUT /restapi/v2/accounts/{accountId}/form_groups/{formGroupId} Renames a form group.
POST /restapi/v2/accounts/{accountId}/form_groups/{formGroupId}/assign_form Assigns a form to a form group.
GET /restapi/v2/accounts/{accountId}/form_groups/{formGroupId}/forms Get forms of the specified form group.
POST /restapi/v2/accounts/{accountId}/form_groups/{formGroupId}/grant_office_access/{officeId} Grants an office access to a form group.
POST /restapi/v2/accounts/{accountId}/form_groups/{formGroupId}/revoke_office_access/{officeId} Revoke an office's access to a form group.
POST /restapi/v2/accounts/{accountId}/form_groups/{formGroupId}/unassign_form/{formId} Removes a form from a form group.
GET /restapi/v2/accounts/{accountId}/form_libraries Gets form libraries.
GET /restapi/v2/accounts/{accountId}/form_libraries/{formLibraryId}/forms Gets the forms in a form library.
GET /restapi/v2/accounts/{accountId}/form_providers/{providerId}/associations Gets all associations by provider.
GET /restapi/v2/accounts/{accountId}/forms/{formId}/details Gets form details.
GET /restapi/v2/accounts/{accountId}/offices Gets offices.
POST /restapi/v2/accounts/{accountId}/offices Creates an office.
DELETE /restapi/v2/accounts/{accountId}/offices/{officeId} Deletes an office.
GET /restapi/v2/accounts/{accountId}/offices/{officeId} Gets information about an office.
GET /restapi/v2/accounts/{accountId}/offices/{officeId}/reference_counts Get office reference counts
GET /restapi/v2/accounts/{accountId}/regions Gets regions.
POST /restapi/v2/accounts/{accountId}/regions Creates a region.
DELETE /restapi/v2/accounts/{accountId}/regions/{regionId} Deletes a region.
GET /restapi/v2/accounts/{accountId}/regions/{regionId} Gets information about a region.
GET /restapi/v2/accounts/{accountId}/regions/{regionId}/reference_counts Get region reference counts
GET /restapi/v2/accounts/{accountId}/roles Gets roles.
POST /restapi/v2/accounts/{accountId}/roles Creates a role.
DELETE /restapi/v2/accounts/{accountId}/roles/{roleId} Deletes a role.
GET /restapi/v2/accounts/{accountId}/roles/{roleId} Gets a role.
PUT /restapi/v2/accounts/{accountId}/roles/{roleId} Updates a role.
GET /restapi/v2/accounts/{accountId}/room_templates Gets room templates.
GET /restapi/v2/accounts/{accountId}/rooms Returns a list of rooms.
POST /restapi/v2/accounts/{accountId}/rooms Creates a room.
DELETE /restapi/v2/accounts/{accountId}/rooms/{roomId} Deletes a room.
GET /restapi/v2/accounts/{accountId}/rooms/{roomId} Gets a room.
GET /restapi/v2/accounts/{accountId}/rooms/{roomId}/assignable_roles Gets assignable room-level roles in v6.
GET /restapi/v2/accounts/{accountId}/rooms/{roomId}/documents Gets a list of documents in a room.
POST /restapi/v2/accounts/{accountId}/rooms/{roomId}/documents Adds a document to a room.
POST /restapi/v2/accounts/{accountId}/rooms/{roomId}/documents/contents Uploads the contents of a file as a document to a room.
POST /restapi/v2/accounts/{accountId}/rooms/{roomId}/envelopes Creates an envelope with the given documents.
GET /restapi/v2/accounts/{accountId}/rooms/{roomId}/field_data Gets a room's field data.
PUT /restapi/v2/accounts/{accountId}/rooms/{roomId}/field_data Updates a room's field data.
GET /restapi/v2/accounts/{accountId}/rooms/{roomId}/field_set Gets the field set for a room.
POST /restapi/v2/accounts/{accountId}/rooms/{roomId}/forms Adds a form to a room.
PUT /restapi/v2/accounts/{accountId}/rooms/{roomId}/picture Updates the picture for a room.
GET /restapi/v2/accounts/{accountId}/rooms/{roomId}/room_folders Gets a list of room folders accessible to the current user.
GET /restapi/v2/accounts/{accountId}/rooms/{roomId}/task_lists Gets task lists for a room.
POST /restapi/v2/accounts/{accountId}/rooms/{roomId}/task_lists Applies a task list to a room.
GET /restapi/v2/accounts/{accountId}/rooms/{roomId}/users Gets a room's users.
POST /restapi/v2/accounts/{accountId}/rooms/{roomId}/users Invites a user to a room.
PUT /restapi/v2/accounts/{accountId}/rooms/{roomId}/users/{userId} Updates a room user.
POST /restapi/v2/accounts/{accountId}/rooms/{roomId}/users/{userId}/restore_access Restores the specified user's access to the room.
POST /restapi/v2/accounts/{accountId}/rooms/{roomId}/users/{userId}/revoke_access Revokes the specified user's access to the room.
GET /restapi/v2/accounts/{accountId}/task_list_templates Gets task list templates.

+29 more endpoints in the full spec.

Unauthenticated WireMock Cloud demo sandbox for DocuSign — not an official DocuSign sandbox, and it returns simulated example data only.

What's inside the Rooms template

Rooms v2 is the brokerage side of DocuSign, where each property deal gets a room for its documents, people and checklists. Every account is Lucky Shrub Realty, a v6 company with Avery Lucky as its only user, six built-in roles from Default Admin to Lender, two form libraries and four room templates. Everything else is created through the API and numbered from per-account counters: rooms from 1000001, offices from 20001, regions from 3001. A room built from the Residential Listing template arrives with its Listing Checklist and Compliance Review task lists, and its field data is validated against the account's ten-field set.

  • Rooms — create from a template, read, update field data, list, delete, and manage folders and pictures
  • Room members and documents — invite and remove members by role, upload documents, and attach envelopes
  • Task lists — lists applied by the room template, plus task list templates with their tasks
  • Company structure — offices, regions and users with invitations, locking, office and region membership
  • Roles and permissions — built-in and custom roles, assignability filters and eSignature permission profiles
  • Lookups and forms — states, property types, time zones and other reference lists, form libraries and form groups

DocuSign Rooms mock API FAQ

address1, city and state are required when a room is created, state and propertyType must be one of their listed option ids (US-OR, not OR, and single_family), and listingPrice must sit between 0 and 1,000,000,000. A violation answers 400 INVALID_FIELD_DATA with a message naming the field and the rule. Fields outside the field set are stored as custom fields.

Referential integrity is enforced the way a real company account enforces it. A region with an office in it answers 400 REGION_IN_USE, and an office still referenced by users, rooms or form groups is blocked the same way. Delete from the bottom up, or use the reference count operations to see what is holding it.

Three do: Residential Listing, Residential Purchase and Commercial Lease, each applying its task lists when a room is created. The fourth, Legacy Short Sale, is disabled and answers 400 ROOM_TEMPLATE_DISABLED, which lets you test how an integration handles a template an admin has retired.

Yes, all of it. Rooms, offices and users created here are visible to everyone using the public URL, and ids keep counting up. Use invented addresses and names. A private WireMock Cloud copy starts from the same empty company and can be reset. Any Bearer value is accepted; no header at all answers 401 AUTHORIZATION_INVALID_TOKEN.

Vendor names identify APIs represented by WireMock template sources. This page does not imply vendor endorsement, certification, partnership, or official integration status.