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

> Define a new custom session status under one of the built-in statuses. Names are unique per organization.

# Create a custom status



## OpenAPI

````yaml post /custom-statuses
openapi: 3.1.0
info:
  title: OpenCX API
  description: >

    OpenCX is an AI-powered, all-in-one platform for customer support and
    outbound communications.


    Use this API to manage your OpenCX organization's AI agents, actions,
    conversations, contacts, and more.


    To get started, generate a new API key from the dashboard.


    ## Authentication

    All API endpoints require authentication using a Bearer token. You can
    generate an API key from your OpenCX dashboard.


    ## Rate Limiting

    API requests are rate limited to ensure fair usage. The current limits are:

    - 100 requests per minute for standard endpoints

    - 1000 requests per minute for streaming endpoints


    ## Error Handling

    The API uses standard HTTP status codes and returns detailed error messages
    in the response body.
  version: 1.0-beta
  license:
    name: MIT
    url: https://opensource.org/licenses/MIT
servers:
  - url: http://localhost:8080
    description: Development
  - url: https://api.open.cx
    description: Production
security:
  - bearerAuth: []
paths:
  /custom-statuses:
    post:
      summary: Create a custom status
      description: >-
        Create a custom session status under one of the built-in statuses. Names
        are unique per organization. Once created, apply it to a session with
        `PUT /chat/sessions/{session_id}/sub-status`.
      operationId: createCustomStatus
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateCustomStatusDto'
      responses:
        '201':
          description: Default Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CustomSessionStatusDto'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorDto'
components:
  schemas:
    CreateCustomStatusDto:
      $schema: https://json-schema.org/draft/2020-12/schema
      $id: '#/components/schemas/CreateCustomStatusDtoInput'
      type: object
      properties:
        name:
          type: string
          minLength: 1
          maxLength: 100
          description: >-
            Internal name shown to agents in the inbox (unique per organization,
            1-100 chars)
        description:
          description: >-
            Internal note for agents on when to use this status. Never shown to
            customers.
          type: string
        parent_status:
          type: string
          enum:
            - closed_resolved
            - closed_unresolved
            - open
          description: >-
            Built-in status this custom status refines: "open",
            "closed_resolved", or "closed_unresolved". Applying the custom
            status to a session moves the session to this built-in status, so an
            "open"-parented status reopens a closed session and a
            "closed_*"-parented one closes it.
        display_name:
          description: >-
            Customer-facing label (max 100 chars). Falls back to `name` when
            omitted.
          type: string
          maxLength: 100
        display_description:
          description: >-
            Customer-facing explanation. No fallback: when omitted, customers
            see no description.
          type: string
        color:
          description: 'Badge color as #RRGGBB. Omit to inherit the parent status color.'
          type: string
          pattern: ^#[0-9a-fA-F]{6}$
        icon:
          description: >-
            Inline SVG markup for the badge icon (sanitized server-side, max
            10,000 chars). Omit for the default icon.
          type: string
          maxLength: 10000
          pattern: ^<svg[\s>]
      required:
        - name
        - parent_status
    CustomSessionStatusDto:
      $schema: https://json-schema.org/draft/2020-12/schema
      $id: '#/components/schemas/CustomSessionStatusDto'
      type: object
      properties:
        id:
          type: string
        org_id:
          type: string
        name:
          type: string
        description:
          anyOf:
            - type: string
            - type: 'null'
        display_name:
          anyOf:
            - type: string
            - type: 'null'
        display_description:
          anyOf:
            - type: string
            - type: 'null'
        color:
          anyOf:
            - type: string
            - type: 'null'
        icon:
          anyOf:
            - type: string
            - type: 'null'
        parent_status:
          type: string
          enum:
            - closed_resolved
            - closed_unresolved
            - open
        created_at:
          type: string
          format: date-time
        updated_at:
          type: string
          format: date-time
      required:
        - id
        - org_id
        - name
        - description
        - display_name
        - display_description
        - color
        - icon
        - parent_status
        - created_at
        - updated_at
      additionalProperties: false
    ErrorDto:
      type: object
      properties:
        statusCode:
          type: integer
        message:
          type: string
        error:
          type: string
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT

````