Skip to main content
PATCH
Update a custom field definition

Authorizations

Authorization
string
header
required

Enter your personal access token (PAT) to authenticate

Path Parameters

workspaceUuid
string<uuid>
required

The UUID of the workspace

Example:

"550e8400-e29b-41d4-a716-446655440000"

key
string
required

The key of the custom field

Example:

"industry"

Body

application/json

Request body for updating a custom field definition

name
string | null

The human-readable name of the field

Maximum string length: 255
Example:

"Industry"

description
string | null
Maximum string length: 1000
Example:

"The primary industry of the company."

field_rules
object[] | null
options
object[] | null

Response

The updated custom field definition

A custom field definition for organisations

identifier
string

The unique identifier of the field

Example:

"industry"

key
string

The machine-readable key of the field

Example:

"industry"

name
string

The human-readable name of the field

Example:

"Industry"

entity_type
string

The entity type the field belongs to

Example:

"organisation"

type
string

The data type of the field

Example:

"text"

description
string | null
Example:

"The primary industry of the company."

group
string

The group the field belongs to

Example:

"custom"

is_visible
boolean
Example:

true

source
string

The source of the field

Example:

"manual"

rules
object[]
is_system
boolean
Example:

false

options
object[]