Cancel a purge API task

Abstract

How to cancel data purge tasks with the xConnect data purge Web API.

You can use the xConnect data purge Web API to cancel a data 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/purge/tasks/{{TaskId}}/cancel

    Note

    The task cancellation is not an immediate process because the in-progress batch of contacts completes, and the task still purges the related data.