Skip to main content
POST
/
crm
/
objects
/
{objectTypeId}
/
views
Create a CRM record view
curl --request POST \
  --url https://http.us.breakcold.com/api/v1/crm/objects/{objectTypeId}/views \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "emoji": "<string>",
  "isDefault": true,
  "kanbanFieldDefinitionId": "<string>",
  "kanbanWinOptionIds": [
    "<string>"
  ],
  "kanbanLossOptionIds": [
    "<string>"
  ],
  "config": {}
}
'
{
  "view": {
    "id": "<string>",
    "workspaceId": "<string>",
    "objectTypeId": "<string>",
    "name": "<string>",
    "isDefault": true,
    "config": {},
    "createdAt": 123,
    "updatedAt": 123,
    "emoji": "<string>",
    "order": 123,
    "createdBy": "<string>",
    "kanbanFieldDefinitionId": "<string>",
    "kanbanWinOptionIds": [
      "<string>"
    ],
    "kanbanLossOptionIds": [
      "<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.

Path Parameters

​
objectTypeId
string
required

Body

application/json
​
name
string
required
​
emoji
string
​
type
enum<string>
Available options:
table,
kanban
​
isDefault
boolean
​
kanbanFieldDefinitionId
string
Minimum string length: 6
​
kanbanWinOptionIds
string[]
Minimum string length: 6
​
kanbanLossOptionIds
string[]
Minimum string length: 6
​
config
object

Full saved view config. Record views support columns, filters, sorts, groupBy, and kanban settings. Inbox views support filters and sorts.

Response

Success

​
view
object
required