Sign in

v1

latestOpenAPI 3.0.32026-08-06138294578.6 KB
Bulk Sync Schedules

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.

post/api/bulk/syncs/{sync_id}/schedules

Path parameters

sync_idstring uuid required

Unique identifier of the bulk sync to add a schedule to.

Example:248df4b7-aa70-47b8-a036-33ac447e668d

Unique identifier of the bulk sync to add a schedule to.

Headers

X-Polytomic-Versionstring

Request body

Example request

{
  "schedule": {
    "dayOfMonth": "1",
    "dayOfWeek": "monday",
    "hour": "0",
    "minute": "0",
    "month": "1"
  }
}

Response

OK

Example response

{
  "data": {
    "createdBy": "248df4b7-aa70-47b8-a036-33ac447e668d",
    "deletedBy": "248df4b7-aa70-47b8-a036-33ac447e668d",
    "syncId": "248df4b7-aa70-47b8-a036-33ac447e668d",
    "updatedBy": "248df4b7-aa70-47b8-a036-33ac447e668d"
  }
}