Skip to main content
PATCH
Update a profile custom field

Authorizations

Authorization
string
header
required

An admin application key: Authorization: Api-Key <token> (or legacy x-api-key). Only tenant owners and admins can create one. Standard keys are refused with 403 on workspace management and tenant configuration routes.

Path Parameters

orgId
string
required

The organization (tenant) id. Must equal the tenant of the admin key.

profileCustomFieldId
string
required

The profile custom field id.

Body

application/json

At least one member is required. key and type are immutable: a changed value is 409. archived archives or restores the definition.

key
string

Derived from label when omitted. Human keys are slugified ("Loan Number" → loan_number); $ and . are rejected.

Maximum string length: 64
label
string
Required string length: 1 - 120
description
string
Maximum string length: 1000
type
enum<string>

Case-insensitive; stored lowercased.

Available options:
text,
number,
date,
boolean,
enum,
json
required
boolean
enumValues
object[]
Maximum array length: 100
searchable
boolean
displayInList
boolean
priority
integer
Required range: 0 <= x <= 1000000
archived
boolean

Response

Success

Envelope { data: { id, ... } } carrying the requested tenant-configuration record(s).

data
object