Skip to main content
POST
Create 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

Body

application/json
workspaceId
string
required
Minimum string length: 6
fields
object
required

Non-empty map of field slug to initial value. Every field configured as required for the target object must be supplied unless it has a configured default. When creating a deal from a person, include the deal's contact relation field with that person's record id.

objectTypeId
string
Minimum string length: 6
objectTypeSlug
string

Response

Success

record
object
required