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

# Update Saas Field

> Update a SaaS field.



## OpenAPI

````yaml https://config.heyhumm.ai/api/openapi.json put /api/integration-sources/{source_id}/saas-objects/{object_id}/saas-fields/{field_id}
openapi: 3.1.0
info:
  title: Configuration API
  description: >-
    API for managing configuration and queues for various services. This service
    consolidates the API functionality previously provided by dd_rag_api and
    code_rag_api.
  version: 1.0.0
servers:
  - url: https://config.heyhumm.ai
security: []
paths:
  /api/integration-sources/{source_id}/saas-objects/{object_id}/saas-fields/{field_id}:
    put:
      tags:
        - Integration Sources
      summary: Update Saas Field
      description: Update a SaaS field.
      operationId: >-
        update_saas_field_api_integration_sources__source_id__saas_objects__object_id__saas_fields__field_id__put
      parameters:
        - name: source_id
          in: path
          required: true
          schema:
            anyOf:
              - type: string
                format: uuid
              - type: 'null'
            title: Source Id
        - name: object_id
          in: path
          required: true
          schema:
            type: string
            format: uuid
            title: Object Id
        - name: field_id
          in: path
          required: true
          schema:
            type: string
            format: uuid
            title: Field Id
        - name: organization_id
          in: query
          required: false
          schema:
            anyOf:
              - type: string
                format: uuid
              - type: 'null'
            title: Organization Id
        - name: resource_id
          in: query
          required: false
          schema:
            anyOf:
              - type: string
                format: uuid
              - type: 'null'
            title: Resource Id
        - name: integration_source_id
          in: query
          required: false
          schema:
            anyOf:
              - type: string
                format: uuid
              - type: 'null'
            title: Integration Source Id
        - name: data_source_id
          in: query
          required: false
          schema:
            anyOf:
              - type: string
                format: uuid
              - type: 'null'
            title: Data Source Id
        - name: context_source_id
          in: query
          required: false
          schema:
            anyOf:
              - type: string
                format: uuid
              - type: 'null'
            title: Context Source Id
        - name: job_id
          in: query
          required: false
          schema:
            anyOf:
              - type: string
                format: uuid
              - type: 'null'
            title: Job Id
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SaaSFieldUpdate'
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SaaSFieldResponse'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      security:
        - HTTPBearer: []
components:
  schemas:
    SaaSFieldUpdate:
      properties:
        field_name:
          anyOf:
            - type: string
            - type: 'null'
          title: Field Name
        api_identifier:
          anyOf:
            - type: string
            - type: 'null'
          title: Api Identifier
        data_type:
          anyOf:
            - type: string
            - type: 'null'
          title: Data Type
        description:
          anyOf:
            - type: string
            - type: 'null'
          title: Description
        is_required:
          anyOf:
            - type: boolean
            - type: 'null'
          title: Is Required
        is_unique:
          anyOf:
            - type: boolean
            - type: 'null'
          title: Is Unique
        skip_embedding:
          type: boolean
          title: Skip Embedding
          description: Skip automatic embedding trigger for bulk operations
          default: false
        semantic_type:
          anyOf:
            - type: string
            - type: 'null'
          title: Semantic Type
        semantic_type_confidence:
          anyOf:
            - type: number
            - type: 'null'
          title: Semantic Type Confidence
        sample_values:
          anyOf:
            - items: {}
              type: array
            - type: 'null'
          title: Sample Values
        enum_cardinality:
          anyOf:
            - type: integer
            - type: 'null'
          title: Enum Cardinality
        null_pct:
          anyOf:
            - type: number
            - type: 'null'
          title: Null Pct
        distinct_pct:
          anyOf:
            - type: number
            - type: 'null'
          title: Distinct Pct
        last_analyzed:
          anyOf:
            - type: string
              format: date-time
            - type: 'null'
          title: Last Analyzed
        approx_distinct_count:
          anyOf:
            - type: integer
            - type: 'null'
          title: Approx Distinct Count
        minhash_signature:
          anyOf:
            - items:
                type: integer
              type: array
            - type: 'null'
          title: Minhash Signature
        format_signature:
          anyOf:
            - additionalProperties:
                type: number
              type: object
            - type: 'null'
          title: Format Signature
        length_stats:
          anyOf:
            - additionalProperties:
                type: number
              type: object
            - type: 'null'
          title: Length Stats
        entropy:
          anyOf:
            - type: number
            - type: 'null'
          title: Entropy
        role:
          anyOf:
            - type: string
            - type: 'null'
          title: Role
        role_confidence:
          anyOf:
            - type: number
            - type: 'null'
          title: Role Confidence
        is_active:
          anyOf:
            - type: boolean
            - type: 'null'
          title: Is Active
        description_source:
          anyOf:
            - type: string
              enum:
                - ai_generated
                - manual_edit
                - imported
                - information_schema
            - type: 'null'
          title: Description Source
        description_generated_at:
          anyOf:
            - type: string
              format: date-time
            - type: 'null'
          title: Description Generated At
      type: object
      title: SaaSFieldUpdate
      description: Model for updating a SaaS field.
    SaaSFieldResponse:
      properties:
        saas_object_id:
          type: string
          format: uuid
          title: Saas Object Id
          description: The SaaS object this field belongs to
        field_name:
          type: string
          title: Field Name
          description: Display name for the SaaS field (e.g., 'Email')
        api_identifier:
          type: string
          title: Api Identifier
          description: API identifier for the SaaS field (e.g., 'email')
        data_type:
          type: string
          title: Data Type
          description: The data type of the field (e.g., 'string', 'number')
        description:
          anyOf:
            - type: string
            - type: 'null'
          title: Description
          description: Optional description of the field
        is_required:
          anyOf:
            - type: boolean
            - type: 'null'
          title: Is Required
          description: Whether this field is required
        is_unique:
          anyOf:
            - type: boolean
            - type: 'null'
          title: Is Unique
          description: Whether this field must be unique
        is_active:
          type: boolean
          title: Is Active
          description: Whether this field is enabled and visible to the analysis agent
          default: true
        semantic_type:
          anyOf:
            - type: string
            - type: 'null'
          title: Semantic Type
          description: Semantic type of the field (e.g., email, phone, date)
        semantic_type_confidence:
          anyOf:
            - type: number
            - type: 'null'
          title: Semantic Type Confidence
          description: Confidence score for the detected semantic type
        sample_values:
          anyOf:
            - items: {}
              type: array
            - type: 'null'
          title: Sample Values
          description: Sample values from the field
        enum_cardinality:
          anyOf:
            - type: integer
            - type: 'null'
          title: Enum Cardinality
          description: Number of distinct values (for enum-like fields)
        null_pct:
          anyOf:
            - type: number
            - type: 'null'
          title: Null Pct
          description: Percentage of null values in this field
        distinct_pct:
          anyOf:
            - type: number
            - type: 'null'
          title: Distinct Pct
          description: Percentage of distinct values in this field
        last_analyzed:
          anyOf:
            - type: string
              format: date-time
            - type: 'null'
          title: Last Analyzed
          description: When this field was last analyzed for metadata
        approx_distinct_count:
          anyOf:
            - type: integer
            - type: 'null'
          title: Approx Distinct Count
          description: Approximate number of distinct values (HyperLogLog)
        minhash_signature:
          anyOf:
            - items:
                type: integer
              type: array
            - type: 'null'
          title: Minhash Signature
          description: MinHash signature for estimating Jaccard similarity
        format_signature:
          anyOf:
            - additionalProperties:
                type: number
              type: object
            - type: 'null'
          title: Format Signature
          description: Distribution of detected value formats / regex patterns
        length_stats:
          anyOf:
            - additionalProperties:
                type: number
              type: object
            - type: 'null'
          title: Length Stats
          description: Value length statistics (min, mean, p95)
        entropy:
          anyOf:
            - type: number
            - type: 'null'
          title: Entropy
          description: Shannon entropy approximation for value distribution
        role:
          anyOf:
            - type: string
            - type: 'null'
          title: Role
          description: Inferred field role (e.g., PRIMARY_KEY_CANDIDATE)
        role_confidence:
          anyOf:
            - type: number
            - type: 'null'
          title: Role Confidence
          description: Confidence score for the inferred field role
        description_source:
          anyOf:
            - type: string
              enum:
                - ai_generated
                - manual_edit
                - imported
                - information_schema
            - type: 'null'
          title: Description Source
          description: >-
            How description was created: 'ai_generated' | 'manual_edit' |
            'imported' | 'information_schema'
        description_generated_at:
          anyOf:
            - type: string
              format: date-time
            - type: 'null'
          title: Description Generated At
          description: When description was last modified
        id:
          type: string
          format: uuid
          title: Id
        created_at:
          type: string
          format: date-time
          title: Created At
        updated_at:
          type: string
          format: date-time
          title: Updated At
      type: object
      required:
        - saas_object_id
        - field_name
        - api_identifier
        - data_type
        - id
        - created_at
        - updated_at
      title: SaaSFieldResponse
      description: Response model for SaaS fields.
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
              - type: string
              - type: integer
          type: array
          title: Location
        msg:
          type: string
          title: Message
        type:
          type: string
          title: Error Type
      type: object
      required:
        - loc
        - msg
        - type
      title: ValidationError
  securitySchemes:
    HTTPBearer:
      type: http
      scheme: bearer

````