Skip to main content
PATCH
Update custom field details

Authorizations

X-API-Key
string
header
required

Project-scoped API key, format rm_(live|test)_... . May also be sent as Authorization: Bearer rm_....

Path Parameters

key
string
required

Custom field key.

Body

application/json
displayName
string | null
Maximum string length: 100
description
string | null
Maximum string length: 500
isRequired
boolean | null

Response

Updated custom field

id
string<uuid>
key
string
displayName
string
description
string | null
type
string
status
string
isSystem
boolean
isRequired
boolean
defaultValue
string | null
createdAt
string<date-time>
updatedAt
string<date-time>
archivedAt
string<date-time> | null