Skip to main content
PUT
Update an article field

Authorizations

Authorization
string
header
required

Weelkit access token.

Headers

X-Org-Id
string<uuid>
required

The organization the request acts on.

Path Parameters

fieldId
string<uuid>
required

Body

application/json
label
string
required
Maximum string length: 120
required
boolean
required
expectedRevision
integer
required
description
string | null
Maximum string length: 500
generationInstruction
string | null
Maximum string length: 500
options
object[]
defaultValue
any

Response

Success.

An organization-defined custom article output field definition.

id
string<uuid>
required
key
string
required

Backend-generated stable internal key. Immutable after creation.

Pattern: ^[a-z][a-zA-Z0-9]{1,63}$
label
string
required
Maximum string length: 120
fieldType
enum<string>
required

Allowlisted field type. Immutable after creation.

Available options:
string,
text,
number,
boolean,
select,
multiselect,
date,
url
required
boolean
required
options
object[]
required
isActive
boolean
required
sortOrder
integer
required
revision
integer
required

Optimistic-concurrency revision. Send it back as expectedRevision on writes; a stale value yields 409.

createdAtUtc
string<date-time>
required
updatedAtUtc
string<date-time>
required
description
string | null
Maximum string length: 500
generationInstruction
string | null

Bounded instruction rendered to the model during generation.

Maximum string length: 500
defaultValue
any

Default value validated against the field type and options.