Update a column data transform config

Path Parameters
  • entityId
    Type: integer
    required

    ID of Ai column data transform config

Body·
required
application/json
  • aiCreativity
    Type: string enum

    Controls how expressive and varied the AI output language is; high allows more creative responses.

    values
    • high
    • medium
    • low
  • aiVoiceTone
    Type: string enum

    Determines the style and attitude in which the generated content is delivered.

    values
    • auto
    • professional
    • technical
    • casual
    • straightforward
    • confident
    • friendly
    • humorous
    • inspirational
  • columnKey
    Type: string

    Identifier of the custom field column this transform is applied to.

  • customInputId
    Type: integer

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

  • enabled
    Type: boolean

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

  • module
    Type: string

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

  • prompt
    Type: string

    User-defined instruction sent to the AI to guide how the column value should be transformed.

  • provider
    Type: string enum

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

    values
    • platform
    • websearch
    • custom
  • type
    Type: string enum

    Specifies whether the AI transformation runs automatically on record change (auto) or only when triggered manually.

    values
    • auto
    • manual
Responses
  • application/json
  • application/json
  • application/json
  • application/json
  • application/json
  • application/json
Request Example for put/ai/column-data-transform/{entityId}
curl https://test.boost.space/api/ai/column-data-transform/1 \
  --request PUT \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --data '{
  "id": 42,
  "columnKey": "string",
  "module": "string",
  "prompt": "string",
  "enabled": true,
  "provider": "platform",
  "aiVoiceTone": "auto",
  "aiCreativity": "high",
  "customInputId": 42,
  "type": "auto"
}'
{
  "id": 42,
  "columnKey": "string",
  "module": "string",
  "prompt": "string",
  "enabled": true,
  "provider": "platform",
  "aiVoiceTone": "auto",
  "aiCreativity": "high",
  "customInputId": 42,
  "type": "auto"
}