deleteGuests
deleteGuests(UpdateMembersRequestDto)
DELETE /api/2.0/people/guests
Remove guest relations
Removes the listed guests from the caller's own list of guests and withdraws the access the caller had granted them. It does not delete the accounts: each guest keeps its profile and any access other members gave it, and only the link to the caller and the caller's own shares disappear. The caller has to be a room admin or a DocSpace admin, and every listed account has to exist, be an active guest and be one of the caller's own guests - a single entry that is not rejects the whole call with 403 and changes nothing. The call returns no body; read GET api/2.0/people/filter with area set to Guests to see what is left. To delete a guest account for good, disable it and then use DELETE api/2.0/people/{userId}.
Parameters
| Name | In | Type | Description | Notes |
|---|---|---|---|---|
| UpdateMembersRequestDto | body | UpdateMembersRequestDto | [optional] |
Responses
| Status code | Description | Type | Response headers |
|---|---|---|---|
| 200 | The guests are no longer linked to the caller. No content is returned | - | X-RateLimit-Limit, X-RateLimit-Remaining, X-RateLimit-Reset |
| 400 | The userIds field is missing | - | - |
| 403 | The caller is not an admin, or an entry is not an active guest of the caller | - | - |
| 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
null (empty response body)
Authorization
Basic, OAuth2 (scopes: read, write), ApiKeyBearer, asc_auth_key, Bearer, OpenId
HTTP request headers
- Content-Type: application/json
- Accept: application/json