Fields

Create Field

Create a new custom field (column) for contacts or companies.

Set list_id to make the field specific to a single list, or omit it to create a global field available across every list in the org.

Optionally pass an enrichment block to provision a companion waterfall pipeline in the same request. Without this block the column exists but has no enrichment plan, so POST /enrichment/waterfall/enrich later returns 422 (waterfall_config_missing).

post/fields

Request

  • Base URL: https://be.graph8.com/api/v1
  • URL: https://be.graph8.com/api/v1/fields
  • Auth: HTTP bearer

Headers

Authorizationstring nullable
X-Target-Org-Idstring nullable

Request body

titlestring required

Column title, e.g. 'Job Level'

data_typestring

Column data type: 'text', 'int' (whole number), 'numeric' (decimal) or 'boolean' (yes/no). Unknown values 400. If the name already exists with another type, the create is rejected with 409.

list_idinteger nullable

If set, field is list-specific; otherwise global across the org

entitystring

Target entity: 'contacts' or 'companies'

Response

Successful Response

Changes

No recorded changes to this operation across all 2 revisions of this API.