Skip to main content

Case Operations

Update the status of a case. These operations modify case metadata.

Operations that modify a case: update the case status (lifecycle management).

PATCH/v1/cases/:key/status

Response

Response fields

case_keystringCase key (hex hash).
statusstringThe new case status.
resolved_atstring | nullISO 8601 timestamp set when status is resolved.
resolution_notesstring | nullResolution notes, if provided.

Response

{
  "case_key": "a1b2c3d4e5f6a7b8",
  "status": "resolved",
  "resolved_at": "2024-10-20T15:00:00.000Z",
  "resolution_notes": "All invoices reconciled."
}

Errors

Error responses

400bad_requestInvalid case key format.
401unauthorizedMissing or invalid API key.
404not_foundCase not found.
429rate_limitedToo many requests. Retry after the period indicated in the Retry-After header.

Related

Get Case
Case Merge & Split