Skip to main content
PUT

Authorizations

X-API-Key
string
header
required

Headers

customer
string
required

Workspace identifier

Path Parameters

projectId
string
required
id
string
required

Body

application/json
addOnly
boolean
default:false

When true, fields becomes an additive "ensure this schema exists" list: omitted fields are preserved, existing fields keep their current name/type/settings, and only missing fields or missing plain-tag options are added. If an existing field key is sent with a different type, the request is rejected instead of converting the field. Without addOnly, fields keeps its normal replacement semantics.

Example:

true

categoryType
enum<string>
Available options:
folder,
item
fields
object[]

Custom fields for this category. By default, sending this list replaces the customer-managed field list, so omitted fields are removed. Set addOnly=true to preserve existing fields and only add missing fields/tag options.

humanIdPrefix
string | null
Maximum string length: 32
name
string

Response

200 - application/json
builtin
boolean
required
categoryType
enum<string>
required
Available options:
folder,
item
fields
object[]
required
humanIdPrefix
string
required
humanIdPrefixLocked
boolean
required
id
string
required
name
string
required