---
title: "Update Workspace"
method: PUT
path: "/v2.1/accounts/{accountId}/workspaces/{workspaceId}"
tags: ["Workspaces"]
---

# Update Workspace

`PUT /v2.1/accounts/{accountId}/workspaces/{workspaceId}`

## Request

- Base URL: `https://www.docusign.net/restapi`
- URL: `https://www.docusign.net/restapi/v2.1/accounts/{accountId}/workspaces/{workspaceId}`
- Auth: none declared

Updates information about a specific workspace.

## Path parameters

- `accountId` string, required
- `workspaceId` string, required

## Request body

- Workspace: A Docusign workspace is a collaboration area for sharing files and data.
  - `billableAccountId` string: The ID of the account to bill.
  - `callerInformation` WorkspaceUser: This object represents the workspace user. This property is only returned in response to user specific GET call.
    - `accountId` string: The account ID associated with the workspace user.
    - `accountName` string: The name of the account that the workspace user belongs to.
    - `activeSince` string: The UTC DateTime when the user joined the workspace.
    - `created` string: The UTC DateTime when the workspace user was created.
    - `createdById` string: The ID of the user who created this workspace user.
    - `email` string: The workspace user's email address.
    - `errorDetails` ErrorDetails: This object describes errors that occur. It is only valid for responses and ignored in requests.
      - `errorCode` string: The code associated with the error condition.
      - `message` string: A brief message describing the error condition.
    - `invitationEmailBlurb` string: The text of the workspace invitation email message sent to the user.
    - `invitationEmailSubject` string: The subject line of the workspace invitation email message sent to the user.
    - `lastModified` string: The UTC DateTime that the workspace user was last modified.
    - `lastModifiedById` string: The ID of the user who last modified the workspace user.
    - `status` string: Filters the results by user status. You can specify a comma-separated list of the following statuses: * ActivationRequired * ActivationSent * Active * Closed * Disabled
    - `type` string: Type of the user. Valid values: type_owner, type_participant.
    - `userId` string: The ID of the workspace user.
    - `userName` string: The name of workspace user.
    - `workspaceId` string: The ID of the workspace.
    - `workspaceUserBaseUrl` string: The URL for accessing the workspace user.
    - `workspaceUserId` string: The ID of the workspace user.
    - `workspaceUserUri` string: The URI for accessing the workspace user.
  - `created` string: The UTC DateTime when the workspace user authorization was created.
  - `createdByInformation` WorkspaceUser: This object represents the workspace user. This property is only returned in response to user specific GET call.
    - `accountId` string: The account ID associated with the workspace user.
    - `accountName` string: The name of the account that the workspace user belongs to.
    - `activeSince` string: The UTC DateTime when the user joined the workspace.
    - `created` string: The UTC DateTime when the workspace user was created.
    - `createdById` string: The ID of the user who created this workspace user.
    - `email` string: The workspace user's email address.
    - `errorDetails` ErrorDetails: This object describes errors that occur. It is only valid for responses and ignored in requests.
      - `errorCode` string: The code associated with the error condition.
      - `message` string: A brief message describing the error condition.
    - `invitationEmailBlurb` string: The text of the workspace invitation email message sent to the user.
    - `invitationEmailSubject` string: The subject line of the workspace invitation email message sent to the user.
    - `lastModified` string: The UTC DateTime that the workspace user was last modified.
    - `lastModifiedById` string: The ID of the user who last modified the workspace user.
    - `status` string: Filters the results by user status. You can specify a comma-separated list of the following statuses: * ActivationRequired * ActivationSent * Active * Closed * Disabled
    - `type` string: Type of the user. Valid values: type_owner, type_participant.
    - `userId` string: The ID of the workspace user.
    - `userName` string: The name of workspace user.
    - `workspaceId` string: The ID of the workspace.
    - `workspaceUserBaseUrl` string: The URL for accessing the workspace user.
    - `workspaceUserId` string: The ID of the workspace user.
    - `workspaceUserUri` string: The URI for accessing the workspace user.
  - `lastModified` string: Utc date and time the comment was last updated (can only be done by creator.)
  - `lastModifiedByInformation` WorkspaceUser: This object represents the workspace user. This property is only returned in response to user specific GET call.
    - `accountId` string: The account ID associated with the workspace user.
    - `accountName` string: The name of the account that the workspace user belongs to.
    - `activeSince` string: The UTC DateTime when the user joined the workspace.
    - `created` string: The UTC DateTime when the workspace user was created.
    - `createdById` string: The ID of the user who created this workspace user.
    - `email` string: The workspace user's email address.
    - `errorDetails` ErrorDetails: This object describes errors that occur. It is only valid for responses and ignored in requests.
      - `errorCode` string: The code associated with the error condition.
      - `message` string: A brief message describing the error condition.
    - `invitationEmailBlurb` string: The text of the workspace invitation email message sent to the user.
    - `invitationEmailSubject` string: The subject line of the workspace invitation email message sent to the user.
    - `lastModified` string: The UTC DateTime that the workspace user was last modified.
    - `lastModifiedById` string: The ID of the user who last modified the workspace user.
    - `status` string: Filters the results by user status. You can specify a comma-separated list of the following statuses: * ActivationRequired * ActivationSent * Active * Closed * Disabled
    - `type` string: Type of the user. Valid values: type_owner, type_participant.
    - `userId` string: The ID of the workspace user.
    - `userName` string: The name of workspace user.
    - `workspaceId` string: The ID of the workspace.
    - `workspaceUserBaseUrl` string: The URL for accessing the workspace user.
    - `workspaceUserId` string: The ID of the workspace user.
    - `workspaceUserUri` string: The URI for accessing the workspace user.
  - `settings` WorkspaceSettings: This object provides information about the settings for the workspace.
    - `commentsAllowed` string: When **true,** commenting on the documents in the workspace is allowed.
  - `status` string: Indicates the envelope status. Valid values are: * sent - The envelope is sent to the recipients. * created - The envelope is saved as a draft and can be modified and sent later.
  - `workspaceBaseUrl` string: The relative URL for accessing the workspace.
  - `workspaceDescription` string: Text describing the purpose of the workspace.
  - `workspaceId` string: The ID of the workspace, always populated.
  - `workspaceName` string: The name of the workspace.
  - `workspaceUri` string: The relative URI for accessing the workspace.

## Response `200`

Successful response.

## Other responses

- `400`: Error encountered.

---

[API](https://skmtc.dev/docusign/apis/docusign-esignature-rest-api.md) - [All operations](https://skmtc.dev/docusign/apis/docusign-esignature-rest-api/llms.txt) - [OpenAPI document](https://skmtc.dev/docusign/apis/docusign-esignature-rest-api/revisions/77f1998c313d?raw)