For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
Log inBook a demo
GuidesAPI Reference
GuidesAPI Reference
  • API Reference
      • GETList Bulk Syncs
      • POSTCreate Bulk Sync
      • GETGet Bulk Sync
      • PUTUpdate Bulk Sync
      • DELDelete Bulk Sync
      • POSTActivate Bulk Sync
      • POSTCancel Bulk Sync
      • POSTStart Bulk Sync Execution
      • GETGet Bulk Sync Status
      • GETGet Bulk Source
      • GETGet Bulk Destination
        • GETGet Bulk Sync Schedules
        • POSTCreate Bulk Sync Schedule
        • GETGet Bulk Sync Schedule
        • PUTUpdate Bulk Sync Schedule
        • DELDelete Bulk Sync Schedule
Logo
Log inBook a demo
API ReferenceBulk SyncSchedules

Update Bulk Sync Schedule

PUT
https://app.polytomic.com/api/bulk/syncs/:sync_id/schedules/:schedule_id
PUT
/api/bulk/syncs/:sync_id/schedules/:schedule_id
$curl -X PUT https://app.polytomic.com/api/bulk/syncs/248df4b7-aa70-47b8-a036-33ac447e668d/schedules/248df4b7-aa70-47b8-a036-33ac447e668d \
>     -H "Authorization: Bearer <token>" \
>     -H "Content-Type: application/json" \
>     -d '{
>  "schedule": {
>    "frequency": "manual"
>  }
>}'
1{
2  "data": {
3    "frequency": "manual",
4    "createdAt": "2024-01-15T09:30:00Z",
5    "createdBy": "248df4b7-aa70-47b8-a036-33ac447e668d",
6    "dayOfMonth": "15",
7    "dayOfWeek": "wednesday",
8    "deletedAt": "2024-02-01T10:00:00Z",
9    "deletedBy": "248df4b7-aa70-47b8-a036-33ac447e668d",
10    "hour": "14",
11    "isDefault": true,
12    "minute": "30",
13    "month": "6",
14    "schemas": [
15      "customer_data",
16      "sales_records"
17    ],
18    "selectiveMode": "none",
19    "syncId": "248df4b7-aa70-47b8-a036-33ac447e668d",
20    "syncMode": "normal",
21    "updatedAt": "2024-01-20T11:45:00Z",
22    "updatedBy": "248df4b7-aa70-47b8-a036-33ac447e668d"
23  }
24}
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.
Was this page helpful?
Previous

Delete Bulk Sync Schedule

Next

Authentication

AuthorizationBearer
Bearer user API key
OR
AuthorizationBasic

Basic organization-scoped API key

Path parameters

sync_idstringRequiredformat: "uuid"
Unique identifier of the bulk sync.
schedule_idstringRequiredformat: "uuid"
Unique identifier of the schedule to update.

Headers

X-Polytomic-VersionstringOptional

Request

This endpoint expects an object.
scheduleobjectRequired

Response

OK
dataobject

Errors

400
Bad Request Error
403
Forbidden Error
404
Not Found Error
500
Internal Server Error