Skip to main content
POST
Add team 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

teamId
integer
required

The id returned when the team was created or listed.

Example:

5

Body

application/json

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.

user_ids
integer[]
required
Example:

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.

data
object[]
required