Create a column data validation config

​

Body·

required
application/json
  • columnKey
    Type: string

    Identifier of the custom field column this validation rule is applied to.

  • customInputId
    Type: integer

    ID of the custom field input (Field) this validation rule is bound to.

  • enabled
    Type: boolean

    Whether this column data validation rule is active and will be applied during processing.

  • includeEmptyFields
    Type: boolean

    When true, records with an empty value in the target column are also submitted for validation.

  • module
    Type: string

    System name of the module (e.g. contact, deal) that owns the column being validated.

  • prompt
    Type: string

    User-defined instruction sent to the AI describing how the column value should be validated.

  • provider
    Type: "platform" or "websearch" or "custom"enum

    AI backend used for the validation: platform = Boost.space built-in AI, websearch = web-augmented AI, custom = user-configured provider.

Responses

  • application/json
  • application/json
  • application/json
  • application/json
  • application/json
  • application/json
Request Example for post/ai/column-data-validation
curl https://test.boost.space/api/ai/column-data-validation \
  --request POST \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --data '{
  "id": 42,
  "columnKey": "string",
  "module": "string",
  "provider": "platform",
  "prompt": "string",
  "enabled": true,
  "includeEmptyFields": true,
  "customInputId": 42
}'

{
  "id": 42,
  "columnKey": "string",
  "module": "string",
  "provider": "platform",
  "prompt": "string",
  "enabled": true,
  "includeEmptyFields": true,
  "customInputId": 42
}

Created Ai column data validation config

Previous
List column data validation configs
Next
Get a column data validation result