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

# Update company AI field

> Update a company AI field. The update is a full replace: always send the complete field definition, as omitted optional attributes are cleared. Updating a field does not regenerate the values already produced; the new definition applies to companies as new activity comes in.

The update is a full replace: always send the complete field definition. Company AI fields cannot be mapped to a CRM property. Updating a field does not regenerate the values already produced; the new definition applies to companies as new activity comes in.


## OpenAPI

````yaml PUT /v1/companies/fields/{fieldId}
openapi: 3.1.0
info:
  title: Claap API
  description: Development documentation
  version: 0.0.0
servers:
  - url: https://api.claap.io/
security:
  - ApiKey: []
paths:
  /v1/companies/fields/{fieldId}:
    put:
      description: >-
        Update a company AI field. The update is a full replace: always send the
        complete field definition, as omitted optional attributes are cleared.
        Updating a field does not regenerate the values already produced; the
        new definition applies to companies as new activity comes in.
      operationId: putV1CompaniesAiFieldsByAiFieldId
      parameters:
        - in: path
          name: fieldId
          schema:
            type: string
            description: Company AI field identifier
          required: true
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                title:
                  type: string
                  description: The field title.
                prompt:
                  $ref: '#/components/schemas/AiFieldPromptInput'
                  description: The prompt evaluated by the AI to fill the field.
              required:
                - title
                - prompt
            example:
              title: Company overview
              prompt:
                outputType: Paragraph
                prompt: >-
                  Summarise what this company does and what its current
                  priorities are.
      responses:
        '200':
          description: Company AI field was successfully updated
          content:
            application/json:
              schema:
                type: object
                properties:
                  result:
                    $ref: '#/components/schemas/AiField'
                required:
                  - result
              example:
                result:
                  fieldId: CompanyAiSection#Jc5Ry8Nt3Pv1Gh6Ws2Ld9
                  title: Company overview
                  kind: Field
                  outputType: Paragraph
                  prompt: >-
                    Summarise what this company does and what its current
                    priorities are.
                  authorId: Xk2Rd7Mv4Bn9Ts1Lq6Wf3
                  createdAt: '2026-05-14T09:30:00Z'
        '400':
          description: >-
            The prompt is invalid (for instance `coloredSelectOptions` is
            missing for a `Select` or `MultiSelect` prompt)
        '403':
          description: The workspace plan does not include AI fields
        '404':
          description: Company AI field was not found
components:
  schemas:
    AiFieldPromptInput:
      type: object
      properties:
        outputType:
          type: string
          enum:
            - ActionList
            - Checkbox
            - Date
            - List
            - MultiSelect
            - Numeric
            - Paragraph
            - Rating
            - RichText
            - Select
          description: The type of value produced by the AI.
        prompt:
          type: string
          description: Instructions describing what the AI should extract.
        coloredSelectOptions:
          type: array
          items:
            $ref: '#/components/schemas/AiFieldSelectOption'
          description: >-
            The options the AI can choose from. Required for the `Select` and
            `MultiSelect` output types, ignored otherwise.
        hasTimecodes:
          type: boolean
          description: >-
            Whether list items are linked to the moment of the recording they
            were extracted from. Only used by the `List` output type.
        ratingScale:
          type: integer
          minimum: 2
          description: The maximum rating. Only used by the `Rating` output type.
          default: 5
      required:
        - outputType
        - prompt
      description: The prompt evaluated by the AI to fill the field.
    AiField:
      type: object
      properties:
        fieldId:
          type: string
          description: >-
            AI field identifier. Matches the `fieldId` of `AiSection` view
            columns.
        title:
          type: string
          description: The field title.
        kind:
          type: string
          enum:
            - Field
            - Global
            - View
          description: >-
            The kind of AI section. Fields managed through the API are always of
            kind `Field`.
        outputType:
          type: string
          enum:
            - ActionList
            - Checkbox
            - Date
            - List
            - MultiSelect
            - Numeric
            - Paragraph
            - Rating
            - RichText
            - Select
          description: The type of value produced by the AI.
        prompt:
          type: string
          description: Instructions describing what the AI should extract.
        coloredSelectOptions:
          type: array
          items:
            $ref: '#/components/schemas/AiFieldSelectOption'
          description: >-
            The options the AI can choose from. Only set for the `Select` and
            `MultiSelect` output types.
        hasTimecodes:
          type: boolean
          description: >-
            Whether list items are linked to the moment of the recording they
            were extracted from. Only set for the `List` output type.
        ratingScale:
          type: integer
          description: The maximum rating. Only set for the `Rating` output type.
        crmField:
          $ref: '#/components/schemas/AiFieldCrmField'
          description: >-
            The CRM property the field is mapped to. Never set for company AI
            fields.
        authorId:
          type: string
          description: Identifier of the user who created the field.
        archivedAt:
          type: string
          format: date-time
          description: When the field was archived. Only set on archived fields.
        createdAt:
          type: string
          format: date-time
          description: When the field was created.
      required:
        - fieldId
        - title
        - kind
        - outputType
        - prompt
        - createdAt
      description: >-
        An AI field: a custom prompt with a typed output, evaluated by AI.
        Usable as an `AiSection` view column through its `fieldId`.
    AiFieldSelectOption:
      type: object
      properties:
        value:
          type: string
          description: The option label, as chosen by the AI and displayed in Claap.
        color:
          type: string
          enum:
            - blue
            - green
            - yellow
            - purple
            - red
            - bordeaux
            - turquoise
          description: The option color in the Claap interface.
      required:
        - value
        - color
      description: An option of a `Select` or `MultiSelect` AI field.
    AiFieldCrmField:
      type: object
      properties:
        entity:
          type: string
          enum:
            - Call
            - Company
            - Contact
            - Deal
            - Lead
            - Meeting
          description: The CRM entity the property belongs to.
        label:
          type: string
          description: The CRM property label.
        name:
          type: string
          description: The CRM property name.
        source:
          type: string
          enum:
            - Attio
            - Hubspot
            - Pipedrive
            - Salesforce
          description: The CRM the property comes from.
        type:
          type: string
          enum:
            - Checkbox
            - Date
            - MultiSelect
            - Numeric
            - RichText
            - Select
            - Text
          description: The CRM property type.
      required:
        - entity
        - label
        - name
        - source
        - type
      description: The CRM property the AI field is mapped to.
  securitySchemes:
    ApiKey:
      type: apiKey
      in: header
      name: X-Claap-Key

````