Create Sync

Requests a new Sync task from the Application specified in the request and returns a token that can be used to check the progress and status of the task.

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
Authorization
URL
Click Try It! to start a request and see the response here!