Sign in

v1

latestOpenAPI 3.0.32026-08-06138294578.6 KB
Bulk Sync Schedules

Update Bulk Sync Schedule

Updates an existing schedule on a bulk sync.

Updates replace the stored schedule. Send the full schedule definition rather than only the field you want to change. Schedule times are interpreted in UTC.

put/api/bulk/syncs/{sync_id}/schedules/{schedule_id}

Path parameters

sync_idstring uuid required

Unique identifier of the bulk sync.

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

Unique identifier of the bulk sync.

schedule_idstring uuid required

Unique identifier of the schedule to update.

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

Unique identifier of the schedule to update.

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"
  }
}