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 409 with error_code: "field_definition_cap_exceeded" plus limit, current_active_count, and attempted_count.
• An api_name that duplicates another item in the request or an existing (active or archived) custom field returns 409 with error_code: "field_definition_collision" and a conflicts array describing each collision. To reuse an archived field’s name, restore it instead via PATCH /v1/contact-fields/{fieldDefinitionId} with status: "active".
• Standard field names (email, first_name, company, …) are reserved and return 400.

POST /v1/contact-fields

Create custom fields

cURL

curl --request POST \
  --url https://api.tented.ai/v1/contact-fields \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "display_name": "<string>",
  "api_name": "<string>",
  "value_type": "string",
  "is_editable": true,
  "description": "<string>",
  "show_in_people_list_default": false
}
'

201

{
  "items": [
    {
      "type": "standard",
      "api_name": "<string>",
      "display_name": "<string>",
      "value_type": "string",
      "is_editable": true,
      "status": "active",
      "field_definition_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "description": "<string>",
      "management_mode": "org_managed",
      "provenance_kind": "manual_ui",
      "provenance_provider": "<string>",
      "provenance_reference": "<string>",
      "created_by_user_id": "<string>",
      "created_from_import_session_id": "<string>",
      "show_in_people_list_default": true,
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z"
    }
  ]
}

Authorizations

Authorization · string · header · required

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

Body

application/json

Custom field

Bulk create

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

201

application/json

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

items · object[] · required

The created custom field definitions.

Show child attributes