Skip to main content
PATCH
/
records
/
{recordId}
Update a record
curl --request PATCH \
  --url https://http.us.breakcold.com/api/v1/records/{recordId} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "fields": {}
}'
{
  "record": {
    "id": "<string>",
    "workspaceId": "<string>",
    "objectTypeId": "<string>",
    "isArchived": true,
    "createdAt": 123,
    "updatedAt": 123,
    "objectTypeSlug": "<string>",
    "displayName": "<string>",
    "fields": {},
    "archivedAt": 123
  }
}

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
​
fields
object
required

Map of field slug to value. Values follow the field type: strings for text/social fields, numbers for numeric/date fields, booleans for checkbox, { amount, currencyCode } for currency, { optionId } for select, arrays for multi-value fields.

Response

Success

​
record
object
required