Create a Workspace Location
The Workspace Locations API is deprecated and will be decommissioned November 30, 2024. Please use the /locations API for future projects, and use locationId instead of workspaceLocationId when interacting with device or workspace APIs.
Create a location. The cityName and notes parameters are optional, and omitting them will result in the creation of a location without values for those attributes.
Requires an administrator auth token with the spark-admin:workspace_locations_write scope.
Body Parameters
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 with the location.
Response Properties
Unique identifier for the location.
The ID to use for this location in the /locations API
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 with the location.
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. |
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 with 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"
}{
"id": "Y2lzY29zcGFyazovL3VybjpURUFNOnVzLWVhc3QtMV9pbnQxMy9XT1JLU1BBQ0VfTE9DQVRJT04vM2E2ZmYzNzMtNjhhNy00NGU0LTkxZDYtYTI3NDYwZTBhYzVjIzUxOWY2N2E1LTlkOTktNGM2My04YTA5LWI5MTcxY2M2NmJkMQ==",
"locationId": "Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OLzA2OWEzMDY2LTgwNjMtNDI0Zi05YmE0LTBhZDdhMmYxMzNjNQ",
"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"
}