Create Bulk Sync Schedule
Adds a new schedule to a bulk sync.
A bulk sync can have multiple schedules attached; adding one here does not replace existing schedules. Schedule times are interpreted in UTC.
Creating a schedule only affects future automatic executions. To run the
sync immediately, call
POST /api/bulk/syncs/{id}/executions.
To sync the two selective groups of objects at different frequencies, add one
schedule with selectiveMode set to incrementalFields and another with
nonincrementalFields. Set the default schedule to manual to avoid an
additional automatic run covering all selected objects. Check
capabilities.supports_selective_modes on
GET /api/connections/{id}/bulksync/source
first.
Authentication
AuthorizationBearer
Bearer user API key
OR
AuthorizationBasic
Basic organization-scoped API key
Path parameters
sync_id
Unique identifier of the bulk sync to add a schedule to
Headers
X-Polytomic-Version
Request
This endpoint expects an object.
schedule
Bulk sync schedule. Schedule times are interpreted in UTC.
Response
OK
data
The bulk sync schedule
Errors
400
Bad Request Error
403
Forbidden Error
404
Not Found Error
500
Internal Server Error
