Add team members
Administrator only. Additive and idempotent — it never removes a member left out of the payload. There is no endpoint to remove one through this API. Refused with 403 on a system_managed team.
Any user_ids entry that is not a member of the account — including a hidden admin’s id, indistinguishable from an unknown one — fails the whole call with 404; nothing is added.
Authorizations
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
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.
1
Path Parameters
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.
1
The id returned when the team was created or listed.
5
Body
The user ids to add, as agent user ids (not emails). Administrator only, and refused with 403 on a system_managed team.
This call is additive and idempotent — it never removes a member. An id already on the team is a no-op for that id; there is no endpoint to remove a member through this API. Any id that does not resolve to a member of the account, including a hidden admin's id (the two are indistinguishable), fails the whole call with 404 — nothing is added.
Response
The team's full member roster after the addition, not just the ids that were sent.
The team's full member roster after the call — not just the ids that were sent.