Perform an action within case context

Perform an action on an existing case.

This endpoint allows you to:

  • Add comments to a case
  • Attach supporting documents with comment action
  • Submit an override request for a case
  • Accept, refuse, or cancel an override request
  • Close a case

Each action will create a permanent record in the case's action log and may change the case's status.

Required permissions:

  • cases_write

Action Type Permissions:

  • comment: Available to contributors and reviewers
  • accept: Available to reviewers only (not the override creator)
  • refuse: Available to reviewers only (not the override creator)
  • cancel: Available only to the override creator

Important constraints:

  • The cases feature must be enabled for your account
  • Actions can only be performed on cases in appropriate states
  • Users must have proper roles to perform specific actions
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
uuid
required

Unique identifier of the case on which to perform the action. Must be a valid UUID format.

Query Params
string
enum

Comma-separated list of related resources to include in the response.

Supported values:

  • user - The user who performed the action
  • comment - The comment which was created
  • comment.documents - Supporting documents attached to the comment
  • override - The override which was created
  • override.assigned_reviewers - Supporting reviewers attached to the override

Including related resources reduces the need for additional API calls.

Allowed:
Body Params

The case action request payload

data
object
required

Container for case action data following JSON:API specification

Headers
string
enum

Specifies the preferred language for the response. Supported languages:

  • en - English
  • fr - French

If not provided, the default language will be used.

Allowed:
Responses

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