API version: unstable
API version: 2021-01 Release candidate
API version: 2020-10 Latest
API version: 2020-07
API version: 2020-04
API version: 2020-01
API version: 2019-10 Unsupported
API version: 2019-07 Unsupported

bulkOperationCancel mutation

Version unstable

Starts the cancelation process of a running bulk operation.

There may be a short delay from when a cancelation starts until the operation is actually canceled.

Interactive example

This is an example mutation query. Use the embedded interactive tool below to edit the query.

Hint: use Ctrl + Space for autocompleting fields.


Arguments

id ( ID! ) required

ID of the bulk operation to cancel.

Return fields

bulkOperation (BulkOperation)

The bulk operation to be canceled.

userErrors ([UserError!]!)

List of errors that occurred executing the mutation.

Version 2021-01 (Release candidate)

Starts the cancelation process of a running bulk operation.

There may be a short delay from when a cancelation starts until the operation is actually canceled.

Interactive example

This is an example mutation query. Use the embedded interactive tool below to edit the query.

Hint: use Ctrl + Space for autocompleting fields.


Arguments

id ( ID! ) required

ID of the bulk operation to cancel.

Return fields

bulkOperation (BulkOperation)

The bulk operation to be canceled.

userErrors ([UserError!]!)

List of errors that occurred executing the mutation.

Version 2020-10 (Latest)

Starts the cancelation process of a running bulk operation.

There may be a short delay from when a cancelation starts until the operation is actually canceled.

Interactive example

This is an example mutation query. Use the embedded interactive tool below to edit the query.

Hint: use Ctrl + Space for autocompleting fields.


Arguments

id ( ID! ) required

ID of the bulk operation to cancel.

Return fields

bulkOperation (BulkOperation)

The bulk operation to be canceled.

userErrors ([UserError!]!)

List of errors that occurred executing the mutation.

Version 2020-07

Starts the cancelation process of a running bulk operation.

There may be a short delay from when a cancelation starts until the operation is actually canceled.

Interactive example

This is an example mutation query. Use the embedded interactive tool below to edit the query.

Hint: use Ctrl + Space for autocompleting fields.


Arguments

id ( ID! ) required

ID of the bulk operation to cancel.

Return fields

bulkOperation (BulkOperation)

The bulk operation to be canceled.

userErrors ([UserError!]!)

List of errors that occurred executing the mutation.

Version 2020-04

Starts the cancelation process of a running bulk operation.

There may be a short delay from when a cancelation starts until the operation is actually canceled.

Interactive example

This is an example mutation query. Use the embedded interactive tool below to edit the query.

Hint: use Ctrl + Space for autocompleting fields.


Arguments

id ( ID! ) required

ID of the bulk operation to cancel.

Return fields

bulkOperation (BulkOperation)

The bulk operation to be canceled.

userErrors ([UserError!]!)

List of errors that occurred executing the mutation.

Version 2020-01

Starts the cancelation process of a running bulk operation.

There may be a short delay from when a cancelation starts until the operation is actually canceled.

Interactive example

This is an example mutation query. Use the embedded interactive tool below to edit the query.

Hint: use Ctrl + Space for autocompleting fields.


Arguments

id ( ID! ) required

ID of the bulk operation to cancel.

Return fields

bulkOperation (BulkOperation)

The bulk operation to be canceled.

userErrors ([UserError!]!)

List of errors that occurred executing the mutation.

Version 2019-10 (Unsupported)

Starts the cancelation process of a running bulk operation.

There may be a short delay from when a cancelation starts until the operation is actually canceled.

Interactive example

This is an example mutation query. Use the embedded interactive tool below to edit the query.

Hint: use Ctrl + Space for autocompleting fields.


Arguments

id ( ID! ) required

ID of the bulk operation to cancel.

Return fields

bulkOperation (BulkOperation)

The bulk operation to be canceled.

userErrors ([UserError!]!)

List of errors that occurred executing the mutation.

Version 2019-07 (Unsupported)

Starts the cancelation process of a running bulk operation.

There may be a short delay from when a cancelation starts until the operation is actually canceled.

Interactive example

This is an example mutation query. Use the embedded interactive tool below to edit the query.

Hint: use Ctrl + Space for autocompleting fields.


Arguments

id ( ID! ) required

ID of the bulk operation to cancel.

Return fields

bulkOperation (BulkOperation)

The bulk operation to be canceled.

userErrors ([UserError!]!)

List of errors that occurred executing the mutation.

Version 2019-04 (Unsupported)

Starts the cancelation process of a running bulk operation.

There may be a short delay from when a cancelation starts until the operation is actually canceled.

Interactive example

This is an example mutation query. Use the embedded interactive tool below to edit the query.

Hint: use Ctrl + Space for autocompleting fields.


Arguments

id ( ID! ) required

ID of the bulk operation to cancel.

Return fields

bulkOperation (BulkOperation)

The bulk operation to be canceled.

userErrors ([UserError!]!)

List of errors that occurred executing the mutation.