Custom Fields

Update custom field

Changed on

Update a custom field's name, required flag, default, or options. The type can't change, except between dropdown and multiselect. Options that tasks still use can't be removed or renamed; the request is rejected instead of changing task values.

put/custom-field/{id}

Request

  • Base URL
    https://cloud.kaneo.app/api
  • URL
    https://cloud.kaneo.app/api/custom-field/{id}
  • Auth
    HTTP bearer

Path parameters

idstring required

Request body

namestring

New name for the field. Cannot be blank.

type'text' | 'number' | 'date' | 'dropdown' | 'boolean' | 'multiselect'

Only dropdown and multiselect can switch between each other. Task values are converted, and switching to dropdown is rejected while a task has more than one option picked. Any other type change is rejected.

requiredboolean

Whether every task must have a value. Turning it on needs a default, which fills tasks that have no value yet.

defaultValuestring nullable

Value new tasks start with. Send null or an empty string to clear it. Multiselect defaults are a JSON array of options.

optionsstring[]

The full option list for dropdown and multiselect fields, in display order. Adding and reordering options is always allowed. Removing or renaming an option that a task still uses is rejected with 400, so task values are never changed silently.

hiddenOptionsstring[]

Options to retire without removing them: tasks keep their existing selections, but hidden options can't be picked anew or used as the default. Must be a subset of options. Omit to keep the current hidden options that are still options.

Response

The updated custom field

idstring required
projectIdstring required
namestring required
typestring required
requiredboolean required
defaultValuestring nullable required
optionsunknown
hiddenOptionsstring[] required

Options no longer offered for new selections. Tasks that already use them keep them.

positionnumber required
createdAtstring date-time required
updatedAtstring date-time required

Changes

  • 84eec352f21cRevision changes
    • info

      added the new optional request property

    • info

      added the required property to the response with the status

  • cf382d653cdcRevision changes
    • breaking

      removed the required property from the response with the status

    • warning

      removed the request property