> ## 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 an inbox's settings

> Administrator only. Change the operating settings of an inbox: its name, the greeting, the working hours (flag, timezone, out-of-office message and weekly schedule) and the CSAT survey toggle. What is not sent stays untouched, and everything you send is applied together or not at all.

The greeting and the out-of-office message are texts Cloud Chat sends to the end customer exactly as written. Changing the working hours or the timezone changes when a conversation counts as outside business hours: it decides when customers receive the out-of-office message and how business-hours reports are measured.

The channel itself (connection, credentials, provider), webhooks, avatar, auto-assignment, bots and every other inbox setting are not editable through the API. They are changed on the Cloud Chat screen, and a payload that carries any of them is refused with a 422 that names the field.

The response is the same `Inbox` that `GET` returns, which does not include the weekly schedule. To change a day, send the whole day.



## OpenAPI

````yaml api-reference/specs/cloudchat/v1.json PATCH /v1/accounts/{accountId}/inboxes/{inboxId}
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}/inboxes/{inboxId}:
    parameters:
      - $ref: '#/components/parameters/CloudChatInstance'
      - $ref: '#/components/parameters/AccountId'
      - $ref: '#/components/parameters/InboxId'
    patch:
      tags:
        - Inboxes
      summary: Update an inbox's settings
      description: >-
        Administrator only. Change the operating settings of an inbox: its name,
        the greeting, the working hours (flag, timezone, out-of-office message
        and weekly schedule) and the CSAT survey toggle. What is not sent stays
        untouched, and everything you send is applied together or not at all.


        The greeting and the out-of-office message are texts Cloud Chat sends to
        the end customer exactly as written. Changing the working hours or the
        timezone changes when a conversation counts as outside business hours:
        it decides when customers receive the out-of-office message and how
        business-hours reports are measured.


        The channel itself (connection, credentials, provider), webhooks,
        avatar, auto-assignment, bots and every other inbox setting are not
        editable through the API. They are changed on the Cloud Chat screen, and
        a payload that carries any of them is refused with a 422 that names the
        field.


        The response is the same `Inbox` that `GET` returns, which does not
        include the weekly schedule. To change a day, send the whole day.
      operationId: updateInbox
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/InboxUpdateRequest'
      responses:
        '200':
          description: The inbox after the update.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Inbox'
        '400':
          description: >-
            Malformed request: `inbox` is missing or is not an object, or it
            carries none of the writable fields.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              example:
                error:
                  code: bad_request
                  message: >-
                    Provide at least one of name, greeting_enabled,
                    greeting_message, working_hours_enabled,
                    out_of_office_message, timezone, working_hours or
                    csat_survey_enabled inside inbox.
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          description: >-
            The account is suspended, or your token is not an administrator.
            Only administrators change an inbox.
          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: >-
            Nothing was applied. `details` names every field at fault: a setting
            that is not editable through the API (`code: "not_editable"`), a
            value of the wrong type, a name or timezone the inbox rejects, a
            text that is too long, or a day of `working_hours` that is
            malformed, repeated, incomplete or closes before it opens. A day is
            reported as `working_hours[<position>].<field>`.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationError'
              example:
                error:
                  code: validation_failed
                  message: The request payload is invalid.
                  details:
                    - field: working_hours[0].close_hour
                      code: invalid
                      message: Closing time cannot be before opening time
        '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
    InboxId:
      name: inboxId
      in: path
      required: true
      description: The `id` returned when the inbox was created or listed.
      schema:
        type: integer
        example: 3
  schemas:
    InboxUpdateRequest:
      type: object
      description: >-
        The changes go under an `inbox` wrapper. Administrator only. Send at
        least one writable field: an empty payload is a 400, not a no-op. A
        field outside this list is a 422 that says it is changed on the screen,
        and nothing is applied.
      required:
        - inbox
      properties:
        inbox:
          type: object
          minProperties: 1
          properties:
            name:
              type: string
              example: Support WhatsApp
              description: >-
                On email, API and web widget inboxes it cannot contain `/`, `\`,
                `<`, `>` or `@`. The default parallel conversations inbox cannot
                be renamed.
            greeting_enabled:
              type: boolean
              example: true
              description: >-
                Whether the greeting is sent to the customer on the first
                message of a new conversation, before anyone has replied. It
                only goes out while `greeting_message` is filled in. Cannot be
                null.
            greeting_message:
              type: string
              nullable: true
              example: Thanks for reaching out! We'll be with you shortly.
              description: >-
                Up to 10,000 characters. It reaches the customer exactly as
                written. `null` clears it.
            working_hours_enabled:
              type: boolean
              example: true
              description: >-
                When `true`, a conversation that arrives outside the weekly
                schedule, read in the inbox's timezone, counts as outside
                business hours. Cannot be null.
            out_of_office_message:
              type: string
              nullable: true
              example: We're closed right now — we'll reply as soon as we're back.
              description: >-
                Sent to the customer, at most once a day per conversation, when
                it arrives outside working hours and no human agent who is
                online is assigned to it. Up to 10,000 characters, exactly as
                written. `null` clears it.
            timezone:
              type: string
              example: America/Sao_Paulo
              description: >-
                IANA timezone the weekly schedule is read in. Changing it moves
                every opening and closing time on the clock without editing
                them.
            csat_survey_enabled:
              type: boolean
              example: true
              description: >-
                Whether a CSAT survey is sent to the customer when a
                conversation is resolved. Cannot be null.
            working_hours:
              type: array
              minItems: 1
              items:
                type: object
                required:
                  - day_of_week
                description: >-
                  One day of the weekly schedule. Only the fields you include
                  change; the others keep their value.
                properties:
                  day_of_week:
                    type: integer
                    minimum: 0
                    maximum: 6
                    example: 1
                    description: >-
                      0 is Sunday, 1 is Monday, up to 6 for Saturday. Send each
                      day once.
                  closed_all_day:
                    type: boolean
                    example: false
                    description: >-
                      `true` closes the whole day. To reopen a closed day, send
                      `false` together with the four opening and closing fields,
                      or set `open_all_day`.
                  open_all_day:
                    type: boolean
                    example: false
                    description: >-
                      `true` opens the whole day, 00:00 to 23:59. It cannot be
                      `true` together with `closed_all_day`, so moving a day
                      from one to the other takes both fields in the same entry.
                  open_hour:
                    type: integer
                    minimum: 0
                    maximum: 23
                    example: 9
                  open_minutes:
                    type: integer
                    minimum: 0
                    maximum: 59
                    example: 0
                  close_hour:
                    type: integer
                    minimum: 0
                    maximum: 23
                    example: 18
                    description: Must be after the opening time.
                  close_minutes:
                    type: integer
                    minimum: 0
                    maximum: 59
                    example: 0
              description: >-
                The days of the weekly schedule to change, one entry per day.
                Days you leave out keep their schedule.
    Inbox:
      type: object
      description: >-
        An inbox of the account. Configuration only — **no channel credential
        (access token, phone number id, API key, or similar) is ever included in
        this payload**, on any channel type.
      required:
        - id
        - name
        - channel_type
        - greeting_enabled
        - greeting_message
        - working_hours_enabled
        - out_of_office_message
        - timezone
        - csat_survey_enabled
        - enable_auto_assignment
        - allow_messages_after_resolved
        - lock_to_single_conversation
        - created_at
        - updated_at
      properties:
        id:
          type: integer
          example: 3
        name:
          type: string
          example: Support WhatsApp
        channel_type:
          type: string
          description: >-
            The fully qualified channel class, e.g. `Channel::Whatsapp`,
            `Channel::WebWidget`, `Channel::Api`, `Channel::FacebookPage`,
            `Channel::TwilioSms`.
          example: Channel::Whatsapp
          nullable: true
        greeting_enabled:
          type: boolean
          example: true
          nullable: true
        greeting_message:
          type: string
          nullable: true
          example: Thanks for reaching out! We'll be with you shortly.
        working_hours_enabled:
          type: boolean
          example: true
          nullable: true
        out_of_office_message:
          type: string
          nullable: true
          example: We're closed right now — we'll reply as soon as we're back.
        timezone:
          type: string
          example: America/Sao_Paulo
          nullable: true
        csat_survey_enabled:
          type: boolean
          example: true
          nullable: true
        enable_auto_assignment:
          type: boolean
          example: true
          nullable: true
        allow_messages_after_resolved:
          type: boolean
          example: true
          nullable: true
        lock_to_single_conversation:
          type: boolean
          example: false
        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
    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.
    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.
    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.