Skip to main content
POST
/
cases
Create Case
curl --request POST \
  --url https://api.casexchange.com/api/v1/cases \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "title": "<string>",
  "caseType": "<string>",
  "jurisdiction": "<string>",
  "clientFirstName": "<string>",
  "clientLastName": "<string>",
  "description": "<string>",
  "clientEmail": "[email protected]",
  "clientPhone": "<string>",
  "clientDateOfBirth": "2023-12-25",
  "incidentDate": "2023-12-25",
  "referentFirmId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "notes": "<string>",
  "salesforceRecordId": "<string>",
  "salesforceObjectType": "<string>"
}
'
{
  "success": true,
  "data": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "title": "<string>",
    "description": "<string>",
    "referenceNumber": "<string>",
    "status": "draft",
    "caseType": "<string>",
    "jurisdiction": "<string>",
    "clientFirstName": "<string>",
    "clientLastName": "<string>",
    "clientEmail": "[email protected]",
    "clientPhone": "<string>",
    "referringFirmId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "referringFirm": {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "name": "<string>",
      "caseStatusSubscriber": true
    },
    "referentFirmId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "referentFirm": {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "name": "<string>",
      "caseStatusSubscriber": true
    },
    "notes": "<string>",
    "externalId": "<string>",
    "salesforceRecordId": "<string>",
    "salesforceObjectType": "<string>",
    "settlementAmount": 123,
    "attorneyFees": 123,
    "closureReason": "<string>",
    "source": "<string>",
    "createdById": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "createdBy": {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "firstName": "<string>",
      "lastName": "<string>"
    },
    "lastUpdatedById": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "lastUpdatedBy": {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "firstName": "<string>",
      "lastName": "<string>"
    },
    "statusUpdates": [
      {}
    ],
    "documents": [
      {}
    ],
    "createdAt": "2023-11-07T05:31:56Z",
    "updatedAt": "2023-11-07T05:31:56Z"
  }
}
Create a new case referral. If referentFirmId is provided, the case is immediately sent to the receiving firm. Otherwise, it’s created as a draft for later completion.

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
​
title
string
required
Minimum string length: 1
​
caseType
string
required
Minimum string length: 1
​
jurisdiction
string
required
Minimum string length: 1
​
clientFirstName
string
required
Minimum string length: 1
​
clientLastName
string
required
Minimum string length: 1
​
description
string | null
​
clientEmail
string<email> | null
​
clientPhone
string | null
​
clientDateOfBirth
string<date> | null

Date in YYYY-MM-DD format

​
incidentDate
string<date> | null

Date in YYYY-MM-DD format

​
referentFirmId
string<uuid> | null

If provided, the case will be immediately sent to this firm. Otherwise, it's created as a draft.

​
notes
string | null
​
salesforceRecordId
string | null
Maximum string length: 18
​
salesforceObjectType
string | null
Maximum string length: 100

Response

Case created

​
success
boolean
​
data
object