Workspaces: create

Creates a new workspace.

Request

HTTP request

POST /v2/accounts/{accountId}/workspaces

Parameters

Parameter name Value Description
Path parameters
accountId string

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

Request Body

Responses

Code Description Reference
201 Created Successful response.
400 Bad Request Error encountered.

SDK Method

Workspaces::createWorkspace

Definitions Expand All | Collapse All

Workspaces

billableAccountId string
created string

The UTC DateTime when the workspace user authorization was created.

createdByInformation workspaceUser
lastModified string

Utc date and time the comment was last updated (can only be done by creator.)

lastModifiedByInformation workspaceUser
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 that may be used to access 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 that may be used to access the workspace.

errorDetails

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

errorCode string

An error code associated with the error.

message string

A short error message.

workspaceUser

A workspaceUser representing the user. This property is only returned in response to user specific GET call.

accountId string

The account ID associated with the envelope.

accountName string

The name of the account that the workspace user belongs to.

activeSince string
created string

The UTC DateTime when the workspace user was created.

createdById string
email string
errorDetails errorDetails
lastModified string

Utc date and time the comment was last updated (can only be done by creator.)

lastModifiedById string
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 user ID of the user being accessed. Generally this is the user ID of the authenticated user, but if the authenticated user is an Admin on the account, this may be another user the Admin user is accessing.

userName string
workspaceId string

Specifies the workspace ID GUID.

workspaceUserBaseUrl string

The relative URI that may be used to access a workspace user.

workspaceUserId string

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>