Update a case

patch

https://example.com/v1/cases/{id}

About this API

To get the ins and outs of this API, please refer to our documentation page here

Service limitations

To ensure platform stability and fair use, rate limits are applied. If the allowed limit is exceeded, the API will respond with an ‘HTTP 429 (Too Many Requests)’ status code.

How to use this page?

Pick a preferred language on the right.
Enter your API key in the header field. Don't have one yet or don't know what that is? Please refer to the following page here.
Enter the required parameters below or try something yourself!
Click the Try It! button!

📘
You can also click one of the HTTP response codes at the bottom to see an example of that specific response!

Path Params

uuid

required

Case id (uuid). A non-uuid value yields 400 invalid_id with source.parameter id.

Body Params

Flat attribute object (not a JSON:API document). Absent (or JSON null) fields are left unchanged. Naming any other recognised case attribute (name, entityName, entityType, entityData, tenantId, createdBy, lifecycleState, workflowState, policyTemplateId, policyTemplateVersion, caseWorkflowId, parentCaseId, createdAt, updatedAt, completedAt) is rejected with 400 immutable_field. The guard list includes attributes never returned in case responses (name, tenantId, createdBy, parentCaseId). An immutable attribute set to JSON null is treated as absent — immutable_field fires only for non-null values. Attributes outside both the mutable and guard lists are silently ignored; in particular internalRef (the POST create spelling) is not recognised here — the PATCH spelling is internalReference.

internalReference

string | null

notes

string | null

Merged into the case's enriched data under the reserved notes key; surfaced via entityData.

Responses

Language

Credentials

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/vnd.api+json

200Updated (or unchanged, for a no-op body) case

401Missing CI-Subject-URN or CI-Request-Id, absent CI-Role header, or a subject URN not provisioned as a KYC user (title unauthenticated, source.header names the offending header).

403The caller's roles do not satisfy this operation's role gate (title forbidden), or the caller is a tenant user whose tenant is not provisioned in KYC.NEXT (title tenant_not_provisioned, on any operation).

404The resource does not exist — or belongs to another tenant, which is indistinguishable (title not_found).

409The case is archived or purged and refuses updates (title conflict). This guard runs before the no-op check, so even a body naming no mutable field yields 409 against such a case.

500Unexpected server error (title internal_error).