Skip to main content
POST
Create a CRM field

Authorizations

Authorization
string
header
required

Breakcold public API key, for example Bearer bc_live_....

Headers

X-Breakcold-Organization-Id
string

Breakcold organization ID. API keys already carry their organization, so most API-key requests do not need this header. Use it only when Breakcold asks you to choose an organization for a signed-in user token.

Idempotency-Key
string

Stable unique key for the intended write. Reuse the same key when retrying the same request; use a different key for an intentional duplicate.

Required string length: 1 - 200

Path Parameters

objectTypeId
string
required

Body

application/json
slug
string
required
name
string
required
fieldType
string
required
description
string
isRequired
boolean
isMultiple
boolean
showInCreateModal
boolean
defaultValue
any
validation
object
targetObjectTypeId
string
Minimum string length: 6
notifyOnAssign
boolean
interactionRollupMode
string
relationCardinality
string
inverseName
string
inverseSlug
string
defaultValueTemplate
string
isComputed
boolean
computeExpression
string
isIdentifier
boolean
options
object[]

Response

Success

field
object
required