Skip to main content
POST
Send a partner message

Authorizations

X-API-Key
string
header
required

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

Body

application/json
id
string
required

Flexible identifier. Accepts a referral UUID, a base-case UUID, a CaseXchange reference number (e.g. PREFIX-0001, exact match), or one of the calling firm's own integration ids: a case-management id it holds on a referral it received (DearLegal case id, Neos intake id, Clio matter id, SmartAdvocate case id, Salesforce intake record id, Case Status user-entered id, or numeric Case Status internal id), or the Salesforce record id of a case it sent. An integration id belongs to the firm whose system it points to: another firm's ids never resolve, not even on a case both firms share. Resolution order is UUID, then reference number, then integration ids; the calling firm must be a party to the match (sender or receiver) or the request returns 404. A case-management or Case Status id that matches more than one of the calling firm's cases returns 409 ambiguous_external_id; one that matches several referrals of a single case (the firm received the case again) resolves to the live referral. The Salesforce record id of cases the firm sent resolves to the one still being referred (latest referral not rejected, withdrawn or closed), or to the newest when none is, and returns 409 only when more than one is still being referred.

Minimum string length: 1
message
string
required
Required string length: 1 - 5000
requestedStatus
enum<string>

Optional status the sender is asking the other firm to move to (case-insensitive)

Available options:
draft,
sent,
received,
under_evaluation,
investigating,
signed,
in_litigation,
closing,
won,
lost,
closed,
rejected,
withdrawn,
terminated,
exhausted,
pending_spin_off

Response

Created message entry

data
object
required

A status update or partner message on a referral, with referral context.

meta
object
required