Create Bulk Sync Schedule | Polytomic Docs

import { PolytomicClient } from "polytomic";
const client = new PolytomicClient({ token: "YOUR_TOKEN", version: "YOUR_VERSION" });
await client.bulkSync.schedules.create("248df4b7-aa70-47b8-a036-33ac447e668d", {
    schedule: {
        frequency: "manual"
    }
});

{
  "data": {
    "frequency": "manual",
    "createdAt": "2024-01-15T09:30:00Z",
    "createdBy": "248df4b7-aa70-47b8-a036-33ac447e668d",
    "dayOfMonth": "dayOfMonth",
    "dayOfWeek": "dayOfWeek",
    "deletedAt": "2024-01-15T09:30:00Z",
    "deletedBy": "248df4b7-aa70-47b8-a036-33ac447e668d",
    "hour": "hour",
    "minute": "minute",
    "month": "month",
    "schemas": [
      "schemas"
    ],
    "selectiveMode": "none",
    "syncId": "248df4b7-aa70-47b8-a036-33ac447e668d",
    "syncMode": "normal",
    "updatedAt": "2024-01-15T09:30:00Z",
    "updatedBy": "248df4b7-aa70-47b8-a036-33ac447e668d"
  }
}

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

sync_idstringRequired

Request

This endpoint expects an object.

scheduleobjectRequired

Response

dataobject

Errors

400

Schedules Create Request Bad Request Error

401

Schedules Create Request Unauthorized Error

403

Schedules Create Request Forbidden Error

404

Schedules Create Request Not Found Error

500

Schedules Create Request Internal Server Error

Authentication

Path parameters

Headers

Request

Response

Errors