Skip to main content
POST
/
crm
/
objects
Create a CRM object
curl --request POST \
  --url https://http.us.breakcold.com/api/v1/crm/objects \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "workspaceId": "<string>",
  "slug": "<string>",
  "nameSingular": "<string>",
  "namePlural": "<string>",
  "icon": "<string>",
  "color": "<string>"
}
'
{
  "object": {
    "id": "<string>",
    "workspaceId": "<string>",
    "slug": "<string>",
    "nameSingular": "<string>",
    "namePlural": "<string>",
    "isSystem": true,
    "isActive": true,
    "order": 123,
    "createdAt": 123,
    "updatedAt": 123,
    "name": "<string>",
    "icon": "<string>",
    "color": "<string>"
  }
}

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.

Body

application/json
​
workspaceId
string
required
Minimum string length: 6
​
slug
string
required
​
nameSingular
string
required
​
namePlural
string
required
​
icon
string
​
color
string

Response

Success

​
object
object
required