Skip to main content
POST
/
records
/
{recordId}
/
notes
Create a record note
curl --request POST \
  --url https://http.us.breakcold.com/api/v1/records/{recordId}/notes \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "title": "<string>",
  "content": "<string>",
  "contentPlain": "<string>"
}
'
{
  "note": {
    "id": "<string>",
    "workspaceId": "<string>",
    "title": "<string>",
    "content": "<string>",
    "createdAt": 123,
    "updatedAt": 123,
    "recordId": "<string>",
    "contentPlain": "<string>",
    "author": {
      "name": "<string>",
      "id": "<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

recordId
string
required

Body

application/json
title
string
required
content
string
required
contentPlain
string

Response

Success

note
object
required