Skip to main content
POST
Send a draft referral

Authorizations

X-API-Key
string
header
required

Public API key: cxp_<hex> (firm-scoped) or cxpp_<hex> (provider-scoped). Required on every request.

Path Parameters

id
string<uuid>
required

Resource UUID

Body

application/json
referentFirmId
string<uuid>
required

Receiving firm

notes
string

Optional note appended to the referral notes. Line breaks are collapsed to spaces.

Maximum string length: 10000
reason
string

Optional note recorded on the resulting status-history entry. Line breaks are collapsed to spaces.

Maximum string length: 5000

Response

Updated referral

data
object
required

A referral as seen by either party. Referral-level fields only (financials, resolution, workflow) — client and case details live on the parent case. When the caller is the receiving firm and the referral is still SENT (not yet acknowledged), leadAttorneyName, warmTransferUnsuccessfulReason, warmTransferUnsuccessfulReasonType and notes are null and customFields is empty.

meta
object
required