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

# Create a custom view

> Creates a custom view owned by the caller. The owner always comes from the token: nothing in the body can name another owner or account. Every role can create views. The body goes under a `custom_view` wrapper.

`name`, `filter_type` and `query` are required. `filter_type` is `conversation` or `contact` and cannot be changed afterwards.

`visibility` is `private` when left out. `public` shares the view with everyone in the account, and `team` shares it with the members of the teams in `team_ids`, which must belong to the account. `team` exists for conversation views only, as in the dashboard. A shared view shows up in the sidebar of its audience right away.

The filter is the `query`: an object with a `payload` list of conditions, each with `attribute_key`, `filter_operator`, `values` and `query_operator`. `attribute_key` is a filter attribute of the view type, or a custom attribute of the account for that type (conversation attributes for a conversation view, contact attributes for a contact view). `filter_operator` has to be one the attribute supports. `values` is a list of values that may be empty only with `is_present` and `is_not_present`, and each value has to fit the attribute: text for text, list, link and multi-list attributes and for most standard ones, whole numbers for `assignee_id`, `inbox_id`, `team_id`, `display_id`, `campaign_id` and `csat_rating`, numbers for number custom attributes, `true` or `false` for checkbox attributes, `proactively_initiated` and `blocked`, dates as `YYYY-MM-DD` for date attributes and for `is_greater_than` and `is_less_than` on `created_at`, `last_activity_at` and `resolved_at`, and a whole number of days for `days_before`. A value of the wrong type is refused with a `422`, because the view would not open. `query_operator` is `and` or `or` (any case is accepted; it is stored and returned in lowercase, the way the dashboard writes it), joins a condition to the next one, and is required on every condition except the last, which must not carry one. A condition with any other key, an unknown attribute, or an operator the attribute does not support is refused with a `422` that names the condition and lists what is accepted.

Each person can have a limited number of views per account; past it the call is refused with a `422`.



## OpenAPI

````yaml api-reference/specs/cloudchat/v1.json POST /v1/accounts/{accountId}/custom-views
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}/custom-views:
    parameters:
      - $ref: '#/components/parameters/CloudChatInstance'
      - $ref: '#/components/parameters/AccountId'
    post:
      tags:
        - Custom Views
      summary: Create a custom view
      description: >-
        Creates a custom view owned by the caller. The owner always comes from
        the token: nothing in the body can name another owner or account. Every
        role can create views. The body goes under a `custom_view` wrapper.


        `name`, `filter_type` and `query` are required. `filter_type` is
        `conversation` or `contact` and cannot be changed afterwards.


        `visibility` is `private` when left out. `public` shares the view with
        everyone in the account, and `team` shares it with the members of the
        teams in `team_ids`, which must belong to the account. `team` exists for
        conversation views only, as in the dashboard. A shared view shows up in
        the sidebar of its audience right away.


        The filter is the `query`: an object with a `payload` list of
        conditions, each with `attribute_key`, `filter_operator`, `values` and
        `query_operator`. `attribute_key` is a filter attribute of the view
        type, or a custom attribute of the account for that type (conversation
        attributes for a conversation view, contact attributes for a contact
        view). `filter_operator` has to be one the attribute supports. `values`
        is a list of values that may be empty only with `is_present` and
        `is_not_present`, and each value has to fit the attribute: text for
        text, list, link and multi-list attributes and for most standard ones,
        whole numbers for `assignee_id`, `inbox_id`, `team_id`, `display_id`,
        `campaign_id` and `csat_rating`, numbers for number custom attributes,
        `true` or `false` for checkbox attributes, `proactively_initiated` and
        `blocked`, dates as `YYYY-MM-DD` for date attributes and for
        `is_greater_than` and `is_less_than` on `created_at`, `last_activity_at`
        and `resolved_at`, and a whole number of days for `days_before`. A value
        of the wrong type is refused with a `422`, because the view would not
        open. `query_operator` is `and` or `or` (any case is accepted; it is
        stored and returned in lowercase, the way the dashboard writes it),
        joins a condition to the next one, and is required on every condition
        except the last, which must not carry one. A condition with any other
        key, an unknown attribute, or an operator the attribute does not support
        is refused with a `422` that names the condition and lists what is
        accepted.


        Each person can have a limited number of views per account; past it the
        call is refused with a `422`.
      operationId: createCustomView
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CustomViewCreateRequest'
      responses:
        '201':
          description: Created. The body is the view itself, not wrapped in `data`.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CustomView'
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
        '422':
          description: >-
            The payload was understood but a value is not acceptable, and
            nothing was stored. `details[].field` is `name`, `filter_type`,
            `visibility` (outside the list, or `team` on a contact view),
            `team_ids` (not a list of ids, or sent without `visibility` `team`)
            or `query`, whose message names the condition at fault. A `team`
            view without teams, a team of another account and the limit of views
            per person come back with `field` `base`.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationError'
              example:
                error:
                  code: validation_failed
                  message: The request payload is invalid.
                  details:
                    - field: query
                      code: invalid
                      message: >-
                        payload[0]: the operator contains is not available for
                        the number attribute age. Use one of: equal_to,
                        not_equal_to, is_present, is_not_present,
                        is_greater_than, is_less_than.
        '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
  schemas:
    CustomViewCreateRequest:
      type: object
      description: The view goes under a `custom_view` wrapper. The owner is the caller.
      required:
        - custom_view
      properties:
        custom_view:
          type: object
          required:
            - name
            - filter_type
            - query
          properties:
            name:
              type: string
              minLength: 1
              maxLength: 255
              description: Required, 1 to 255 characters.
              example: Open and unassigned
            filter_type:
              type: string
              enum:
                - conversation
                - contact
              description: >-
                Required. `conversation` or `contact`; it cannot be changed
                afterwards.
              example: conversation
            visibility:
              type: string
              enum:
                - private
                - public
                - team
              default: private
              description: >-
                Defaults to `private`. `team` is available for conversation
                views only and needs `team_ids`.
              example: private
            team_ids:
              type: array
              items:
                type: integer
              description: >-
                Teams to share the view with. Required with `visibility` `team`
                and refused with any other visibility. Every team must belong to
                the account.
              example: []
            query:
              $ref: '#/components/schemas/CustomViewQuery'
    CustomView:
      type: object
      description: >-
        A saved filter of conversations or contacts, kept in the dashboard
        sidebar.
      required:
        - id
        - name
        - filter_type
        - visibility
        - team_ids
        - query
        - owned_by_me
        - created_at
        - updated_at
      properties:
        id:
          type: integer
          example: 14
        name:
          type: string
          example: Open and unassigned
        filter_type:
          type: string
          enum:
            - conversation
            - contact
          description: >-
            What the view filters: `conversation` for a folder, `contact` for a
            segment.
          example: conversation
        visibility:
          type: string
          enum:
            - private
            - public
            - team
          description: >-
            `private` is visible only to its owner, `public` to everyone in the
            account, `team` to the members of the teams in `team_ids`.
          example: private
        team_ids:
          type: array
          items:
            type: integer
          description: >-
            Ids of the teams the view is shared with. Empty unless `visibility`
            is `team`.
          example: []
        query:
          type: object
          additionalProperties: true
          description: >-
            The saved filter. Normally `{ "payload": [...] }` with the
            conditions described on `CustomViewCondition`; views saved by older
            versions of the dashboard may carry other keys, which are returned
            as stored.
          example:
            payload:
              - attribute_key: status
                filter_operator: equal_to
                values:
                  - open
                query_operator: and
              - attribute_key: assignee_id
                filter_operator: is_not_present
        owned_by_me:
          type: boolean
          description: '`true` when you own the view. Only those can be changed or deleted.'
          example: true
        created_at:
          type: string
          format: date-time
          example: '2026-11-02T11:04:17.000Z'
        updated_at:
          type: string
          format: date-time
          example: '2026-11-05T14:32:05.123Z'
    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
    CustomViewQuery:
      type: object
      description: 'The filter of a view: an object with only the `payload` key.'
      required:
        - payload
      properties:
        payload:
          type: array
          items:
            $ref: '#/components/schemas/CustomViewCondition'
          description: >-
            The conditions, applied in order and joined by each condition's
            `query_operator`.
          example:
            - attribute_key: status
              filter_operator: equal_to
              values:
                - open
              query_operator: and
            - attribute_key: assignee_id
              filter_operator: is_not_present
    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.
    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
    CustomViewCondition:
      type: object
      description: One condition of a view filter.
      required:
        - attribute_key
        - filter_operator
      properties:
        attribute_key:
          type: string
          description: >-
            The attribute to filter on: a filter attribute of the view type (for
            conversations for example `status`, `assignee_id`, `inbox_id`,
            `team_id`, `labels`, `created_at`; for contacts for example `name`,
            `email`, `phone_number`) or the key of a custom attribute of the
            account for that type. An unknown key is refused and the message
            lists the valid standard ones.
          example: status
        filter_operator:
          type: string
          description: >-
            How to compare: `equal_to`, `not_equal_to`, `contains`,
            `does_not_contain`, `is_present`, `is_not_present`,
            `is_greater_than`, `is_less_than`, `days_before`, `starts_with`, or
            `contains_all` and `does_not_contain_all` for a multi-list custom
            attribute. Each attribute accepts only some of them; a wrong one is
            refused and the message lists the accepted ones.
          example: equal_to
        values:
          type: array
          items:
            oneOf:
              - type: string
              - type: number
              - type: boolean
          description: >-
            What to compare against, for example `["open"]` for `status` or
            `[12, 15]` for `inbox_id`. Each value has to fit the attribute: text
            for text, list, link and multi-list attributes and for most standard
            ones, whole numbers (a number or numeric text) for `assignee_id`,
            `inbox_id`, `team_id`, `display_id`, `campaign_id` and
            `csat_rating`, numbers for number custom attributes, `true` or
            `false` for checkbox attributes, `proactively_initiated` and
            `blocked`, dates as `YYYY-MM-DD` for date attributes and for
            `is_greater_than` and `is_less_than` on `created_at`,
            `last_activity_at` and `resolved_at`, and a whole number of days for
            `days_before`. A value of the wrong type is refused with a `422`.
            May be left out or empty only with `is_present` and
            `is_not_present`.
          example:
            - open
        query_operator:
          type: string
          enum:
            - and
            - or
          description: >-
            How this condition joins the next one: `and` or `or`. Any case is
            accepted, but it is stored and returned in lowercase, the way the
            dashboard writes it. Required on every condition except the last,
            which must not carry one.
        attribute_model:
          type: string
          enum:
            - standard
            - custom_attributes
          description: >-
            Send `custom_attributes` to force the attribute to be read as a
            custom attribute when its key is also a standard attribute, for
            example a custom attribute named `status`. Leave it out otherwise.
        custom_attribute_type:
          type: string
          description: >-
            Optional. Empty, or `conversation_attribute` on a conversation view
            and `contact_attribute` on a contact view. It changes nothing: the
            attribute model follows the view type.
  responses:
    BadRequest:
      description: >-
        The request itself is malformed, before any value is validated:


        - a body that isn't valid JSON, or one with no `canned_response`
        wrapper,

        - a `canned_response` that isn't an object (`{"canned_response":
        "text"}`),

        - `page`, `per_page`, `search` or `sort` sent as an array or a nested
        object (`?page[]=1`, `?sort[x]=y`) instead of a plain value,

        - **the `cloudchat-instance` header missing or holding a value we don't
        route,**

        - an `accountId` that is not a number — including the literal
        `{accountId}` that some API clients send when the argument is left
        unset. This one answers with the normal envelope and `error.details`
        naming `accountId`, and it is deliberately **not** a 404: a 404 would
        mean the account cannot be reached, while this means the value was never
        an account id at all, so re-read the argument instead of trying other
        numbers.


        **Two different shapes answer with 400, and the difference will bite you
        on day one.** That last case is rejected before the request reaches the
        API, so `error` is a plain **string** instead of the usual object:


        ```json

        { "error": "<human-readable message>" }

        ```


        Every other 400 uses the normal envelope, where `error` is an object
        with `code` and `message`. Reading `error.code` without checking the
        type first throws on the missing-header case — which is the most likely
        400 of your first integration. Check `typeof error === "string"` first,
        or read `error?.code` defensively.


        A 400 always means fix the request shape; it never means a value was
        rejected. Rejected values are 422.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            error:
              code: bad_request
              message: The request is malformed.
    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.
    Forbidden:
      description: >-
        The operation was refused for who you are, not for what you sent. Two
        causes:


        - **Your role does not permit it.** Several operations here need an
        administrator, and a few need a supervisor or a CX engineer; where it
        matters, the operation says so in its own 403. Changing your own role is
        not something the API can do — ask an administrator of the account.

        - **The account is suspended.** Then nothing on it can be read or
        written until that is resolved — talk to your Cloud Humans contact.


        Not being a member of the account is a **404**, not a 403: an account
        you cannot reach and an account that does not exist are deliberately
        indistinguishable.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            error:
              code: forbidden
              message: This account is suspended.
    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.