> ## 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.

# Update a label

> Requires an administrator or a CX engineer token; any other role gets 403. Send the fields to change under a `label` wrapper; whatever you leave out stays as it is, and an update with none of the four writable fields is a 400, not a no-op.

Changing `title` renames the label and retags every native conversation, contact and company that carries it, asynchronously. Conversations mirrored from ClaudIA are not retagged: they keep the old title, so on accounts that only use ClaudIA the history stays under the old name. ClaudIA applies tags by name, so it keeps applying the old title, which recreates the old label, until the tags on its knowledge base contents (or the channel's tag-to-label map) are renamed too. To change only color, description or sidebar visibility, omit `title`.

The response comes back as soon as the label itself is saved; the retag of the records that carried the old title runs after it.



## OpenAPI

````yaml api-reference/specs/cloudchat/v1.json PATCH /v1/accounts/{accountId}/labels/{labelId}
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}/labels/{labelId}:
    parameters:
      - $ref: '#/components/parameters/CloudChatInstance'
      - $ref: '#/components/parameters/AccountId'
      - $ref: '#/components/parameters/LabelId'
    patch:
      tags:
        - Labels
      summary: Update a label
      description: >-
        Requires an administrator or a CX engineer token; any other role gets
        403. Send the fields to change under a `label` wrapper; whatever you
        leave out stays as it is, and an update with none of the four writable
        fields is a 400, not a no-op.


        Changing `title` renames the label and retags every native conversation,
        contact and company that carries it, asynchronously. Conversations
        mirrored from ClaudIA are not retagged: they keep the old title, so on
        accounts that only use ClaudIA the history stays under the old name.
        ClaudIA applies tags by name, so it keeps applying the old title, which
        recreates the old label, until the tags on its knowledge base contents
        (or the channel's tag-to-label map) are renamed too. To change only
        color, description or sidebar visibility, omit `title`.


        The response comes back as soon as the label itself is saved; the retag
        of the records that carried the old title runs after it.
      operationId: updateLabel
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/LabelUpdateRequest'
      responses:
        '200':
          description: >-
            The label as stored. A title change is applied to the label right
            away; the retag of the records that carried the old title runs after
            this answer.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Label'
        '400':
          description: >-
            The request is malformed before any value is checked: a body that is
            not a JSON object under `label`, including fields sent at the top
            level without the `label` wrapper, or a `label` object with none of
            `title`, `description`, `color` or `show_on_sidebar`. An `accountId`
            that is not a number also lands here, as `bad_request` with
            `details[0].field = "accountId"`. A missing or unrouted
            `cloudchat-instance` header is rejected before the request reaches
            the API and answers `{ "error": "..." }` with a plain string instead
            of the envelope.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              example:
                error:
                  code: bad_request
                  message: The request is malformed.
                  details:
                    - field: label
                      code: invalid_shape
                      message: >-
                        Send the fields inside a label object, for example
                        {"label": {"title": "refund"}}.
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          description: >-
            Two situations answer with this code: your role cannot write labels
            (only administrators and CX engineers can), or the account is
            suspended.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              example:
                error:
                  code: forbidden
                  message: You are not allowed to perform this action.
        '404':
          $ref: '#/components/responses/NotFound'
        '422':
          description: >-
            The payload was understood but a value was refused. `details` names
            every field at fault in one answer, and nothing is written when any
            field is refused. `title`: `blank` (missing or empty), `invalid`
            (under 2 characters, or containing a comma, a quote or a control
            character), `taken` (another label of the account already uses it,
            compared trimmed and lowercased) or `too_long` (over 255
            characters). `description`: `too_long` over 20000 characters.
            `color`: `invalid` when it is not a hex color such as `#1f93ff` or
            `#fff`. `show_on_sidebar`: `invalid` when it is not a JSON boolean.
            An explicit `null` on `color` or `show_on_sidebar` is `blank`, and a
            field sent as an array or an object is `invalid_shape`. Any field
            outside `title`, `description`, `color` and `show_on_sidebar` is
            `unknown_field`, named in `field`: it is never dropped silently, so
            fix its name and send again.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationError'
              example:
                error:
                  code: validation_failed
                  message: The request payload is invalid.
                  details:
                    - field: title
                      code: taken
                      message: >-
                        Another label of this account already uses this title.
                        Titles are compared after trimming and lowercasing.
        '429':
          description: >-
            Rate limited. Two layers can answer. The gateway limits each
            credential and answers `{ "message": ... }` with `Retry-After`.
            Label writes are also limited per account, and renames more tightly,
            because each rename retags every record that carries the old title;
            that one answers in the normal envelope with code `rate_limited`.
            Only a write that passed validation counts against the account
            limit, and a request that leaves `title` out is not held back by the
            rename limit. Back off and retry, and don't hardcode either limit.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              example:
                error:
                  code: rate_limited
                  message: Too many requests. Wait a minute and try again.
        '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
    LabelId:
      name: labelId
      in: path
      required: true
      description: >-
        The label `id` returned by [List
        labels](/api-reference/cloudchat/endpoints/list-labels), [Get a
        label](/api-reference/cloudchat/endpoints/get-a-label) or [Create a
        label](/api-reference/cloudchat/endpoints/create-a-label). It is the
        label's id, not its `title`.
      schema:
        type: integer
        example: 14
  schemas:
    LabelUpdateRequest:
      type: object
      description: >-
        The changes go under a `label` wrapper. Administrator or CX engineer
        only. At least one of the four fields must be present; what is not sent
        stays untouched.
      required:
        - label
      properties:
        label:
          type: object
          minProperties: 1
          properties:
            title:
              type: string
              description: >-
                New label text, normalized as on creation. Renaming retags the
                records that carry the old title, except conversations mirrored
                from ClaudIA; see Update a label. Leave it out to keep the
                current title.
              example: reembolso
            description:
              type: string
              nullable: true
              description: >-
                New description, up to 20000 characters. Send `null` to clear
                it.
              example: Customers asking for their money back.
            color:
              type: string
              description: >-
                New hex color as `#rgb` or `#rrggbb`. An explicit `null` is
                refused.
              example: '#5C6BC0'
            show_on_sidebar:
              type: boolean
              description: >-
                Whether the label appears in the dashboard's conversation
                sidebar filter. An explicit `null` is refused.
              example: false
    Label:
      type: object
      description: >-
        A label definition of the account — the tag conversations and contacts
        carry.
      required:
        - id
        - title
        - description
        - color
        - show_on_sidebar
        - created_at
        - updated_at
      properties:
        id:
          type: integer
          example: 14
        title:
          type: string
          description: >-
            The label text, exactly as it appears in the dashboard and in
            `Conversation.labels`.
          example: vip
          nullable: true
        description:
          type: string
          nullable: true
          example: High-value customers.
        color:
          type: string
          description: Hex color the dashboard renders the label chip in.
          example: '#5C6BC0'
        show_on_sidebar:
          type: boolean
          description: >-
            Whether the label appears in the dashboard's conversation sidebar
            filter.
          example: true
        created_at:
          type: string
          format: date-time
          example: '2026-05-02T11:04:17.000Z'
        updated_at:
          type: string
          format: date-time
          example: '2026-08-10T14:32:05.123Z'
    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.
    ValidationError:
      type: object
      description: A `validation_failed` error, which carries `details`.
      required:
        - error
      properties:
        error:
          type: object
          required:
            - code
            - message
            - details
          properties:
            code:
              type: string
              enum:
                - validation_failed
              example: validation_failed
            message:
              type: string
              description: >-
                Localized to the account's language, like every other envelope
                message.
              example: The request payload is invalid.
            details:
              type: array
              description: >-
                One entry per rejected field. Unlike the envelope message above,
                the texts come from the model layer and are in English in
                practice (the model layer ships no translations) — 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 — `short_code` or
                      `content`. A rule that is not tied to either is reported
                      as `base`, so treat `base` as "the payload as a whole"
                      rather than a field you can highlight.
                    enum:
                      - short_code
                      - content
                      - base
                    example: short_code
                  code:
                    type: string
                    description: >-
                      Which rule it broke — `blank` for a missing or empty
                      value, `taken` for a `short_code` already used on the
                      account.
                    example: taken
                  message:
                    type: string
                    example: has already been taken
  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.
    NotFound:
      description: >-
        The resource is not there for you. Three situations answer with this
        code, and the first two apply to **every** endpoint — the account is
        resolved before anything else runs, so a list or a create fails this way
        too:


        - the account does not exist on this instance,

        - the account exists but your token has no membership on it,

        - on an endpoint that names one, the resource it names (a canned
        response, a portal, an article) does not exist where the path says it
        does.


        The first two are deliberately indistinguishable — same status, same
        body, and the message stays in English in both, since translating it
        would reveal the account's configured language. So you cannot use this
        endpoint to find out which account ids exist. The third case is
        localized like every other error, which is safe because you only reach
        it once membership is established.


        Either way a 404 is not worth retrying. Check the `accountId`, the
        `cloudchat-instance` value, and that your user is a member of the
        account.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            error:
              code: not_found
              message: Resource could not be found.
    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.