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

> Administrator only. Creates one custom attribute definition, so that conversations, contacts or companies can start carrying a value for it. The definition goes under `custom_attribute`.

**This operation only creates.** The name, description, list options, `required` and regex can be edited afterwards with `updateCustomAttribute`, but the key, the type and the model never change, and nothing in this API deletes a definition — an administrator does that in the Cloud Chat screen — so check those three before sending. A list has to be created with its options.

**Not accepted here:** AI field filling (`ai_field_filling_enable`, `ai_fill_instruction`, `ai_fill_confidence_threshold`), conditional sub-lists and visibility rules. The regex validation is added afterwards with `updateCustomAttribute`. They are set up in the Cloud Chat screen, and sending any field outside the request schema answers 400 with the field named in `details`.

The `key` is unique within its model. A key already used in the same model answers 409 and, when you can read that definition, `details[0].existing_attribute_id` is its id; the same key in another model is allowed. Creating a definition gives no contact, conversation or company a value for it.



## OpenAPI

````yaml api-reference/specs/cloudchat/v1.json POST /v1/accounts/{accountId}/custom-attributes
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-attributes:
    parameters:
      - $ref: '#/components/parameters/CloudChatInstance'
      - $ref: '#/components/parameters/AccountId'
    post:
      tags:
        - Custom Attributes
      summary: Create a custom attribute
      description: >-
        Administrator only. Creates one custom attribute definition, so that
        conversations, contacts or companies can start carrying a value for it.
        The definition goes under `custom_attribute`.


        **This operation only creates.** The name, description, list options,
        `required` and regex can be edited afterwards with
        `updateCustomAttribute`, but the key, the type and the model never
        change, and nothing in this API deletes a definition — an administrator
        does that in the Cloud Chat screen — so check those three before
        sending. A list has to be created with its options.


        **Not accepted here:** AI field filling (`ai_field_filling_enable`,
        `ai_fill_instruction`, `ai_fill_confidence_threshold`), conditional
        sub-lists and visibility rules. The regex validation is added afterwards
        with `updateCustomAttribute`. They are set up in the Cloud Chat screen,
        and sending any field outside the request schema answers 400 with the
        field named in `details`.


        The `key` is unique within its model. A key already used in the same
        model answers 409 and, when you can read that definition,
        `details[0].existing_attribute_id` is its id; the same key in another
        model is allowed. Creating a definition gives no contact, conversation
        or company a value for it.
      operationId: createCustomAttribute
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CustomAttributeCreateRequest'
            example:
              custom_attribute:
                name: Plan
                key: plan
                type: list
                model: contact
                description: Plan the customer subscribed to.
                values:
                  - free
                  - pro
                  - enterprise
                required: false
      responses:
        '201':
          description: Created. The definition as stored.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CustomAttribute'
        '400':
          description: >-
            Malformed request: a payload without a `custom_attribute` object, a
            field of the wrong shape (a number where a string is expected,
            `values` that is not a list of strings, a `required` that is not
            true or false), an AI fill field, or any field that is not in the
            request schema. `details` names every offending field.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          description: >-
            Two situations answer with this code: the account is suspended, or
            your token is not an administrator — this operation requires one.
          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'
        '409':
          description: >-
            The `key` is already used by another definition of the same model.
            Nothing was created.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CustomAttributeConflictError'
              example:
                error:
                  code: conflict
                  message: >-
                    The request conflicts with the current state of the
                    resource.
                  details:
                    - field: key
                      code: taken
                      message: >-
                        An attribute with this key already exists for this model
                        (id 42). Read it with getCustomAttribute or choose
                        another key.
                      existing_attribute_id: 42
        '422':
          description: >-
            The payload was understood but a value is not acceptable: a missing
            or blank `name`, `key`, `type` or `model`; a `key` with characters
            other than lowercase letters, digits and underscores; a `type` or
            `model` outside the accepted values; a list without options, or with
            blank or repeated ones; `values` on a type that takes none; or a
            rule of the company model (a reserved key, or the `currency` and
            `percent` types). Nothing was created. `details` names every field
            at fault.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationError'
              example:
                error:
                  code: validation_failed
                  message: The request payload is invalid.
                  details:
                    - field: key
                      code: invalid
                      message: >-
                        The key must use only lowercase letters, digits and
                        underscores, for example customer_tax_id.
        '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:
    CustomAttributeCreateRequest:
      type: object
      description: >-
        The definition to create, under `custom_attribute`. Administrator only.
        Fields outside this schema — including every AI fill field — answer 400.
      required:
        - custom_attribute
      properties:
        custom_attribute:
          type: object
          required:
            - name
            - key
            - type
            - model
          properties:
            name:
              type: string
              description: >-
                The name the Cloud Chat screen shows for the field. Cannot be
                blank.
              example: Plan
            key:
              type: string
              description: >-
                The key values are stored under. Only lowercase letters, digits
                and underscores. Unique within `model`: a key already used there
                answers 409. It can never be changed afterwards.
              example: plan
            type:
              type: string
              enum:
                - text
                - number
                - currency
                - percent
                - link
                - date
                - list
                - checkbox
                - multi_list
              description: >-
                Kind of value the field holds: `text`, `number`, `currency`,
                `percent`, `link`, `date`, `list` (one of the options in
                `values`), `checkbox` or `multi_list` (several of the options in
                `values`). A company field cannot be `currency` or `percent`.
              example: list
            model:
              type: string
              enum:
                - conversation
                - contact
                - company
              description: >-
                What the field is attached to: a `conversation`, a `contact` or
                a `company`. The same `key` may exist in more than one model.
              example: contact
            description:
              type: string
              description: What the field is for. Optional.
              example: Plan the customer subscribed to.
            values:
              type: array
              items:
                type: string
              description: >-
                The options of the field. Required, with at least one entry, for
                `list` and `multi_list`; refused for every other type. Entries
                cannot be blank or repeated. The list can be replaced afterwards
                with `updateCustomAttribute`.
              example:
                - free
                - pro
                - enterprise
            required:
              type: boolean
              default: false
              description: Whether the field has to be filled. Defaults to `false`.
              example: false
    CustomAttribute:
      type: object
      description: >-
        One custom attribute definition: a field the account added to
        conversations, contacts or companies. The AI fill settings and
        visibility rules are not part of this view.
      required:
        - id
        - key
        - name
        - description
        - type
        - model
        - values
        - required
        - regex_pattern
        - regex_cue
        - conditional
        - created_at
        - updated_at
      properties:
        id:
          type: integer
          description: The id `getCustomAttribute` takes.
          example: 42
        key:
          type: string
          nullable: true
          description: >-
            The key the value is stored under on each contact, conversation or
            company, unique within `model`. Filled in for every definition in
            practice; `null` is possible only because the underlying column
            allows it.
          example: plan
        name:
          type: string
          nullable: true
          description: >-
            The name the Cloud Chat screen shows. Filled in for every definition
            in practice; `null` is possible only because the underlying column
            allows it.
          example: Plan
        description:
          type: string
          nullable: true
          description: >-
            What the field is for, as written by the administrator. `null` when
            none was written.
          example: Plan the customer subscribed to.
        type:
          type: string
          enum:
            - text
            - number
            - currency
            - percent
            - link
            - date
            - list
            - checkbox
            - multi_list
          description: >-
            Kind of value the field holds: `text`, `number`, `currency`,
            `percent`, `link`, `date`, `list` (one of the options in `values`),
            `checkbox` or `multi_list` (several of the options in `values`).
          example: list
        model:
          type: string
          enum:
            - conversation
            - contact
            - company
          description: >-
            What the field is attached to: a `conversation`, a `contact` or a
            `company`.
          example: contact
        values:
          type: array
          items:
            type: string
          description: >-
            The options of a `list` or `multi_list` field, in order. Empty for
            every other type.
          example:
            - free
            - pro
            - enterprise
        required:
          type: boolean
          description: >-
            Whether the field has to be filled. For a `conditional` field it
            applies only while the field is shown.
          example: false
        regex_pattern:
          type: string
          nullable: true
          description: >-
            Pattern the text typed into this field has to match, as a plain
            pattern or a `/pattern/flags` literal. Cloud Chat enforces it on
            company values and on the screen and the website chat form; a
            contact or conversation value written through this API is not
            checked against it. `null` when there is none.
          example: /^[0-9]{11}$/
        regex_cue:
          type: string
          nullable: true
          description: >-
            What Cloud Chat tells the person when the text does not match
            `regex_pattern`. `null` when none was written.
          example: Only the 11 digits of the CPF.
        conditional:
          type: boolean
          description: >-
            `true` when the field only appears depending on the value of another
            field (a sub-list). Its parent is configured in the Cloud Chat
            screen.
          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-05-02T11:04:17.000Z'
    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.
    CustomAttributeConflictError:
      type: object
      description: >-
        The 409 `createCustomAttribute` answers when the key is already taken in
        that model.
      required:
        - error
      properties:
        error:
          type: object
          required:
            - code
            - message
            - details
          properties:
            code:
              type: string
              enum:
                - conflict
              example: conflict
            message:
              type: string
              description: >-
                Localized to the account's language, like every other envelope
                message.
              example: The request conflicts with the current state of the resource.
            details:
              type: array
              items:
                type: object
                required:
                  - field
                  - code
                  - message
                properties:
                  field:
                    type: string
                    enum:
                      - key
                    example: key
                  code:
                    type: string
                    enum:
                      - taken
                    example: taken
                  message:
                    type: string
                    description: >-
                      The rule in words, localized to the account's language. It
                      includes the id of the definition that already exists when
                      you can read it.
                  existing_attribute_id:
                    type: integer
                    description: >-
                      The id of the definition that already has this key: read
                      it with `getCustomAttribute`. Left out when your identity
                      is not allowed to see that definition.
                    example: 42
    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.