Cancel Jobs

Overview

Cancels one or more jobs

Category: Work Management

Use this action to cancel one or more jobs. Jobs that are Complete, already Canceled, or Locked cannot be canceled. Partial success is possible: cancellable jobs will be canceled and non-cancellable jobs will appear in errors. Set notifyResources to true to send a cancellation notification to allocated resources.

Request

Parameter Type Required Description Example
ids array of string Yes An array of Job UIDs to cancel
Min items: 1		 ["0014ccb7-73ad-40e1-9282-2c492a0f313a","00148d32-10ef-4264-adfe-0ff3ece68d92"]
reason string No Optional reason for cancellation. A value from the Jobs.AbortReason picklist. Customer requested
notifyResources boolean No Whether to send a cancellation notification to allocated resources
Default: false		 true

Response

This action’s output is available as $cancelJobs in JSONata expressions. See Response format for the standard result.data / result.errors structure and error handling patterns.

Field Type Description
result.data.uid1, result.data.uid2, … string UIDs of the affected records

Example output:

{
  "uid1": "0014ccb7-73ad-40e1-9282-2c492a0f313a",
  "uid2": "00148d32-10ef-4264-adfe-0ff3ece68d92"
}