cases

Update a case

Updates an existing CRM case (deal). Case status cannot be updated through this endpoint. Tags and caseSource must be provided as plain text names and must match existing values in the system.

patch/cases/{id}

Request

  • Base URL: https://api.ritten.io/v1
  • URL: https://api.ritten.io/v1/cases/{id}
  • Auth: none declared

Path parameters

idstring uuid required

The ID of the case to update

Request body

caseNamestring

Name of the case

personSeekingTreatmentIdstring uuid

ID of the person seeking treatment

caseOwnerIdstring uuid

ID of the staff member who owns this case

contactIdsstring[]

IDs of contacts associated with this case (replaces existing)

caseSourcestring

Name of the case source (must match an existing case source)

caseSizeCentsinteger

Case value in cents

potentialAdmitDatestring date-time

Potential admission date (ISO 8601)

followUpDatestring date-time

Follow-up date (ISO 8601)

potentialProgramIdsstring[]

IDs of potential programs for this case (replaces existing)

tagsstring[]

Tag names to apply to the case (replaces existing tags, must match existing tags)

createdAtstring date-time

Creation date (must be in the past)

Example request

{
  "caseName": "John Doe",
  "caseSource": "Website",
  "caseSizeCents": 10000,
  "potentialAdmitDate": "2024-01-01T00:00:00Z",
  "followUpDate": "2024-01-15T00:00:00Z",
  "tags": [
    "urgent",
    "self-referral"
  ],
  "createdAt": "2024-01-01T00:00:00Z"
}

Response

Successfully updated case

idstring uuid
caseNamestring
statusstring
caseSourcestring
caseSizeCentsinteger

Case value in cents

potentialAdmitDatestring date-time
followUpDatestring date-time
createdAtstring date-time
tagsstring[]

Example response

{
  "id": "182c2e54-3494-4b85-aba5-038cf539d5bf",
  "caseName": "John Doe",
  "status": "New",
  "caseSizeCents": 10000,
  "potentialAdmitDate": "2024-01-01T00:00:00Z",
  "followUpDate": "2024-01-15T00:00:00Z",
  "createdAt": "2024-01-01T00:00:00Z",
  "personSeekingTreatment": {
    "id": "182c2e54-3494-4b85-aba5-038cf539d5bf",
    "first": "John",
    "last": "Doe",
    "createdAt": "2024-01-01T00:00:00Z"
  },
  "caseOwner": {
    "id": "182c2e54-3494-4b85-aba5-038cf539d5bf",
    "email": "johndoe@ritclinic.ritten.io",
    "first": "Doe",
    "last": "John",
    "lastAccessedAt": "2024-01-15T14:32:00Z"
  },
  "contacts": [
    {
      "id": "182c2e54-3494-4b85-aba5-038cf539d5bf",
      "first": "John",
      "last": "Doe",
      "createdAt": "2024-01-01T00:00:00Z"
    }
  ],
  "potentialPrograms": [
    {
      "id": "182c2e54-3494-4b85-aba5-038cf539d5bf",
      "programName": "Residential",
      "programType": "clinical"
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.