DELETE

Cancel Task


Developer Preview

This API is subject to change. Bug fixes and new features will be released based on developer feedback throughout the preview period.

Cancels an existing task.

Authentication

You can only call this method when authenticated as a Wix app or Wix user identity.

Permissions
Manage All Data Resources
Manage Data Items
Write Data Items
Learn more about app permissions.
Endpoint
DELETE
https://www.wixapis.com/cms/v1/tasks/{taskId}

Path Params
taskIdstringRequired

Task ID.

Response Object
taskTask

Cancelled task.

Cancel a Task
Request
cURL
curl DELETE https://wixapis.com/autocms/v1/tasks/097a5564-0fec-4425-8d1e-3e753b48a422 \ -H 'Authorization: <AUTH>'
Response
JSON
{ "task": { "id": "097a5564-0fec-4425-8d1e-3e753b48a422", "type": "DELETE_BY_QUERY", "status": "FAILED", "startedAt": "2024-09-05T10:34:59.507Z", "finishedAt": "2024-09-05T10:35:03.654Z", "estimatedItemCount": 3, "itemsProcessed": 3, "itemsFailed": 0, "failures": [ { "code": "CANCELLED", "description": "Cancelled" } ], "deleteByQuery": { "collectionName": "Items", "filter": { "holidays": { "$in": ["Halloween"] } } } } }
Errors

This method doesn’t return any custom errors, but may return standard errors. Learn more about standard Wix errors.

Did this help?