Skip to main content
PATCH
Update a custom field

Authorizations

Authorization
string
header
required

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

Path Parameters

fieldDefinitionId
string<uuid>
required

Custom field definition ID (field_definition_id from the list or create response).

Body

application/json

At least one property is required.

display_name
string

New human-readable label.

Required string length: 1 - 255
description
string | null

New description, or null to clear it.

Maximum string length: 1000
is_editable
boolean

Whether values can be edited manually in the UI.

show_in_people_list_default
boolean

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

status
enum<string>

Set archived to archive the field, active to restore it.

Available options:
active,
archived

Response

The updated custom field definition.

A contact field definition. Standard fields include only the six required properties; custom fields include the full definition metadata.

type
enum<string>
required

standard for built-in contact fields (read-only, always active), custom for workspace custom fields.

Available options:
standard,
custom
api_name
string
required

Stable identifier used in API payloads, import mappings, and merge tags (e.g. email, firstName, or a custom field's snake_case name).

display_name
string
required

Human-readable label.

value_type
enum<string>
required

Value type. Standard fields may use email/phone; custom fields are string, number, boolean, or date.

Available options:
string,
number,
boolean,
date,
email,
phone
is_editable
boolean
required

Whether values can be edited manually in the UI. Always false for standard fields.

status
enum<string>
required

Field status. Standard fields are always active.

Available options:
active,
archived
field_definition_id
string<uuid>

Custom field definition ID — the path parameter for PATCH /v1/contact-fields/{fieldDefinitionId}. Custom fields only.

description
string | null

Optional description of what the field stores. Custom fields only.

management_mode
enum<string>

Who owns the field: org_managed (created in the UI or via this API — fully editable) or integration_managed (owned by a connected integration — name, description, and status are locked). Custom fields only.

Available options:
org_managed,
integration_managed
provenance_kind
enum<string>

How the field was created. Custom fields only.

Available options:
manual_ui,
import_csv,
integration
provenance_provider
string | null

Integration provider that created the field, when applicable. Custom fields only.

provenance_reference
string | null

Provider-side reference for the field, when applicable. Custom fields only.

created_by_user_id
string | null

Who created the field. tented-api for fields created via this API. Custom fields only.

created_from_import_session_id
string | null

Import session the field was created from, when provenance_kind is import_csv. Custom fields only.

show_in_people_list_default
boolean

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

created_at
string<date-time>

Creation time. Custom fields only.

updated_at
string<date-time>

Last update. Custom fields only.