Skip to main content
POST
/
crm
/
objects
/
{objectTypeId}
/
fields
Create a CRM field
curl --request POST \
  --url https://http.us.breakcold.com/api/v1/crm/objects/{objectTypeId}/fields \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "slug": "<string>",
  "name": "<string>",
  "fieldType": "<string>",
  "description": "<string>",
  "isRequired": true,
  "isMultiple": true,
  "showInCreateModal": true,
  "defaultValue": "<unknown>",
  "validation": {},
  "targetObjectTypeId": "<string>",
  "notifyOnAssign": true,
  "interactionRollupMode": "<string>",
  "relationCardinality": "<string>",
  "inverseName": "<string>",
  "inverseSlug": "<string>",
  "defaultValueTemplate": "<string>",
  "isComputed": true,
  "computeExpression": "<string>",
  "isIdentifier": true,
  "options": [
    {
      "id": "<string>",
      "fieldDefinitionId": "<string>",
      "value": "<string>",
      "label": "<string>",
      "order": 123,
      "isDefault": true,
      "isActive": true,
      "color": "<string>"
    }
  ]
}
'
{
  "field": {
    "id": "<string>",
    "workspaceId": "<string>",
    "objectTypeId": "<string>",
    "slug": "<string>",
    "name": "<string>",
    "fieldType": "<string>",
    "isSystem": true,
    "isRequired": true,
    "isHidden": true,
    "isMultiple": true,
    "isPrimary": true,
    "order": 123,
    "createdAt": 123,
    "updatedAt": 123,
    "description": "<string>",
    "isReadOnly": true,
    "showInCreateModal": true,
    "defaultValue": "<unknown>",
    "validation": {},
    "targetObjectTypeId": "<string>",
    "relationDefinitionId": "<string>",
    "notifyOnAssign": true,
    "defaultValueTemplate": "<string>",
    "isComputed": true,
    "computeExpression": "<string>",
    "isIdentifier": true
  }
}

Documentation Index

Fetch the complete documentation index at: https://docs.breakcold.com/llms.txt

Use this file to discover all available pages before exploring further.

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.

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