Skip to main content
POST
Create 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.

Body

application/json

enum fields require at least one enumValues entry, and only enum fields may carry them. json fields cannot be searchable or displayInList. Lengths count Unicode code points after trimming.

label
string
required
Required string length: 1 - 120
type
enum<string>
required

Case-insensitive; stored lowercased.

Available options:
text,
number,
date,
boolean,
enum,
json
key
string

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

Maximum string length: 64
description
string
Maximum string length: 1000
required
boolean
enumValues
object[]
Maximum array length: 100
searchable
boolean
displayInList
boolean
priority
integer
Required range: 0 <= x <= 1000000

Response

Success

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

data
object