Skip to main content
PUT
Update custom field

Authorizations

Authorization
string
header
required

API key or session token (Bearer)

Path Parameters

id
string
required

Body

application/json
name
string

New name for the field. Cannot be blank.

type
enum<string>

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.

Available options:
text,
number,
date,
dropdown,
boolean,
multiselect
required
boolean

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

defaultValue
string | null

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

options
string[]

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.

Response

The updated custom field

id
string
required
projectId
string
required
name
string
required
type
string
required
required
boolean
required
defaultValue
string | null
required
position
number
required
createdAt
string<date-time>
required
updatedAt
string<date-time>
required
options
any