Skip to main content

​
Endpoints

Custom fields extend contacts beyond the standard schema. Values are written via the custom_fields object on contact create, update, and upsert, keyed by each field’s api_name.

​
List Fields

Returns both system fields (the built-in contact schema, read-only) and org_managed custom fields. Each definition includes api_name, display_name, value_type (string | number | boolean | date), status, is_editable, and provenance metadata.

​
Create Fields

Accepts a single definition or items[] (up to 50 per request).
Organizations can have at most 200 active custom fields. Exceeding the cap or colliding with an existing api_name (including archived ones) returns 409 with the conflicting names in details.

​
Update or Archive a Field

Updatable: display_name, description, show_in_people_list_default, and status (archived to soft-delete, active to restore). api_name and value_type are immutable; system fields are read-only and return 400. Archived fields stop accepting writes — contact upserts referencing them get a per-item rejection — but their stored values are preserved and return when the field is restored.

​
Rule Metadata

Returns every filterable field (standard + custom) with its supported operators — the vocabulary for building rule trees used by contact search and dynamic lists. Use it to build rule editors without hardcoding operator lists.

​
Common Errors