Update a field

Path Parameters

fieldId
Type: integer
required

ID of field

Body·

required

application/json

actionId
Type: integer

The action to fire after the button click.
aiCreativity
Type: string enum

Controls the expressiveness of the language in the content. Only works if type=ai
values
- high
- medium
- low
aiFormatting
Type: string enum

Refers to the structural and visual organization of the content. Only works if type=ai
values
- text
- formatted_text
- bullets
- numbered_list
aiLength
Type: string enum

Specifies the desired extent of the content. Only works if type=ai
values
- auto
- word_or_two
- sentence
- few_sentences
- paragraph
- three_paragraphs
aiPrompt
Type: string

The Prompt field is a text parameter used to define the specific input for generating responses or actions in OpenAI's models. Only works if type=ai
aiType
Type: string enum

Specifies whether the AI field should be controlled automatically or manually.
values
- auto
- manual
aiVoiceTone
Type: string enum

Determines the style and attitude of AI response. Only works if type=ai
values
- auto
- professional
- casual
- straightforward
- confident
- friendly
- humorous
- inspirational
className
Type: string

Name of CSS class.
currencyId
Type: integer

ID of the currency used for the money input type.
description
Type: string

Description of input
fieldGroups
Type: array integer[]

IDs of the FieldGroup's this field belongs to, controlling where it is rendered.
inputCalculation
Type: string

Formula used to compute the field value. The value is evaluated at read time and is not stored; the resulting FieldValue is read-only. Syntax: reference other fields of the same record with FIELD("Field Name"), where the argument is the field's name (customFieldInputName) for custom fields, or the property name of a core column (e.g. FIELD("id"), FIELD("created")). String literals are written in double quotes ("text"), numbers as plain literals (42, 3.14), booleans as true/false. Operators: arithmetic + - * / % ^, comparison == != > < >= <=, logical && || !, parentheses for grouping. Functions are called as name(arg1, arg2, ...) and their names are case-insensitive. Available functions — arithmetic: sum, subtract, multiply, divide, mod, power, sqrt, abs, round, roundUp, roundDown, ceil, floor, average, max, min, count, countAll; logic: if, switch, and, or, not, xor, equals, greaterThan, lessThan, isEmpty, isNotEmpty, isError; text: concat, length, lower, upper, trim, contains, startsWith, endsWith, replace, substring, left, right, split, indexOf, regexMatch, regexExtract, regexReplace, format; date: now, today, dateAdd, dateSubtract, dateDiff, formatDate, year, month, day, weekday, isAfter, isBefore, workdays; array: arrayJoin, arrayUnique, arrayLength; conversion: toNumber, toString, toBoolean, toDate; record: field, recordId, createdAt, updatedAt, createdByUserId, createdByUserName. Example: if(FIELD("Deal Value") > 1000, concat("VIP: ", FIELD("Company")), "Standard"). Use POST /validate-calculation-function to check a formula before saving. Only works if type=calculation

Responses

application/json
application/json
application/json
application/json
application/json
application/json

put/field/{fieldId}

curl https://test.boost.space/api/field/1 \
  --request PUT \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --data '{
  "id": 42,
  "created": "2026-01-15T09:30:00Z",
  "createdUserId": 42,
  "name": "Sample name",
  "description": "string",
  "tooltip": "string",
  "percentUpTo100": true,
  "isLabel": "string",
  "className": "Sample className",
  "relatedEntityCfId": "string",
  "relatedValueCounterpart": true,
  "property": "string",
  "inputType": "related_entity",
  "required": true,
  "order=0": 1,
  "fieldGroups": [
    1
  ],
  "actionId": 42,
  "currencyId": 42,
  "inputOptions": [
    {
      "id": 42,
      "created": "2026-01-15T09:30:00Z",
      "createdUserId": 42,
      "customFieldInputId": 42,
      "label": "string",
      "value": "string",
      "color": "#1f6feb"
    }
  ],
  "remotes": [
    {
      "id": "1",
      "application": "string",
      "delete": true
    }
  ],
  "spaces": [
    1
  ],
  "inputCalculation": "string",
  "relatedCustomModuleId": 42,
  "relatedEntityProperty": "string",
  "provider": "platform",
  "providerId": 42,
  "visible": true,
  "rollupRelationInputId": 42,
  "rollupTargetInputId": 42,
  "rollupAggregation": "showOriginal",
  "aiPrompt": "string",
  "aiVoiceTone": "auto",
  "aiLength": "auto",
  "aiFormatting": "text",
  "aiCreativity": "high",
  "aiType": "auto",
  "translatable": true
}'

Show Schema

{
  "id": 42,
  "created": "2026-01-15T09:30:00Z",
  "createdUserId": 42,
  "name": "Sample name",
  "description": "string",
  "tooltip": "string",
  "percentUpTo100": true,
  "isLabel": "string",
  "className": "Sample className",
  "relatedEntityCfId": "string",
  "relatedValueCounterpart": true,
  "property": "string",
  "inputType": "related_entity",
  "required": true,
  "order=0": 1,
  "fieldGroups": [
    1
  ],
  "actionId": 42,
  "currencyId": 42,
  "inputOptions": [
    {
      "id": 42,
      "created": "2026-01-15T09:30:00Z",
      "createdUserId": 42,
      "customFieldInputId": 42,
      "label": "string",
      "value": "string",
      "color": "#1f6feb"
    }
  ],
  "remotes": [
    {
      "id": "1",
      "application": "string",
      "delete": true
    }
  ],
  "spaces": [
    1
  ],
  "inputCalculation": "string",
  "relatedCustomModuleId": 42,
  "relatedEntityProperty": "string",
  "provider": "platform",
  "providerId": 42,
  "visible": true,
  "rollupRelationInputId": 42,
  "rollupTargetInputId": 42,
  "rollupAggregation": "showOriginal",
  "aiPrompt": "string",
  "aiVoiceTone": "auto",
  "aiLength": "auto",
  "aiFormatting": "text",
  "aiCreativity": "high",
  "aiType": "auto",
  "translatable": true
}

Response 200