Create a Workspace

Create a workspace. The capacity and type parameters are optional, and omitting them will result in the creation of a workspace without a capacity and/or type set.

The orgId parameter can only be used by admin users of another organization (such as partners).

POST/v1/workspaces
Body Parameters
displayName
stringrequired

A friendly name for the workspace.

orgId
string

OrgId associated with the workspace. Only admin users of another organization (such as partners) may use this parameter.

capacity
number

How many people the workspace is suitable for. If set, must be 0 or higher.

type
enum

The type that best describes the workspace.

notSet

No workspace type set.

focus

High concentration.

huddle

Brainstorm/collaboration.

meetingRoom

Dedicated meeting space.

open

Unstructured agile.

desk

Individual.

other

Unspecified.

Response Properties
id
string

Unique identifier for the Workspace.

displayName
string

A friendly name for the workspace.

capacity
number

How many people the workspace is suitable for.

type
enum

The workspace type.

notSet

No workspace type set.

focus

High concentration.

huddle

Brainstorm/collaboration.

meetingRoom

Dedicated meeting space.

open

Unstructured agile.

desk

Individual.

other

Unspecified.

orgId
string

OrgId associate with the workspace

sipAddress
string

SipUrl to call all the devices associated with the workspace.

created
string

The date and time that the workspace was registered, in ISO8601 format.

Response Codes

The list below describes the common success and error responses you should expect from the API.

CodeStatusDescription
200OKSuccessful request with body content.
204No ContentSuccessful request without body content.
400Bad RequestThe request was invalid or cannot be otherwise served. An accompanying error message will explain further.
401UnauthorizedAuthentication credentials were missing or incorrect.
403ForbiddenThe request is understood, but it has been refused or access is not allowed.
404Not FoundThe URI requested is invalid or the resource requested, such as a user, does not exist. Also returned when the requested format is not supported by the requested method.
405Method Not AllowedThe request was made to a resource using an HTTP request method that is not supported.
409ConflictThe request could not be processed because it conflicts with some established rule of the system. For example, a person may not be added to a room more than once.
410GoneThe requested resource is no longer available.
415Unsupported Media TypeThe request was made to a resource without specifying a media type or used a media type that is not supported.
423LockedThe requested resource is temporarily unavailable. A Retry-After header may be present that specifies how many seconds you need to wait before attempting the request again.
428Precondition RequiredFile(s) cannot be scanned for malware and need to be force downloaded.
429Too Many RequestsToo many requests have been sent in a given amount of time and the request has been rate limited. A Retry-After header should be present that specifies how many seconds you need to wait before a successful request can be made.
500Internal Server ErrorSomething went wrong on the server. If the issue persists, feel free to contact the Webex Developer Support team.
502Bad GatewayThe server received an invalid response from an upstream server while processing the request. Try again later.
503Service UnavailableServer is overloaded with requests. Try again later.
504Gateway TimeoutAn upstream server failed to respond on time. If your query uses max parameter, please try to reduce it.
POST
/v1/workspaces
Log in to try the API.
Header
Body
  • A friendly name for the workspace.
  • OrgId associated with the workspace. Only admin users of another organization (such as partners) may use this parameter.
  • How many people the workspace is suitable for. If set, must be 0 or higher.
  • The type that best describes the workspace.
{
  "displayName": "SFO-12 Capanina",
  "orgId": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi8xZWI2NWZkZi05NjQzLTQxN2YtOTk3NC1hZDcyY2FlMGUxMGY",
  "capacity": 5,
  "type": "notSet"
}
201 / Created
{
  "id": "Y2lzY29zcGFyazovL3VzL1BMQUNFUy81MTAxQjA3Qi00RjhGLTRFRjctQjU2NS1EQjE5QzdCNzIzRjc",
  "displayName": "SFO-12 Capanina",
  "capacity": 5,
  "type": "notSet",
  "orgId": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi8xZWI2NWZkZi05NjQzLTQxN2YtOTk3NC1hZDcyY2FlMGUxMGY",
  "sipAddress": "test_workspace_1@trialorg.room.ciscospark.com",
  "created": "2016-04-21T17:00:00.000Z"
}