updateRoomTag
StringWrapper updateRoomTag(UpdateTagRequestDto)
PUT /api/2.0/files/tags
Rename a room tag
Renames a custom room tag in the portal catalog. The rename follows the tag everywhere it is used: every room that carries it keeps it and shows the new name, so nothing has to be re-attached afterwards. Only a portal administrator may rename a tag, and a room manager who is allowed to create tags is still refused here. The old name is matched exactly as it is stored rather than searched for, and a name that is not in the catalog is answered as missing. A new name that another tag already occupies is rejected as an invalid request, because tag names are unique across the portal; both names must be non-blank and within the published length limit. The answer is the new name. Stored queries are not updated for the caller: a tags filter of GET api/2.0/files/rooms that still names the old value stops matching anything. The catalog is read with GET api/2.0/files/tags.
Parameters
| Name | In | Type | Description | Notes |
|---|---|---|---|---|
| UpdateTagRequestDto | body | UpdateTagRequestDto | [optional] |
Responses
| Status code | Description | Type | Response headers |
|---|---|---|---|
| 200 | The new name of the renamed tag | StringWrapper | X-RateLimit-Limit, X-RateLimit-Remaining, X-RateLimit-Reset |
| 400 | The request body cannot be read or has no oldName or newName, a name is empty, blank or longer than 255 characters, or a tag with the new name already exists | - | - |
| 403 | Only a portal administrator can rename a tag | - | - |
| 404 | No tag with the old name exists in the catalog | - | - |
| 401 | Unauthorized | ErrorApiResponse | - |
| 429 | Too Many Requests. | ErrorApiResponse | Retry-After |
| 500 | Internal Server Error. | ErrorApiResponse | - |
| 502 | Bad Gateway. Returned by the reverse proxy, response body may be HTML and not JSON. | - | - |
| 503 | Service Unavailable. Returned by the reverse proxy, response body may be HTML and not JSON. | - | - |
Return type
Authorization
Basic, OAuth2 (scopes: read, write), ApiKeyBearer, asc_auth_key, Bearer, OpenId
HTTP request headers
- Content-Type: application/json
- Accept: application/json