Skip to main content
POST
/
records
/
{recordId}
/
custom-activities
Create a custom activity
curl --request POST \
  --url https://http.us.breakcold.com/api/v1/records/{recordId}/custom-activities \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "title": "<string>",
  "descriptionHtml": "<string>",
  "descriptionPlain": "<string>",
  "startAt": 123,
  "endAt": 123,
  "linkedRecordIds": [
    "<string>"
  ],
  "participantUserIds": [
    "<string>"
  ]
}
'
{
  "activity": {
    "id": "<string>",
    "workspaceId": "<string>",
    "title": "<string>",
    "startAt": 123,
    "linkedRecordIds": [
      "<string>"
    ],
    "participantUserIds": [
      "<string>"
    ],
    "createdAt": 123,
    "updatedAt": 123,
    "descriptionHtml": "<string>",
    "descriptionPlain": "<string>",
    "endAt": 123,
    "primaryRecordId": "<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.

Path Parameters

recordId
string
required

Body

application/json
title
string
required
descriptionHtml
string
descriptionPlain
string
startAt
number

Unix timestamp in ms.

endAt
number

Unix timestamp in ms.

linkedRecordIds
string[]
Minimum string length: 6
participantUserIds
string[]
Minimum string length: 6

Response

Success

activity
object
required