POpolytomic
Bulk Sync Schedules

Create Bulk Sync Schedule

Changed on

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

Request

  • Base URL
    https://app.polytomic.com
  • Auth
    • HTTP bearer
    • or HTTP basic

Path parameters

sync_idstring uuid required

Unique identifier of the bulk sync to add a schedule to

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

Headers

X-Polytomic-Versionstring

Request body

Example request

{
  "schedule": {
    "dayOfMonth": "1",
    "dayOfWeek": "1",
    "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"
  }
}

Changes

  • 61c2b96f65baRevision changes
    • breaking

      added to the request property allOf list

    • breaking

      the request property type changed from object to no type

    • breaking

      the response's property type changed from object to no type for status

    • breaking

      removed the required property / from the response with the status

    • warning

      removed the request property /

    • warning

      removed the request property /

    • warning

      removed the request property /

    • warning

      removed the request property /

    • warning

      removed the request property /

    • warning

      removed the request property /

    • warning

      removed the request property /

    • warning

      removed the optional property / from the response with the status

    • warning

      removed the optional property / from the response with the status

    • warning

      removed the optional property / from the response with the status

    • warning

      removed the optional property / from the response with the status

    • warning

      removed the optional property / from the response with the status

    • warning

      removed the optional property / from the response with the status

    • warning

      removed the optional property / from the response with the status

    • warning

      removed the optional property / from the response with the status

    • warning

      removed the optional property / from the response with the status

    • warning

      removed the optional property / from the response with the status

    • warning

      removed the optional property / from the response with the status

    • warning

      removed the optional property / from the response with the status

    • warning

      removed the optional property / from the response with the status

    • warning

      removed the optional property / from the response with the status

    • warning

      removed the optional property / from the response with the status

    • warning

      removed the optional property / from the response with the status

    • info

      added to the response property allOf list for the response status