Skip to main content
POST
/
records
/
{recordId}
/
tasks
Create a record task
curl --request POST \
  --url https://http.us.breakcold.com/api/v1/records/{recordId}/tasks \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "title": "<string>",
  "descriptionHtml": "<string>",
  "descriptionPlain": "<string>",
  "dueAt": 123,
  "assigneeUserIds": [
    "<string>"
  ],
  "conversationId": "<string>"
}
'
{
  "task": {
    "id": "<string>",
    "workspaceId": "<string>",
    "title": "<string>",
    "createdAt": 123,
    "updatedAt": 123,
    "recordId": "<string>",
    "descriptionHtml": "<string>",
    "descriptionPlain": "<string>",
    "dueAt": 123,
    "assigneeUserIds": [
      "<string>"
    ],
    "linkedResources": [
      {
        "resourceType": "<string>",
        "resourceId": "<string>",
        "label": "<string>",
        "channel": "<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
dueAt
number

Unix timestamp in ms.

assigneeUserIds
string[]
Minimum string length: 6
conversationId
string
Minimum string length: 6

Response

Success

task
object
required