Removes guests from the list and from rooms

DELETE /api/2.0/people/guests

Request

Removes guests from the list and excludes them from rooms to which you have invited them

Authorization

An API key is a token that you provide when making API calls. Include the token in a cookie parameter called asc_auth_key.

Example: asc_auth_key=864FE52C-1C1C-469F-9308-51DAFEFE7436.

Headers

Content-Typeenum of string

Can be one of: application/json, application/*+json, text/json.

Body

Request parameters for updating user information

userIdsarray of string

List of user IDs

resendAllboolean

Specifies whether to resend invitation letters to all the users or not

Examples

DELETE /api/2.0/people/guests HTTP/1.1
Content-Length: 86
Content-Type: application/json
Host: example.com

{
  "userIds": [
    "75a5f745-f697-4418-b38d-0fe0d277e258"
  ],
  "resendAll": true
}

curl --request DELETE \
  --url https://example.com/api/2.0/people/guests \
  --header 'Content-Type: application/json' \
  --data '{
  "userIds": [
    "75a5f745-f697-4418-b38d-0fe0d277e258"
  ],
  "resendAll": true
}'

Responses

200

Request parameters for deleting guests

401

Unauthorized

403

No permissions to perform this action