Cancel Sync

Cancels a Sync process for an Application if the request is still being processed within the Application. This does not cancel Sync processes which have already proceeded to completion within the Application, or Sync processes outside of Applications such as from a Zip file or Batch Import.

A Sync task represents an action performed by an Application for a particular account. An Application can provide many different tasks as part of their capabilities. Sync tasks are executed in the background and will continue running after they are created. Use one of the creation APIs to request execution of a task. To check on the progress of the task, call GetSync or QuerySync.

Roles

To call this endpoint, you must have one of these roles:

  • Group Owner
  • Group Admin
  • Member

You can view your roles with the Status API.

Data Definition

See SyncRequestModel for the complete data definition.

Language
Authentication
URL
Click Try It! to start a request and see the response here!