> ## Documentation Index
> Fetch the complete documentation index at: https://docs.cloudhumans.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Remove team members

> Administrator only, and refused with 403 on a `system_managed` team. Takes agents off the team: send their ids in the `user_ids` query parameter, as one text separated by commas such as `7,12`, from 1 to 25 per call.

**Idempotent.** An id that belongs to an agent of the account but is not on the team is ignored, and the response lists it under `ignored_ids`. Repeating a call is safe.

**Effect on conversations.** None: conversations assigned to the team, or to the removed agent, keep their team and assignee. Custom views shared with the team stop appearing for the removed agent, unless another of their teams still sees them.

**Undo.** Add the agent again with `addTeamMembers`.

The call is all-or-nothing on the ids: any id in `user_ids` that is not a member of the account, including a hidden admin's id (the two are indistinguishable), fails the whole call with 404 and nobody is removed.



## OpenAPI

````yaml api-reference/specs/cloudchat/v1.json DELETE /v1/accounts/{accountId}/teams/{teamId}/members
openapi: 3.0.1
info:
  title: Cloud Chat API
  version: v1
  description: >-
    The curated public surface of Cloud Chat. Every call needs two things: the
    Bearer token from `POST /auth/v1/signin`, and the `cloudchat-instance`
    header that says which Cloud Chat instance your company lives on.


    If you don't know your instance value, the [Find your
    credentials](/api-reference/cloudchat/credentials) page reads it out of your
    own token in the browser.
servers:
  - url: https://api.cloudhumans.com/cloudchat
    description: Production
security:
  - bearerAuth: []
tags:
  - name: Canned Responses
    description: >-
      Canned responses — the shortcuts agents expand while replying. Each one
      belongs to a single account and is identified by its short code.
  - name: Conversations
    description: >-
      The conversations of an account: read them, change their priority and
      status, assign them, leave internal notes, and block or unblock the
      contact of a conversation. Answering the customer, opening a conversation
      and deleting one are not part of this surface. What you can see and change
      follows the same rule as the dashboard: an administrator token reaches
      every inbox, an agent token only the inboxes it is a member of.
  - name: Contacts
    description: >-
      Customer contacts of the account, with their personal data. Administrators
      only.
  - name: Help Center
    description: >-
      Portals, categories and articles of the help center — the public FAQ your
      customers read.
  - name: Uploads
    description: Store the images help center articles embed.
  - name: Labels
    description: >-
      The label definitions of an account: the tags conversations and contacts
      carry. Listing and reading are open to any member; creating and updating a
      label need an administrator or CX engineer token. Renaming a label retags
      the records that carry it. There is no delete: removing a label and
      creating another with the same title would bring the old tags back. The
      same group applies labels to a conversation or a contact and takes them
      off again.
  - name: Inboxes
    description: >-
      The inboxes a token can see — every inbox of the account for an
      administrator, only its memberships for an agent. Administrators can also
      change an inbox's name, greeting, working hours and CSAT toggle. Never
      includes the channel's credentials, and the channel itself is not editable
      here.
  - name: Agents
    description: >-
      Read-only access to the human and AI agents of an account. A hidden admin
      (the platform's own support user) never appears, on the list or by id.
  - name: Teams
    description: >-
      Teams group agents for assignment. Listing and reading are open to any
      member; creating and updating a team, and managing its membership, require
      an administrator token. A system-managed team (provisioned by the
      platform) can be read like any other but never updated.
  - name: Macros
    description: >-
      Macros bundle a sequence of actions an agent runs against a conversation
      from the dashboard. This surface lets you list, read and write macro
      definitions — running one is not part of the v1 contract. A macro is
      either `global` (visible to the whole account) or `personal` (visible only
      to its author); an agent token can only create personal macros.
  - name: Automation Rules
    description: >-
      The account's automation rules — administrator only. An agent token gets a
      403 on every operation in this group.


      Reading is direct. Writing goes through a propose → confirm pair: the
      propose call validates the change, writes nothing, and returns a
      single-use `proposal_token` with a preview and a list of `warnings`; the
      confirm call sends the token back and applies exactly what was previewed.
      Rules created through the API start off, and turning a rule on or off
      stays with a person in the Cloud Chat automations screen.
  - name: Availability Reasons
    description: >-
      The reasons an agent can go `busy` for, configured per account. Listing is
      open to any member; creating, updating and deleting require an
      administrator token. Deleting is a soft delete — the reason disappears
      from listings but agents' past availability history keeps referencing it.
  - name: Native Attribute Requirements
    description: >-
      Which native conversation attributes (priority, assignee, tag, team) the
      account requires agents to fill before resolving a conversation. Listing
      is open to any member; requiring and un-requiring need an administrator
      token. Deleting a requirement is reversible — require the same key again
      to restore it.
  - name: Custom Attributes
    description: >-
      The custom fields an account added to conversations, contacts and
      companies, and their definitions: key, type, model and options. Listing
      and reading are open to any member; creating and editing need an
      administrator token. Deleting a definition, conditional sub-lists and the
      AI fill settings stay in the Cloud Chat screen.
  - name: Campaigns
    description: Check who a campaign would reach, send it, and read the result back.
  - name: Reports
    description: The numbers of the Cloud Chat reporting dashboards, read through the API.
  - name: Companies
    description: >-
      Companies (the businesses your contacts work for) and the links between
      contacts and companies. Companies must be enabled for the account; when
      they are not, every operation in this group answers `403`. Any member of
      the account can read. Updating a company and linking or unlinking contacts
      is open to agents, supervisors, CX engineers and administrators; an
      assistant is read-only.
paths:
  /v1/accounts/{accountId}/teams/{teamId}/members:
    parameters:
      - $ref: '#/components/parameters/CloudChatInstance'
      - $ref: '#/components/parameters/AccountId'
      - $ref: '#/components/parameters/TeamId'
    delete:
      tags:
        - Teams
      summary: Remove team members
      description: >-
        Administrator only, and refused with 403 on a `system_managed` team.
        Takes agents off the team: send their ids in the `user_ids` query
        parameter, as one text separated by commas such as `7,12`, from 1 to 25
        per call.


        **Idempotent.** An id that belongs to an agent of the account but is not
        on the team is ignored, and the response lists it under `ignored_ids`.
        Repeating a call is safe.


        **Effect on conversations.** None: conversations assigned to the team,
        or to the removed agent, keep their team and assignee. Custom views
        shared with the team stop appearing for the removed agent, unless
        another of their teams still sees them.


        **Undo.** Add the agent again with `addTeamMembers`.


        The call is all-or-nothing on the ids: any id in `user_ids` that is not
        a member of the account, including a hidden admin's id (the two are
        indistinguishable), fails the whole call with 404 and nobody is removed.
      operationId: removeTeamMembers
      parameters:
        - name: user_ids
          in: query
          required: true
          description: >-
            Ids of the agents to take out of the team, as one text separated by
            commas, from 1 to 25 ids. Use the `id` that [List team
            members](/api-reference/cloudchat/endpoints/list-team-members)
            returns. An id that is not in the team 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.
          schema:
            type: string
            example: 7,12
      responses:
        '200':
          description: >-
            What was removed, what was ignored and the team's full member roster
            after the removal.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TeamMembersRemoveResult'
        '400':
          description: >-
            Malformed request: no `user_ids`, an empty value, more than 25
            entries, an entry that is not a whole number, or a list
            (`user_ids[]=7`) instead of one text (`details` names the field).
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              example:
                error:
                  code: bad_request
                  message: The request is malformed.
                  details:
                    - field: user_ids
                      code: invalid
                      message: user_ids must list between 1 and 25 agent ids.
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          description: >-
            Three situations answer with this code: the account is suspended,
            your token is not an administrator, or the team is `system_managed`
            — the platform provisions it and it cannot be modified through this
            API. The `system_managed` case answers `"This team is managed by the
            platform and cannot be modified."` instead of the generic message
            shown here.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              example:
                error:
                  code: forbidden
                  message: You are not allowed to perform this action.
        '404':
          description: >-
            The team does not exist on this account, or one of the ids in
            `user_ids` does not resolve to a member of the account (an unknown
            id and a hidden admin's id look identical here). Nobody is removed
            when this happens.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              example:
                error:
                  code: not_found
                  message: Resource could not be found.
        '429':
          $ref: '#/components/responses/TooManyRequests'
        '500':
          $ref: '#/components/responses/InternalError'
components:
  parameters:
    CloudChatInstance:
      name: cloudchat-instance
      in: header
      required: true
      description: >-
        Your Cloud Chat instance ID — an integer, fixed for your company, told
        at onboarding. [The API
        overview](/api-reference/cloudchat/overview#two-headers-every-call)
        explains how instances work, how to find yours, and the errors a wrong
        or missing value produces.
      schema:
        type: integer
        example: 1
    AccountId:
      name: accountId
      in: path
      required: true
      description: >-
        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.
      schema:
        type: integer
        example: 1
    TeamId:
      name: teamId
      in: path
      required: true
      description: The `id` returned when the team was created or listed.
      schema:
        type: integer
        example: 5
  schemas:
    TeamMembersRemoveResult:
      type: object
      description: The outcome of the removal.
      required:
        - data
      properties:
        data:
          type: object
          required:
            - removed_ids
            - ignored_ids
            - members
          properties:
            removed_ids:
              type: array
              items:
                type: integer
              description: >-
                Ids that were on the team and were removed by this call,
                ascending.
              example:
                - 7
            ignored_ids:
              type: array
              items:
                type: integer
              description: >-
                Ids you sent that were not on the team, so nothing changed for
                them, ascending.
              example:
                - 12
            members:
              type: array
              items:
                $ref: '#/components/schemas/TeamMember'
              description: The team's full member roster after the removal.
    Error:
      type: object
      description: The error envelope every Cloud Chat API response uses.
      required:
        - error
      properties:
        error:
          type: object
          required:
            - code
            - message
          properties:
            code:
              type: string
              description: >-
                The stable, machine-readable reason. Branch on this, never on
                `message`.
              enum:
                - unauthorized
                - forbidden
                - not_found
                - validation_failed
                - conflict
                - bad_request
                - internal_error
                - rate_limited
                - service_unavailable
              example: not_found
            message:
              type: string
              description: >-
                The reason in words, localized to your account's language
                (English, Spanish or Brazilian Portuguese; English when the
                account is set to anything else). Wording changes with the
                account and between releases, so never match on it.


                Two cases stay in English whatever the account is set to:
                `unauthorized`, decided before any account is known, and the
                account-level `not_found`, which must not reveal the account's
                language.
              example: Resource could not be found.
            details:
              type: array
              description: >-
                Present on some rejections — a 400 for a refused query parameter
                or upload mode, for example. One entry per offending field,
                localized to the account's language like `message` — match on
                `code` and `field`, never on the text.
              items:
                type: object
                required:
                  - field
                  - code
                  - message
                properties:
                  field:
                    type: string
                    description: Which request field the rule was about.
                  code:
                    type: string
                    description: Stable, machine-readable reason.
                  message:
                    type: string
                    description: The rule in words.
    TeamMember:
      type: object
      description: An agent that belongs to the team. A hidden admin never appears here.
      required:
        - id
        - name
        - email
      properties:
        id:
          type: integer
          example: 7
        name:
          type: string
          example: Jane Doe
        email:
          type: string
          example: jane@acme.com
    GatewayError:
      type: object
      description: >-
        Rejected by the gateway before Cloud Chat saw it, so it does not use the
        `error` envelope.
      required:
        - message
      properties:
        message:
          type: string
          example: API rate limit exceeded
        request_id:
          type: string
          description: Gateway request id. Quote it when reporting a problem.
          example: f3f7567638d4b65a8003057d0c77d275
  responses:
    Unauthorized:
      description: >-
        No Bearer token, or one that is expired, malformed, or not a Cognito
        token. Sign in again for a fresh `id_token`.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            error:
              code: unauthorized
              message: >-
                Authentication is required. Send a valid Bearer token in the
                Authorization header.
    TooManyRequests:
      description: >-
        Rate limited per credential. Note the envelope: this one is `{
        "message": ... }`, because the request never reached the API.


        Don't hardcode the limit — read it from the response. `Retry-After` says
        how many seconds to wait, and every response (not just this one) carries
        `ratelimit-limit`, `ratelimit-remaining` and `ratelimit-reset`, the last
        in seconds.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/GatewayError'
          example:
            message: API rate limit exceeded
    InternalError:
      description: >-
        Something failed on our side. The response never carries the underlying
        error, but it is reported to our monitoring automatically — no need to
        file anything for a one-off.


        Retrying is reasonable, with one caveat on `POST`: a 500 does not prove
        the write did not happen, so a retry can come back `422` with
        `short_code` already taken. That 422 means the first attempt succeeded —
        list the account and confirm before treating it as a failure.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            error:
              code: internal_error
              message: An unexpected error occurred. Please try again later.
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: >-
        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.

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.