Workspaces - Create a Workspace | Webex for Developers

Create a Workspace

Create a workspace.

The locationId, workspaceLocationId, floorId, indoorNavigation, capacity, type, notes and hotdeskingStatus parameters are optional, and omitting them will result in the creation of a workspace without these values set, or set to their default. A locationId must be provided when the floorId is set. Calendar and calling can also be set for a new workspace. Omitting them will default to free calling and no calendaring. The orgId parameter can only be used by admin users of another organization (such as partners).

Information for Webex Calling fields may be found here: locations, available numbers and licenses.
The locationId and supportedDevices fields cannot be changed once configured.
When creating a webexCalling workspace, a locationId and either a phoneNumber or extension or both is required. Furthermore, it is possible to set the licenses field with a list of Webex Calling license IDs, if desired. If multiple license IDs are provided, the oldest suitable one will be applied. If no licenses are supplied, the oldest suitable one from the active subscriptions will be automaticaly applied.

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.

locationId

string

Location associated with the workspace. Must be provided when the floorId is set.

workspaceLocationId

string

Legacy workspace location ID associated with the workspace. Prefer locationId.

floorId

string

Floor associated with the workspace.

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

string

No workspace type set.

focus

string

High concentration.

huddle

string

Brainstorm/collaboration.

meetingRoom

string

Dedicated meeting space.

open

string

Unstructured agile.

desk

string

Individual.

other

string

Unspecified.

sipAddress

string

The sipAddress field can only be provided when calling type is thirdPartySipCalling.

calling

object

Calling.

type

enum

The calling type that is supported on the workspace.

freeCalling

string

Free Calling (Default).

hybridCalling

string

Hybrid Calling.

webexCalling

string

Webex Calling.

webexEdgeForDevices

string

Webex Edge For Devices.

thirdPartySipCalling

string

Third-party SIP URI.

none

string

No Calling.

webexCalling

object

The webexCalling object only applies when calling type is webexCalling.

phoneNumber

string

End user phone number.

extension

string

End user extension.

locationId

string

Calling location ID.

licenses

array[string]

A list of Webex Calling License IDs. If multiple license IDs are provided, the oldest suitable one will be applied.

Y2lzY29g4...1

string

Y2lzY29g4...2

string

Y2lzY29g4...n

string

calendar

object

Workspace calendar configuration requires a type (microsoft, google, or none), an emailAddress, and a resourceGroupId. The default is none.

type

string

emailAddress

string

Workspace email address. Will not be set when the calendar type is none.

resourceGroupId

string

The ResourceGroup ID is associated with the workspace and is only applicable for on-premise MICROSOFT calendar.

notes

string

Notes associated to the workspace.

hotdeskingStatus

enum

Hot desking status of the workspace.

string

Workspace supports hotdesking.

off

string

Workspace does not support hotdesking.

deviceHostedMeetings

object

To enable device hosted meetings, set a Webex siteUrl and the enabled flag to true.

enabled

boolean

Set to true to enable or false to disable.

siteUrl

string

The Webex site for device hosting meetings.

supportedDevices

enum

The supported devices for the workspace. Default is collaborationDevices.

collaborationDevices

string

Workspace supports collaboration devices.

phones

string

Workspace supports MPP phones.

indoorNavigation

object

Indoor navigation configuration.

url

string

URL of a map locating the workspace.

Response Properties

string

Unique identifier for the Workspace.

orgId

string

OrgId associated with the workspace.

locationId

string

Location associated with the workspace (ID to use for the /locations API).

workspaceLocationId

string

Legacy workspace location ID associated with the workspace. Prefer locationId.

floorId

string

Floor associated with 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

string

No workspace type set.

focus

string

High concentration.

huddle

string

Brainstorm/collaboration.

meetingRoom

string

Dedicated meeting space.

open

string

Unstructured agile.

desk

string

Individual.

other

string

Unspecified.

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.

calling

object

Calling type.

type

enum

Calling.

freeCalling

string

Free Calling.

hybridCalling

string

Hybrid Calling.

webexCalling

string

Webex Calling.

webexEdgeForDevices

string

Webex Edge For Devices.

thirdPartySipCalling

string

Third-party SIP URI.

none

string

No Calling.

hybridCalling

object

The hybridCalling object only applies when calling type is hybridCalling.

emailAddress

string

End user email address in Cisco Unified CM.

webexCalling

object

The webexCalling object only applies when calling type is webexCalling.

licenses

array[string]

The Webex Calling license associated with this workspace.

calendar

object

Calendar type. Calendar of type none does not include an emailAddress field.

type

enum

none

string

No calendar.

google

string

Google Calendar.

microsoft

string

Microsoft Exchange or Office 365.

emailAddress

string

Workspace email address. Will not be set when the calendar type is none.

notes

string

Notes associated to the workspace.

hotdeskingStatus

enum

Hot desking status of the workspace.

string

Workspace supports hotdesking.

off

string

Workspace does not support hotdesking.

supportedDevices

enum

The supported devices for the workspace. Default is collaborationDevices.

collaborationDevices

string

Workspace supports collaboration devices.

phones

string

Workspace supports MPP phones.

calendar

object

Calendar type. Calendar of type none does not include an emailAddress field.

type

enum

none

string

No calendar.

google

string

Google Calendar.

microsoft

string

Microsoft Exchange or Office 365.

emailAddress

string

Workspace email address. Will not be set when the calendar type is none.

deviceHostedMeetings

object

Device hosted meetings configuration.

enabled

boolean

true if enabled or false otherwise.

siteUrl

string

The Webex site for the device hosting meetings.

devicePlatform

enum

The device platform.

cisco

string

Cisco.

microsoftTeamsRoom

string

Microsoft Teams Room.

indoorNavigation

object

Indoor navigation configuration.

url

string

URL of a map locating the workspace.

Response Codes

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

Code	Status	Description
200	OK	Successful request with body content.
201	Created	The request has succeeded and has led to the creation of a resource.
202	Accepted	The request has been accepted for processing.
204	No Content	Successful request without body content.
400	Bad Request	The request was invalid or cannot be otherwise served. An accompanying error message will explain further.
401	Unauthorized	Authentication credentials were missing or incorrect.
403	Forbidden	The request is understood, but it has been refused or access is not allowed.
404	Not Found	The 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.
405	Method Not Allowed	The request was made to a resource using an HTTP request method that is not supported.
409	Conflict	The 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.
410	Gone	The requested resource is no longer available.
415	Unsupported Media Type	The request was made to a resource without specifying a media type or used a media type that is not supported.
423	Locked	The 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.
428	Precondition Required	File(s) cannot be scanned for malware and need to be force downloaded.
429	Too Many Requests	Too 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.
500	Internal Server Error	Something went wrong on the server. If the issue persists, feel free to contact the Webex Developer Support team.
502	Bad Gateway	The server received an invalid response from an upstream server while processing the request. Try again later.
503	Service Unavailable	Server is overloaded with requests. Try again later.
504	Gateway Timeout	An upstream server failed to respond on time. If your query uses `max` parameter, please try to reduce it.

POST

/v1/workspaces

Header

Content-Type
Authorization
Use personal access token
Bearer
This limited-duration personal access token is hidden for your security.

Body

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.
locationId
string
Location associated with the workspace. Must be provided when the `floorId` is set.
workspaceLocationId
string
Legacy workspace location ID associated with the workspace. Prefer `locationId`.
floorId
string
Floor associated with the workspace.
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.
sipAddress
string
The `sipAddress` field can only be provided when calling type is `thirdPartySipCalling`.
calling
object
Calling.
calendar
object
Workspace calendar configuration requires a `type` (`microsoft`, `google`, or `none`), an `emailAddress`, and a `resourceGroupId`. The default is `none`.
notes
string
Notes associated to the workspace.
hotdeskingStatus
enum
Hot desking status of the workspace.
deviceHostedMeetings
object
To enable device hosted meetings, set a Webex `siteUrl` and the `enabled` flag to `true`.
supportedDevices
enum
The supported devices for the workspace. Default is `collaborationDevices`.
indoorNavigation
object
Indoor navigation configuration.

{
  "displayName": "SFO-12 Capanina",
  "orgId": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi8xZWI2NWZkZi05NjQzLTQxN2YtOTk3NC1hZDcyY2FlMGUxMGY",
  "locationId": "YL34GrT...",
  "workspaceLocationId": "YL34GrT...",
  "floorId": "Y2lzY29z...",
  "capacity": 5,
  "type": "notSet",
  "calling": {
    "type": "webexCalling",
    "webexCalling": {
      "phoneNumber": "+12145654032",
      "extension": "28278",
      "locationId": "Y2lzY29g4...",
      "licenses": [
        "Y2lzY29g4...1",
        "Y2lzY29g4...2",
        "Y2lzY29g4...n"
      ]
    }
  },
  "calendar": {
    "type": "microsoft",
    "emailAddress": "workspace@example.com",
    "resourceGroupId": "Y2lzY29zcGFyazovL3VybjpURUFNOk5vcndheS9SRVNPVVJDRV9HUk9VUC9jOGFiMDJhNC01NjI5LTRiNTctOGUyNy03ZDZkZjJlN2YzNzA="
  },
  "notes": "this is a note",
  "hotdeskingStatus": "on",
  "deviceHostedMeetings": {
    "enabled": true,
    "siteUrl": "'example.webex.com'"
  },
  "supportedDevices": "collaborationDevices",
  "indoorNavigation": {}
}

201 / Created

{
    "id": "Y2lzY29zcGFyazovL3VzL1BMQUNFUy81MTAxQjA3Qi00RjhGLTRFRjctQjU2NS1EQjE5QzdCNzIzRjc",
    "orgId": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi8xZWI2NWZkZi05NjQzLTQxN2YtOTk3NC1hZDcyY2FlMGUxMGY",
    "locationId": "YL34GrT...",
    "workspaceLocationId": "YL34GrT...",
    "floorId": "Y2lzY29z...",
    "displayName": "SFO-12 Capanina",
    "capacity": 5,
    "sipAddress": "test_workspace_1@trialorg.room.ciscospark.com",
    "created": "2016-04-21T17:00:00.000Z",
    "calling": {
      "type": "webexCalling",
      "webexCalling": {
         "licenses": [
            "Y2lzY29zcGFyazovL3VzL0xJQ0VOU0UvMmQzMzIyZDItYTAzNS00YmEzLWI3ZjYtNDc1ODM3Y2UzOTVhOkJDQ0FfNDZlM2YxYWQtZGJhYi00YmQ0LTg3YTAtOWExZmVhNzMxN2Jm"
         ]
      }
    },
    "calendar": {
      "type": "microsoft",
      "emailAddress": "workspace@example.com"
    },
    "notes": "this is a note",
    "supportedDevices": "collaborationDevices",
    "indoorNavigation": {
        "url": "https://example.com"
    }
}