Workspaces: update

Updates information about a specific workspace.

Request

HTTP request

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

Parameters

Parameter NameValueDescription
Path Parameters
accountIdstring

The external account number (int) or account ID GUID.

workspaceIdstring

The id of the workspace.

Request Body

Workspaces

Responses

CodeDescriptionReference
200

Successful response.

Workspaces
400

Error encountered.

errorDetails

SDK Method

Workspaces::updateWorkspace

Definitions

errorDetails

This object describes errors that occur. It is only valid for responses and ignored in requests.

errorCodestring

The code associated with the error condition.

messagestring

A brief message describing the error condition.

workspaceSettings

This object provides information about the settings for the workspace.

commentsAllowedstring

When true, commenting on the documents in the workspace is allowed.

workspaceUser

This object represents the workspace user. This property is only returned in response to user specific GET call.

accountIdstring

The account ID associated with the workspace user.

accountNamestring

The name of the account associated with the current workspace user.

activeSincestring

The UTC DateTime when the user joined the workspace.

createdstring

The UTC DateTime when the workspace user was created.

createdByIdstring

The id of the user who created this workspace user.

emailstring

The workspace user's email address.

errorDetailserrorDetails

This object describes errors that occur. It is only valid for responses and ignored in requests.

invitationEmailBlurbstring

The text of the workspace invitation email message sent to the user.

invitationEmailSubjectstring

The subject line of the workspace invitation email message sent to the user.

lastModifiedstring

The UTC DateTime that the workspace user was last modified.

lastModifiedByIdstring

The id of the user who last modified the workspace user.

statusstring

Filters the results by user status. You can specify a comma-separated list of the following statuses:

  • ActivationRequired
  • ActivationSent
  • Active
  • Closed
  • Disabled

typestring

userIdstring

The id of the workspace user.

userNamestring

The name of workspace user.

workspaceIdstring

The id of the workspace.

workspaceUserBaseUrlstring

The URL for accessing the workspace user.

workspaceUserIdstring

The id of the workspace user.

workspaceUserUristring

The URI for accessing the workspace user.

Workspaces

A DocuSign workspace is a collaboration area for sharing files and data.

billableAccountIdstring

The id of the account to bill.

callerInformationworkspaceUser

createdstring

The UTC DateTime when the workspace user authorization was created.

createdByInformationworkspaceUser

Details about the user who created the workspace.

lastModifiedstring

The UTC date and time that the comment was last updated.

Note: This can only be done by the creator.

lastModifiedByInformationworkspaceUser

Details about the user who last modified the workspace.

settingsworkspaceSettings

Information about the settings for the workspace.

statusstring

The status of the workspace. Valid values are:

  • active
  • closed

workspaceBaseUrlstring

The relative URL for accessing the workspace.

workspaceDescriptionstring

Text describing the purpose of the workspace.

workspaceIdstring

The id of the workspace.

workspaceNamestring

The name of the workspace.

workspaceUristring

The relative URI for accessing the workspace.

Examples

Generic JSON Request/Response

Request
{
  "workspaceName": "sample string 1",
  "workspaceDescription": "sample string 2",
  "status": "sample string 3"
}
Response
{
  "workspaceId": "sample string 1",
  "workspaceName": "sample string 2",
  "workspaceDescription": "sample string 3",
  "status": "sample string 4",
  "workspaceUri": "sample string 5",
  "workspaceBaseUrl": "sample string 6",
  "billableAccountId": "sample string 7",
  "created": "sample string 8",
  "createdByInformation": {
    "workspaceUserId": "sample string 1",
    "status": "sample string 2",
    "type": "sample string 3",
    "workspaceId": "sample string 4",
    "accountId": "sample string 5",
    "userId": "sample string 6",
    "accountName": "sample string 7",
    "userName": "sample string 8",
    "email": "sample string 9",
    "workspaceUserBaseUrl": "sample string 10",
    "created": "sample string 11",
    "createdById": "sample string 12",
    "lastModified": "sample string 13",
    "lastModifiedById": "sample string 14",
    "activeSince": "sample string 15",
    "errorDetails": {
      "errorCode": "sample string 1",
      "message": "sample string 2"
    }
  },
  "lastModified": "sample string 9",
  "lastModifiedByInformation": {}
}
Generic XML Request/Response

Request
<workspace xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://www.docusign.com/restapi">
  <status>sample string 3</status>
  <workspaceDescription>sample string 2</workspaceDescription>
  <workspaceName>sample string 1</workspaceName>
</workspace> 
Response
<workspace xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://www.docusign.com/restapi">
  <billableAccountId>sample string 7</billableAccountId>
  <created>sample string 8</created>
  <createdByInformation>
    <accountId>sample string 5</accountId>
    <accountName>sample string 7</accountName>
    <activeSince>sample string 15</activeSince>
    <created>sample string 11</created>
    <createdById>sample string 12</createdById>
    <email>sample string 9</email>
    <errorDetails>
      <errorCode>sample string 1</errorCode>
      <message>sample string 2</message>
    </errorDetails>
    <lastModified>sample string 13</lastModified>
    <lastModifiedById>sample string 14</lastModifiedById>
    <status>sample string 2</status>
    <type>sample string 3</type>
    <userId>sample string 6</userId>
    <userName>sample string 8</userName>
    <workspaceId>sample string 4</workspaceId>
    <workspaceUserBaseUrl>sample string 10</workspaceUserBaseUrl>
    <workspaceUserId>sample string 1</workspaceUserId>
  </createdByInformation>
  <lastModified>sample string 9</lastModified>
  <lastModifiedByInformation />
  <status>sample string 4</status>
  <workspaceBaseUrl>sample string 6</workspaceBaseUrl>
  <workspaceDescription>sample string 3</workspaceDescription>
  <workspaceId>sample string 1</workspaceId>
  <workspaceName>sample string 2</workspaceName>
  <workspaceUri>sample string 5</workspaceUri>
</workspace> 
}} />