PUT
/
custom
/
fields
/
{customFieldId}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

​
customFieldId
string
required

The unique identifier of the custom field to be updated

Body

application/json
​
enabled
boolean
required
​
fieldType
enum<string>
required
Available options:
text,
checkbox,
select
​
name
string
required
Maximum length: 255
​
position
number
required
​
required
boolean
required
​
validationRules
object

Optional validation rules for the custom field

Response

200 - application/json
​
enabled
boolean
required

A flag indicating whether the custom field is active.

​
fieldType
enum<string>
required
Available options:
text,
checkbox,
select
​
id
string
required
Required string length: 36
​
key
string
required
Maximum length: 255
​
name
string
required
Maximum length: 255
​
position
number
required
​
required
boolean
required

A flag indicating whether the custom field is required.

​
validationRules
object

Optional validation rules for the custom field

Was this page helpful?

Retrieve a specific custom field by its IDDelete a specific custom field by its ID