Skip to main content
POST
Link a conversation to 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

conversationId
string
required

Body

application/json
recordId
string
required
Minimum string length: 6
attendeeId
string

Participant to link. Required when the conversation has more than one external participant.

Minimum string length: 6

Response

Success

alreadyLinked
boolean
required

True when the participant was already linked to the record; nothing changed.