Skip to main content
DELETE
Remove inbox members

Authorizations

Authorization
string
header
required

The id_token from POST /auth/v1/signin, sent as Authorization: Bearer <id_token>. Not the access_token — that one does not carry the identity Cloud Chat authorizes on.

Headers

cloudchat-instance
integer
required

Your Cloud Chat instance ID — an integer, fixed for your company, told at onboarding. The API overview explains how instances work, how to find yours, and the errors a wrong or missing value produces.

Example:

1

Path Parameters

accountId
integer
required

Your Cloud Chat account. It has to be an account your token grants membership on, and it has to live on the instance in the cloudchat-instance header — the two travel together. Account numbers are only unique within an instance, so the same number is a different company on another instance. Usually a mismatched pair fails closed with a 401, because your user does not exist on the other instance — but if your identity happens to exist on both, the call succeeds against the other company's data, silently. Read it and you are looking at the wrong help center; write it and you have stored into the wrong account. Send the two values that were given to you together, and never try a number to see what answers.

Example:

1

inboxId
integer
required

The id returned when the inbox was created or listed.

Example:

3

Query Parameters

user_ids
string
required

Ids of the agents to take out of the inbox, as one text separated by commas, from 1 to 25 ids. Use the id that List inbox members returns. An id that is not in the inbox is ignored and reported under ignored_ids; anybody left out of the list is not touched. Send plain text, not a list: user_ids[]=7 is refused with 400.

Example:

"7,12"

Response

What was removed, what was ignored and the inbox's full member roster after the removal.

The outcome of the removal.

data
object
required