Update Case

Partially updates a case, including its name, stage, case fields, assignee, and Human-in-the-Loop (HIL) approvals.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

Performs a partial update on the specified case. You can update any combination of the following in a single request:

  • Stage — Move the case to a different stage, with an optional workflow trigger.
  • Case fields — Update one or more case field values.
  • Assignee — Change the user assigned to the case.
  • Case name — Rename the case.
  • HIL approvals — Approve or reject Human-in-the-Loop (HIL) review items.

At least one of stage_id, case_fields, assigned_to, approval, or case_name must be provided in the request body. Each update is applied independently — if one operation fails, the remaining operations still proceed.

Additionally, you can set trigger_workflow to true to execute the workflow associated with the case type after all updates have been applied. This is useful when you want to re-process the case through the workflow with the newly updated values. By default, the workflow is not triggered (false).

On success, the response includes the updated case metadata and, where applicable, the updated case field values. If any individual update fails, the response includes error details for the failed operations.


Path Params
string
required

The unique identifier of the case type this case belongs to. You can obtain this value from the List Agents endpoint.

string
required

The unique identifier of the case to update. You can obtain this value from the List Cases endpoint.

Body Params
string

The ID of the stage to move the case to. You can obtain stage IDs from the Get Case Type Details endpoint

string

The user ID of the new assignee for this case.

approval
object

An object specifying the HIL approval action (approve or reject) for a pending review item.

boolean
Defaults to false

When set to true, the workflow associated to the casetype is executed after all update operations have completed. Defaults to false.

string

The new name for the case. Replaces the existing case name.

Headers
string
required

API key used for authentication. You can find your API key in your account settings.

Responses

Language
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json