Create Field

​

Body·

required
application/json

For field creation - enforces required fields

  • fieldType
    Type: enum
    required

    Type of field

    values
    systemeditable_systemcustomlinkedheaderscoadditionalformula
  • config
    Type: Confignullable

    Field configuration

    Properties: 1
  • dataSource
    Type: enumnullable

    Source of field data (optional for creation)

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

    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
  • 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: boolean

    Whether the field is required

  • showInCreation
    Type: boolean

    Whether to show in creation forms

  • showInDetailedView
    Type: boolean

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

  • propertyName
    additionalPropertyType: anything

Responses

  • application/json
  • application/json
Request Example for post/deals/fields/
curl https://crm.dreamhub.ai/api/v1/settings/deals/fields/ \
  --request POST \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --data '{
  "label": "",
  "fieldType": "system",
  "displayType": "text",
  "dataSource": "system",
  "filledByDreamer": true,
  "dreamerFlow": {
    "additionalProperty": "anything"
  },
  "showInCreation": true,
  "showInDetailedView": true,
  "required": false,
  "config": {
    "additionalProperty": "anything"
  },
  "linkedDataInfo": {
    "targetTable": "",
    "sourceKey": "",
    "targetKey": "",
    "targetField": "",
    "targetType": "",
    "targetFieldId": ""
  },
  "helpText": "",
  "additionalProperty": "anything"
}'

{
  "id": "string",
  "field": {
    "label": "string",
    "fieldType": "string",
    "displayType": "string",
    "dataSource": "system",
    "filledByDreamer": true,
    "dreamerFlow": {
      "additionalProperty": "anything"
    },
    "showInCreation": true,
    "showInDetailedView": true,
    "required": false,
    "config": {
      "additionalProperty": "anything"
    },
    "linkedDataInfo": {
      "targetTable": "string",
      "sourceKey": "string",
      "targetKey": "string",
      "targetField": "string",
      "targetType": "string"
    },
    "helpText": "string",
    "id": "string",
    "fieldKey": "string",
    "order": 1,
    "createdAt": "2026-09-29T00:02:05.372Z",
    "isDeleted": false,
    "readOnly": false,
    "fieldManagement": {
      "canEditDefinition": false,
      "canHide": false,
      "canDelete": false,
      "canReorder": true,
      "canEditOptions": false
    },
    "section": 1,
    "additionalProperty": "anything"
  }
}

Successful Response