Definitions
Create a definition
POST/definitions
ScopeadminRoleOwner or adminBilling1 credit per call
Creates a custom field. The name must produce a nonempty slug; enum slugs must be unique within the definition. captureEnabled: true is rejected until automatic capture ships.
Headers
Idempotency-Keystringoptional
1–128 visible ASCII characters. Retrying with the same key returns the original response; reusing it for different input returns 409.
Body
namestringrequired
1–80 characters. Slugified to snake_case.
moduleKeyenumrequired
customers · partners · investors · recruiting · advisors · vendors
entityKindsenum[]required
1–4 of account · contact · deal · investor
valueTypeenumrequired
enum · text · number · boolean · date · person_ref · account_ref
cardinalityenumoptional
exclusive (default) or multi. Enum definitions only.
enumValuesEnumValue[]optional
Up to 200 { label, slug?, description?, color? }. Required when valueType is enum.
descriptionstringoptional
Up to 1000 characters.
instructionstringoptional
Guidance for the extractor. Up to 2000 characters.
refreshPolicyenumoptional
on_ingest (default) · on_ingest_and_backfill · manual
autoApplyThresholdnumberoptional
0–1, default 0.85. Must be ≥ reviewThreshold.
reviewThresholdnumberoptional
0–1, default 0.6.
chatVisiblebooleanoptional
Default true.
reasonstringrequired
Why this change is being made. 1–500 characters. Stored in the audit trail.
Response
…Definition