Create Bulk Sync Schedule

curl -X POST https://app.polytomic.com/api/bulk/syncs/248df4b7-aa70-47b8-a036-33ac447e668d/schedules \
     -H "Authorization: Bearer <token>" \
     -H "Content-Type: application/json" \
     -d '{
  "schedule": {
    "frequency": "daily"
  }
}'

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

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.

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`](../../../../../api-reference/bulk-sync/start).

Authentication

AuthorizationBearer

Bearer user API key

AuthorizationBasic

Basic organization-scoped API key

Path parameters

sync_idstringRequiredformat: "uuid"

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

Request

This endpoint expects an object.

scheduleobjectRequired

Response

dataobject

Errors

400

Bad Request Error

403

Forbidden Error

404

Not Found Error

500

Internal Server Error

Authentication

Path parameters

Headers

Request

Response

Errors

Authentication

Path parameters

Headers

Request

Response

Errors