> ## Documentation Index
> Fetch the complete documentation index at: https://docs.revoengine.com/llms.txt
> Use this file to discover all available pages before exploring further.

# api.cancelJobs()

> Public low-code contract, signatures and examples for api.cancelJobs.

## `api.cancelJobs()`

Cancel by jobIds OR a non-empty platform filter. Unavailable with `readOnly: true` (throws an error).
Returns a durable operation over frozen IDs; counters describe requests processed, not downstream completion.

### Signature

```ts theme={null}
static cancelJobs(input: JobsBulkInput): Promise<AutomationOperation>;
```

### Example

```ts theme={null}
const operation = await api.cancelJobs({ filter: { field: 'status', op: 'eq', value: 'SCHEDULED' } });
```

See [all api methods](https://docs.revoengine.com/low-code/reference/api.md) or [runtime basics](https://docs.revoengine.com/low-code/overview.md).


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.