createDataSyncJob( )

Developer Preview

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

Creates a recurring data synchronization job with a cron schedule.

The data sync job automatically runs according to the specified cron expression. Each execution creates a new data movement job with its scheduleId set to this data sync job's ID.

Authentication
  • When developing websites or building an app with Blocks, this method may require elevated permissions, depending on the identity of the user calling it and the calling user's permissions.
  • When building apps without Blocks or for headless projects, you can only call this method directly when authenticated as a Wix app or Wix user identity. When authenticated as a different identity, you can call this method using elevation.
  • Elevation permits users to call methods they typically cannot access. Therefore, you should only use it intentionally and securely.
Permissions
Data Mover Manage Jobs
Learn more about app permissions.
Method Declaration
Copy
Method Parameters
syncJobDataSyncJobRequired

Data sync job to create.

optionsCreateDataSyncJobOptions
Returns
Return Type:Promise<DataSyncJob>
Errors

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

Did this help?