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

# Update Single File Category Field

> Update the specified file category field, supports both regular fields and table fields

> ⚠️ This endpoint is still available but will no longer be maintained. Please use [Update File Category Fields](/api-reference/file-category/update-file-category-fields) instead.




## OpenAPI

````yaml /docflow-global/en/rest-api/openapi.bundle.yaml post /api/app-api/sip/platform/v2/category/fields/update
openapi: 3.0.0
info:
  title: DocFlow API
  description: >-
    DocFlow REST API, providing file upload and file processing result retrieval
    capabilities
  version: 2.8.4
servers:
  - url: https://docflow.textin.ai
security:
  - ApiId: []
    SecretCode: []
paths:
  /api/app-api/sip/platform/v2/category/fields/update:
    post:
      tags:
        - Deprecated
      summary: Update Single File Category Field
      description: >
        Update the specified file category field, supports both regular fields
        and table fields


        > ⚠️ This endpoint is still available but will no longer be maintained.
        Please use [Update File Category
        Fields](/api-reference/file-category/update-file-category-fields)
        instead.
      operationId: updateCategoryField
      requestBody:
        required: true
        content:
          application/json:
            schema:
              allOf:
                - $ref: '#/components/schemas/CategoryFieldUpdateItem'
              type: object
              properties:
                workspace_id:
                  type: string
                  description: Workspace ID
                  example: '1234567890'
                category_id:
                  type: string
                  description: File category ID
                  example: '1234567890'
                table_id:
                  type: string
                  description: >
                    Table ID

                    - Not required for regular fields

                    - Required for table fields (provide the table ID the field
                    belongs to)
                  example: '1234567890'
                with_detail:
                  type: boolean
                  description: >
                    Whether to return full details. When true, the response
                    returns the updated field's complete info.

                    When not set or false, only code/msg is returned.
              required:
                - workspace_id
                - category_id
                - field_id
      responses:
        '200':
          description: Successfully updated file category field
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CodeMessage'
components:
  schemas:
    CategoryFieldUpdateItem:
      type: object
      description: >-
        Field update item (multi_value/duplicate_value_distinct cannot be
        modified via this endpoint)
      properties:
        field_id:
          type: string
          description: Field ID
          example: '1234567890'
        name:
          type: string
          description: Field name
        description:
          type: string
          description: Field description
        prompt:
          type: string
          description: Semantic extraction prompt
        use_prompt:
          type: boolean
          description: Whether to use semantic prompt
        alias:
          type: array
          description: >-
            Field aliases. omit=no change, empty array []=clear,
            non-empty=override
          items:
            type: string
          example:
            - Invoice No.
            - Bill Number
        identity:
          type: string
          description: >-
            Export field name. omit=no change, empty string ""=clear,
            non-empty=override
          example: invoice_number
        multi_value:
          type: boolean
          description: Whether to enable multi-value extraction. Omit=no change
        duplicate_value_distinct:
          type: boolean
          description: >-
            Whether to deduplicate values. Only effective when multi_value is
            true. Omit=no change
        transform_settings:
          $ref: '#/components/schemas/TransformSettings'
        extract_model:
          type: string
          description: >
            Field-level extraction model. Only regular fields can be set
            independently; table fields cannot.

            Omit to keep existing config.

            - Auto: Automatically matches the extraction model

            - Acgpt: Fast speed with stable extraction results

            - Acgpt-VL: VLM, suitable for simple extraction (≤10 pages)

            - DF-M1: Suitable for complex document understanding
          example: Acgpt
          enum:
            - Auto
            - Acgpt
            - Acgpt-VL
            - DF-M1
      required:
        - field_id
    CodeMessage:
      type: object
      properties:
        code:
          type: integer
          description: Status code
          example: 200
        msg:
          type: string
          description: Status description
      required:
        - code
        - msg
    TransformSettings:
      type: object
      description: >-
        Field output transform configuration. Formats the extraction result
        before output.
      properties:
        type:
          type: string
          description: >
            Transform type, determines which transform rule to apply:

            - `datetime`: Normalize the extraction result to a specified date
            format

            - `enumerate`: Restrict the extraction result to one of the preset
            enumeration values

            - `regex`: Match and replace the extraction result using regular
            expressions
          enum:
            - datetime
            - enumerate
            - regex
        datetime_settings:
          type: object
          description: Datetime formatting configuration. Required when type=datetime.
          properties:
            format:
              type: string
              description: >-
                Target date format. The extraction result will be normalized to
                this format.
              example: yyyy-MM-dd
        enumerate_settings:
          type: object
          description: Enumeration constraint configuration. Required when type=enumerate.
          properties:
            items:
              type: array
              description: >-
                Allowed enumeration values. If the extraction result is not in
                this list, mismatch_action applies.
              items:
                type: string
              example:
                - VAT Special Invoice
                - VAT General Invoice
                - Electronic Invoice
        regex_settings:
          type: object
          description: Regex transform configuration. Required when type=regex.
          properties:
            match:
              type: string
              description: Regex pattern for matching or capturing the extraction result
              example: ^(\d{4})-(\d{2})-(\d{2})$
            replace:
              type: string
              description: Replacement expression, supports $1, $2 capture group references
              example: $1/$2/$3
        mismatch_action:
          type: object
          description: >-
            How to handle extraction results that don't match the transform rule
            (applies to all types, optional).
          properties:
            mode:
              type: string
              description: >
                Handling mode:

                - `default`: Output the specified default value (requires
                default_value)

                - `warning`: Keep the original extraction result, flag a warning
                for manual review
              enum:
                - default
                - warning
            default_value:
              type: string
              description: Output value when mode=default
              example: N/A
  securitySchemes:
    ApiId:
      type: apiKey
      in: header
      name: x-ti-app-id
    SecretCode:
      type: apiKey
      in: header
      name: x-ti-secret-code

````