---
title: "Cancel a running aggregate query job"
method: DELETE
path: "/v1/batch-query/jobs/{jobid}"
tags: ["Aggregate Queries"]
---

# Cancel a running aggregate query job

`DELETE /v1/batch-query/jobs/{jobid}`

Cancels the current AQuA job, only if the job is not complete. If the job is complete, an error is thrown.

## Path parameters

- `jobid` string, required

## Headers

- `Accept-Encoding` string
- `Content-Encoding` string
- `Zuora-Entity-Ids` string
- `Zuora-Org-Ids` string
- `Zuora-Track-Id` string
- `Zuora-Version` string

## Response `200`

OK

- DeleteBatchQueryJobResponse
  - `batches` BatchQueries[] — A JSON array object that contains a list of batch objects.
    - `batchId` string — A 32-character ID of the query batch.
    - `batchType` 'zoql' | 'zoqlexport' — The kind of batch job being submitted.
    - `fileId` string — The ID of the query results file. Use Get Results Files to download the query results file. The query results file is formatted as requested in the batch job. Supported formats are CSV, GZIP, and ZIP.
    - `message` string — The error message.
    - `name` string — Name of the query supplied in the request.
    - `query` string — The requested query string.
    - `recordCount` string — The number of records included in the query output file.
    - `segments` unknown[] — Array of IDs of query results files. Replaces fileId for full data loads in stateful mode if <a href = "https://docs.zuora.com/en/zuora-platform/data/aggregate-query-api-aqua/file-segmentation" target="_blank">File Segmentation</a> is enabled. Use Get Results Files to download each query results file. Each query results file contains at most 500,000 records and is formatted as requested in the batch job. Supported formats are CSV, GZIP, and ZIP.
      - unknown
    - `status` 'submitted' | 'pending' | 'executing' | 'completed' | 'aborted' | 'deleted_notallowed' — The status of the query task: - submitted: The query was submitted to the query executor for processing. - pending: The query was waiting for being processed. - executing: The query is being processed. - completed: The query was successfully executed. - aborted: The query execution failed. - deleted_notallowed: The query execution failed because objects included in the query do not support the querying of deleted records.
  - `format` 'csv' | 'zip' | 'gzip' — The format of the query. The default value is `csv`.
  - `id` string — The job ID created for the AQuA API request. The job ID can be used for querying for the query status. The ID exists only if the JSON request can be parsed and validated successfully. Otherwise, the job ID is null.
  - `name` string — The name of the job. 32 character limit.
  - `sourceData` string — Indicates the source this aggregate query runs against: * `LIVE` represents the live transactional databases at Zuora (Data Query Live). * `WAREHOUSE` represents Zuora Warehouse, which has better performance and fewer limitations than the live transactional database. For more information, see <a href="https://docs.zuora.com?resourceId=platform-zuora-warehouse-overview" target="_blank">Zuora Warehouse</a>.
  - `status` 'submitted' | 'executing' | 'completed' | 'error' | 'aborted' | 'cancelled' — The status of the AQuA job: - submitted: The AQuA job was submitted to the query executor for processing. - executing: The AQuA job is being processed. - completed: The AQuA job was successfully executed. - error: The AQuA job was not processed because of validation errors. - aborted: The AQuA job execution failed because one or more queries of this job failed. - cancelled: The AQuA job was cancelled.
  - `version` number, float — The API version you want to use. The supported versions are as follows: - `1.1`. It supports both modes - `1.0`. Default. It supports stateless modes only. See <a href="https://docs.zuora.com?resourceId=platform-aqua-stateless-and-stateful-modes" target="_blank">Stateless and stateful modes</a> for more information.

---

[API](https://skmtc.dev/zuora/apis/api-reference.md) · [All operations](https://skmtc.dev/zuora/apis/api-reference/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/zuora/api-reference/revisions/d11e237f3e54/schema)