Create a custom field definition
Defines a new custom attribute on the organization’s contact records. Send name (lowercase letters, digits and underscores — the key contacts are written under), label, type (text, number, date, boolean or select) and required; a select field also needs a non-empty options array. Names are unique per organization, so re-posting one that already exists returns 409. Marking a field required applies to the next contact create or update, not to contacts already stored. Owner/admin only.
Authorizations
Dashboard JWT token from Clerk
Headers
Stripe-style idempotency token. Pass a stable, client-generated value (1-255 chars) to dedupe retries on transient timeouts. The same key+credential+path replays the original response for 24h on 2xx (5min on 4xx, 30s on 5xx). Returns 409 if a concurrent request with the same key is already in flight; replayed responses include the Idempotency-Replay: true response header.
1 - 255Sandbox opt-in for Clerk-session-authenticated requests. Set to true to route the call through the test-mode pipeline: no real provider delivery, no credits deducted, response meta.test_mode: true. Ignored for live API keys (dv_live_sk_*) — server-to-server clients must use a test-prefixed key (dv_test_sk_*) to exercise sandbox. Test-prefixed keys unconditionally enable sandbox regardless of this header.
true, false