Update a customer case
Only the fields you send change; `null` clears an optional field. A status change stamps `statusChangedAt`, and `resolvedAt` / `closedAt` when it reaches RESOLVED / CLOSED. `customFields` replaces the form's full set. Deleting a case stays in the Portal. Available to organisations with customer cases switched on: an organisation whose business type has no cases gets 404 `TENANT_MODULE_UNAVAILABLE`, one where cases are not switched on yet gets 403 `FEATURE_NOT_AVAILABLE`. Required scope: `cases.write`.
/cases/{caseId}Authorization
ApiKeyAuth An external API key, sent as Authorization: Bearer mflo_…. Scopes are checked per route; see each operation’s description.
In: header
Path Parameters
uuidRequest Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
application/json
application/json
application/json
application/json
application/json
curl -X PATCH "https://example.com/cases/497f6eca-6276-4993-bfeb-53cbbbba6f08" \ -H "Content-Type: application/json" \ -d '{}'{ "data": { "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "number": 0, "title": "string", "status": "NEW", "priority": "LOW", "categoryKey": "string", "statusChangedAt": "2019-08-24T14:15:22Z", "dueAt": "2019-08-24T14:15:22Z", "resolvedAt": "2019-08-24T14:15:22Z", "closedAt": "2019-08-24T14:15:22Z", "createdAt": "2019-08-24T14:15:22Z", "updatedAt": "2019-08-24T14:15:22Z", "assignedToUser": { "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "firstName": "string", "lastName": "string" }, "contact": { "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "firstName": "string", "lastName": "string" }, "company": { "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "name": "string" }, "topic": { "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "name": "string" }, "tags": [ { "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "name": "string", "color": "string" } ], "description": "string", "reporterName": "string", "reporterPhone": "string", "locationText": "string", "externalSystem": "string", "externalRef": "string", "externalUrl": "string", "source": "PORTAL", "sourceIdentifier": "string", "customFields": { "property1": "string", "property2": "string" }, "firstResponseAt": "2019-08-24T14:15:22Z", "createdByUser": { "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "firstName": "string", "lastName": "string" }, "links": [ { "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "resourceType": "TELEPHONY_CALL", "resourceId": "026d60bb-63a8-407e-bf67-01dcfc6022e6", "createdAt": "2019-08-24T14:15:22Z" } ], "tasks": [ { "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "title": "string", "status": "string", "priority": "string", "dueDate": "2019-08-24T14:15:22Z", "assignedToUser": { "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "firstName": "string", "lastName": "string" } } ] }}List customer cases GET
Newest number first, or most recently updated with `sort=updatedAt`. `status` and `category` take comma-separated lists; `open=true` keeps only open cases (NEW, IN_PROGRESS, WAITING_*); `assignedTo` takes a user id or `unassigned`; `search` matches title words or a case number (`1042`, `S-1042`); `resourceType` + `resourceId` (together) list the cases linked to one record, e.g. a call. Available to organisations with customer cases switched on: an organisation whose business type has no cases gets 404 `TENANT_MODULE_UNAVAILABLE`, one where cases are not switched on yet gets 403 `FEATURE_NOT_AVAILABLE`. Required scope: `cases.read`.
Add an internal note to a case POST
Credited to the person who created the API key; a system key writes a system note. Available to organisations with customer cases switched on: an organisation whose business type has no cases gets 404 `TENANT_MODULE_UNAVAILABLE`, one where cases are not switched on yet gets 403 `FEATURE_NOT_AVAILABLE`. Required scope: `cases.write`.