Skip to main content
PATCH
Update a custom field

Authorizations

Authorization
string
header
required

Your API key, e.g. flv_9f2a8c1e…

Path Parameters

customFieldId
string<uuid>
required

The custom field id.

Body

application/json
name
string
Required string length: 1 - 60
description
string | null
Maximum string length: 255
options
object[]
Maximum array length: 50

Response

id
string<uuid>
required
name
string
required
fieldKey
string
required
type
enum<string>
required
Available options:
TEXT,
SINGLE_SELECT,
MULTI_SELECT,
URL
description
string | null
required
status
enum<string>
required
Available options:
ACTIVE,
ARCHIVED
options
object[]
required
createdAt
string<date-time>
required
updatedAt
string<date-time>
required