Skip to main content
POST
/
inbox
/
views
Create an inbox view
curl --request POST \
  --url https://http.us.breakcold.com/api/v1/inbox/views \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "workspaceId": "<string>",
  "name": "<string>",
  "emoji": "<string>",
  "config": {}
}
'
{
  "view": {
    "id": "<string>",
    "workspaceId": "<string>",
    "name": "<string>",
    "isSystem": true,
    "config": {},
    "createdAt": 123,
    "updatedAt": 123,
    "emoji": "<string>",
    "systemViewKey": "<string>",
    "createdByUserId": "<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
name
string
required
emoji
string
visibility
enum<string>
Available options:
personal,
workspace,
restricted
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