Workspaces

Create a Workspace

POST
/v2.1/accounts/{accountId}/workspaces

This method creates a new workspace.

Authorization

OAuth2
AuthorizationBearer <token>

OAuth 2.0 access token obtained via Authorization Code Grant or JWT Grant.

In: header

Path Parameters

accountId*string

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

Request Body

application/json

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

billableAccountId?string

The ID of the account to bill.

callerInformation?

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

created?string

The UTC DateTime when the workspace user authorization was created.

createdByInformation?

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

lastModified?string

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

lastModifiedByInformation?

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

settings?

This object provides information about the settings for the workspace.

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 Body

application/json

application/json

curl -X POST "https://example.com/v2.1/accounts/string/workspaces" \  -H "Content-Type: application/json" \  -d '{}'
{  "billableAccountId": "string",  "callerInformation": {    "accountId": "string",    "accountName": "string",    "activeSince": "string",    "created": "string",    "createdById": "string",    "email": "string",    "errorDetails": {      "errorCode": "string",      "message": "string"    },    "invitationEmailBlurb": "string",    "invitationEmailSubject": "string",    "lastModified": "string",    "lastModifiedById": "string",    "status": "string",    "type": "string",    "userId": "string",    "userName": "string",    "workspaceId": "string",    "workspaceUserBaseUrl": "string",    "workspaceUserId": "string",    "workspaceUserUri": "string"  },  "created": "string",  "createdByInformation": {    "accountId": "string",    "accountName": "string",    "activeSince": "string",    "created": "string",    "createdById": "string",    "email": "string",    "errorDetails": {      "errorCode": "string",      "message": "string"    },    "invitationEmailBlurb": "string",    "invitationEmailSubject": "string",    "lastModified": "string",    "lastModifiedById": "string",    "status": "string",    "type": "string",    "userId": "string",    "userName": "string",    "workspaceId": "string",    "workspaceUserBaseUrl": "string",    "workspaceUserId": "string",    "workspaceUserUri": "string"  },  "lastModified": "string",  "lastModifiedByInformation": {    "accountId": "string",    "accountName": "string",    "activeSince": "string",    "created": "string",    "createdById": "string",    "email": "string",    "errorDetails": {      "errorCode": "string",      "message": "string"    },    "invitationEmailBlurb": "string",    "invitationEmailSubject": "string",    "lastModified": "string",    "lastModifiedById": "string",    "status": "string",    "type": "string",    "userId": "string",    "userName": "string",    "workspaceId": "string",    "workspaceUserBaseUrl": "string",    "workspaceUserId": "string",    "workspaceUserUri": "string"  },  "settings": {    "commentsAllowed": "string"  },  "status": "string",  "workspaceBaseUrl": "string",  "workspaceDescription": "string",  "workspaceId": "string",  "workspaceName": "string",  "workspaceUri": "string"}