Skip to main content
PUT
Update custom field

Authorizations

Authorization
string
header
required

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

Path Parameters

id
string
required

Custom field id. Get it from customFields.list.

Pattern: ^\d+$

Body

application/json
name
string
required

New custom field name.

Required string length: 1 - 255
description
string

Optional internal description.

folderId
string | null

Folder to place the field in, or null for root-level.

Pattern: ^\d+$

Response

OK

id
string
required
name
string
required
type
enum<string>
required
Available options:
shortText,
email,
phoneNumber,
number,
date,
datetime,
boolean,
longText
description
string | null
required