Skip to main content
PATCH
Update a record

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.

Idempotency-Key
string

Stable unique key for the intended write. Reuse the same key when retrying the same request; use a different key for an intentional duplicate.

Required string length: 1 - 200

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. Multiselect fields accept an array of raw option ids or { optionId } objects.

multiselectMode
enum<string>
default:append

How multiselect field values are written. "append" (default) adds the provided options to existing ones. "replace" sets the field to exactly the provided options (omitted options removed; [] clears the field).

Available options:
append,
replace

Response

Success

record
object
required