Create a Workspace Location

Create a location. The cityName and notes parameters are optional, and omitting them will result in the creation of a location without these values set.

POST/v1/workspaceLocations
Body Parameters
displayName
stringrequired

A friendly name for the location.

address
stringrequired

The location address.

countryCode
stringrequired

The location country code (ISO 3166-1).

cityName
string

The location city name.

latitude
numberrequired

The location latitude.

longitude
numberrequired

The location longitude.

notes
string

Notes associated to the location.

Response Properties
id
string

Unique identifier for the location.

orgId
string

Unique identifier for the location org ID.

displayName
string

A friendly name for the location.

address
string

The location address.

countryCode
string

The location country code (ISO 3166-1).

cityName
string

The location city name.

latitude
number

The location latitude.

longitude
number

The location longitude.

notes
string

Notes associated to the location.

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/workspaceLocations
Log in to try the API.
Header
Body
  • A friendly name for the location.
  • The location address.
  • The location country code (ISO 3166-1).
  • The location city name.
  • The location latitude.
  • The location longitude.
  • Notes associated to the location.
{
  "displayName": "Cisco Barcelona",
  "address": "Carrer de Pere IV, Barcelona, Spain",
  "countryCode": "ES",
  "cityName": "Barcelona",
  "latitude": 41.406615,
  "longitude": 2.200717,
  "notes": "A note about the location"
}
201 / Created
{
  "id": "Y2lzY29zcGFyazovL3VybjpURUFNOnVzLWVhc3QtMV9pbnQxMy9XT1JLU1BBQ0VfTE9DQVRJT04vM2E2ZmYzNzMtNjhhNy00NGU0LTkxZDYtYTI3NDYwZTBhYzVjIzUxOWY2N2E1LTlkOTktNGM2My04YTA5LWI5MTcxY2M2NmJkMQ==",
  "orgId": "Y2lzY29zcGFyazovL3VybjpURUFNOnVzLWVhc3QtMl9hL09SR0FOSVpBVElPTi8xZWI2NWZkZi05NjQzLTQxN2YtOTk3NC1hZDcyY2FlMGUxMGY=",
  "displayName": "Cisco Barcelona",
  "address": "Carrer de Pere IV, Barcelona, Spain",
  "countryCode": "ES",
  "cityName": "Barcelona",
  "latitude": 41.406615,
  "longitude": 2.200717,
  "notes": "A note about the location"
}