updateRoomGroup
RoomGroupWrapper updateRoomGroup(id, UpdateRoomGroupRequest)
PUT /api/2.0/files/group/{id}
Update room group
Applies changes to one of the caller's own room groups: a new name, rooms to attach, rooms to detach, or any combination of the three in a single call. A body that carries none of the three ({}) is accepted and changes nothing, while a body that names them and leaves every one of them empty asks for an update that cannot be performed and is rejected as an invalid request. roomsToAdd is resolved the way creation resolves its list: every identifier has to name a room the caller can read, repeats and rooms already in the group are collapsed, and when only part of the list resolves the rest is still attached and the call is reported as failed. roomsToRemove works the other way round - a room already in the group is always detached, even when the caller has since lost access to it, whereas an identifier that is not in the group is resolved first and refused when it names nothing. The steps are applied in order and are not rolled back when a later one fails. A group of another account is answered as missing. The answer is the group as stored after the call.
Parameters
| Name | In | Type | Description | Notes |
|---|---|---|---|---|
| id | path | Integer (int32) | The room group to change, identified by the value GET api/2.0/files/group reports for it. A group of another account cannot be addressed and reads as missing. | [required] [example: 42] |
| UpdateRoomGroupRequest | body | UpdateRoomGroupRequest | The changes to apply. Carrying none of them leaves the group as it is, and each of them may be sent on its own or together with the others. | [required] |
Responses
| Status code | Description | Type | Response headers |
|---|---|---|---|
| 200 | The room group as stored after the change | RoomGroupWrapper | X-RateLimit-Limit, X-RateLimit-Remaining, X-RateLimit-Reset |
| 400 | The request body cannot be read or names its members with every one of them null, the new name is blank or longer than 128 characters, a room identifier is neither a positive number nor a non-numeric string, a third-party room identifier refers to a storage account that is not connected, or none of the rooms of roomsToAdd can be added and the existing ones all belong to the other section than the group | - | - |
| 403 | The rooms of roomsToAdd, or the rooms of roomsToRemove that are not in the group, exist but none of them is a room the caller can read, or only some of the rooms could be applied - the earlier steps stay applied | - | - |
| 404 | The group does not exist or belongs to another account, none of the rooms of roomsToAdd or of the rooms of roomsToRemove that are not in the group exists, or a string room identifier does not name a third-party storage | - | - |
| 500 | A third-party room identifier carries a storage account number beyond the 32-bit range | - | - |
| 401 | Unauthorized | ErrorApiResponse | - |
| 429 | Too Many Requests. | ErrorApiResponse | Retry-After |
| 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