Skip to main content
POST
Create custom fields

Authorizations

Authorization
string
header
required

Workspace API key, e.g. Authorization: Bearer tented_.... Create keys in Workspace Settings → API Keys.

Body

application/json

A custom field to create.

display_name
string
required

Human-readable label.

Required string length: 1 - 255
api_name
string
required

Stable identifier: must start with a lowercase letter and contain only lowercase letters, numbers, and underscores. Standard field names (e.g. email, first_name) are reserved. Cannot be changed after creation.

Required string length: 1 - 255
Pattern: ^[a-z][a-z0-9_]*$
value_type
enum<string>
default:string

Value type for the field. Cannot be changed after creation.

Available options:
string,
number,
boolean,
date
is_editable
boolean
default:true

Whether values can be edited manually in the UI.

description
string | null

Optional description of what the field stores.

Maximum string length: 1000
show_in_people_list_default
boolean
default:false

Whether the field appears as a column in the People list by default.

Response

Custom fields created. Always returns an items array, even for a single-object request.

items
object[]
required

The created custom field definitions.