1. Web API for xConnect Data Tools

Cancel an API task

Version:

You can use the xConnect Web API to cancel a purge task.

To cancel the task:

  • Use the following PUT request and substitute the {{TaskId}} parameter with the ID of the ongoing registered task:

    <instance>/sitecore/api/datatools/tasks/{{TaskId}}/cancel
    Note

    The task cancellation is not an immediate process because the task completes the in-progress batch of contacts before the cancellation takes effect, and the task still processes the related data. If you, for example, cancel a purge task, any items that were deleted before you cancelled the task remain deleted.

If you have suggestions for improving this article, let us know!