EntityFieldsUpdateInput

Request model for updating an existing field. All fields are optional.

  • config
    Type: Confignullable

    Field configuration

    Properties: 1
  • dataSource
    Type: DataSourceenumnullable

    Source of field data (optional for creation)

    values
    • system
    • manual
    • hybrid
    • company
    • person
    • lead
    • deal
    • contract
  • displayType
    Type: DisplayTypeenumnullable

    Type of field display (optional for creation)

    values
    • text
    • textarea
    • number
    • date
    • date_range
    • single_select
    • multi_select
    • email
  • dreamerFlow
    Type: Dreamerflownullable

    Dreamer flow configuration

    Properties: 1
  • fieldType
    Type: FieldTypeenumnullable

    Type of field

    values
    systemeditable_systemcustomlinkedheaderscoadditionalformula
  • filledByDreamer
    Type: booleannullable

    Whether field is filled by dreamer

  • helpText
    Type: stringnullable

    Help text for the field

  • label
    Type: stringnullable

    Display label for the field

  • linkedDataInfo
    nullable

    Linked data information (LinkedDataInfo for LINKED fields, SCODataInfo for SCO fields)

    Structured validation for linked data information

    • sourceKey
      Type: string
      required

      Source key field

    • targetKey
      Type: string
      required

      Target key field

    • targetTable
      Type: string
      required

      Target table name

    • targetType
      Type: string
      required

      Target field type

    • targetField
      Type: stringnullable

      Target field key; set from target_field_id on create

    • targetFieldId
      Type: stringnullable

      Id of the target field (create input only, never stored)

  • required
    Type: booleannullable

    Whether the field is required

  • showInCreation
    Type: booleannullable

    Whether to show in creation forms

  • showInDetailedView
    Type: booleannullable

    Whether the field should be displayed in the entity's detailed view

  • propertyName
    additionalPropertyType: anything