Skip to main content
POST
/
messages
/
send
Error
A valid request URL is required to generate request examples
{
  "data": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "referralId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "referenceNumber": "CX-A1BC001-X2Y",
    "status": "draft",
    "message": "<string>",
    "isMessage": true,
    "source": "manual",
    "createdAt": "2023-11-07T05:31:56Z",
    "createdByName": "<string>"
  },
  "meta": {
    "requestId": "req_f2dbe1d3f6ad4a7bb5b4c9f2",
    "timestamp": "2023-11-07T05:31:56Z"
  }
}

Authorizations

​
X-API-Key
string
header
required

Public API key (starts with cxp_). Required on every request.

Body

application/json
​
id
string
required

UUID, reference number, or CMS ID identifying the target referral or base case

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

Optional status to request from the partner firm

Available options:
draft,
sent,
under_evaluation,
investigating,
signed,
in_litigation,
closing,
rejected,
withdrawn,
closed

Response

Message sent successfully

​
data
object
​
meta
object