Create custom fields
Create one custom field (send a single object) or up to 50 in one request (send {"items": [...]}). Bulk creation is atomic — if any item collides, nothing is created.
Limits and collisions:
- A workspace can have at most 200 active custom fields. Exceeding the cap returns
409witherror_code: "field_definition_cap_exceeded"pluslimit,current_active_count, andattempted_count. - An
api_namethat duplicates another item in the request or an existing (active or archived) custom field returns409witherror_code: "field_definition_collision"and aconflictsarray describing each collision. To reuse an archived field’s name, restore it instead viaPATCH /v1/contact-fields/{fieldDefinitionId}withstatus: "active". - Standard field names (
email,first_name,company, …) are reserved and return400.
Authorizations
Workspace API key, e.g. Authorization: Bearer tented_.... Create keys in Workspace Settings → API Keys.
Body
- Custom field
- Bulk create
A custom field to create.
Human-readable label.
1 - 255Stable 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.
1 - 255^[a-z][a-z0-9_]*$Value type for the field. Cannot be changed after creation.
string, number, boolean, date Whether values can be edited manually in the UI.
Optional description of what the field stores.
1000Whether 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.
The created custom field definitions.