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
Logo
Log inBook a demo
API ReferenceBulk Sync

Update Bulk Sync

PUT
https://app.polytomic.com/api/bulk/syncs/:id
PUT
/api/bulk/syncs/:id
$curl -X PUT https://app.polytomic.com/api/bulk/syncs/248df4b7-aa70-47b8-a036-33ac447e668d \
>     -H "X-Polytomic-Version: X-Polytomic-Version" \
>     -H "Content-Type: application/json" \
>     -u "<username>:<password>" \
>     -d '{
>  "destination_configuration": {
>    "schema": "my_schema"
>  },
>  "destination_connection_id": "248df4b7-aa70-47b8-a036-33ac447e668d",
>  "mode": "snapshot",
>  "name": "My Bulk Sync",
>  "schedule": {
>    "frequency": "manual"
>  },
>  "source_connection_id": "248df4b7-aa70-47b8-a036-33ac447e668d"
>}'
1{
2  "data": {
3    "active": true,
4    "automatically_add_new_fields": "all",
5    "automatically_add_new_objects": "all",
6    "concurrency_limit": 50,
7    "created_at": "2024-01-15T09:30:00Z",
8    "created_by": {
9      "id": "12345678-1234-1234-1234-123456789012",
10      "name": "John Doe",
11      "type": "user"
12    },
13    "data_cutoff_timestamp": "2023-04-25T12:00:00Z",
14    "destination_configuration": {
15      "schema": "my_schema"
16    },
17    "destination_connection_id": "248df4b7-aa70-47b8-a036-33ac447e668d",
18    "disable_record_timestamps": false,
19    "id": "248df4b7-aa70-47b8-a036-33ac447e668d",
20    "mode": "snapshot",
21    "name": "My Bulk Sync",
22    "normalize_names": "enabled",
23    "organization_id": "248df4b7-aa70-47b8-a036-33ac447e668d",
24    "policies": [
25      "248df4b7-aa70-47b8-a036-33ac447e668d"
26    ],
27    "resync_concurrency_limit": 10,
28    "schedule": {
29      "frequency": "manual",
30      "day_of_month": "1",
31      "day_of_week": "monday",
32      "hour": "0",
33      "minute": "0",
34      "month": "1",
35      "multi": {
36        "schedules": [
37          {
38            "item": "none"
39          }
40        ],
41        "type": "string"
42      }
43    },
44    "source_configuration": {
45      "replication_slot": "slot"
46    },
47    "source_connection_id": "248df4b7-aa70-47b8-a036-33ac447e668d",
48    "updated_at": "2024-01-15T09:30:00Z",
49    "updated_by": {
50      "id": "12345678-1234-1234-1234-123456789012",
51      "name": "John Doe",
52      "type": "user"
53    },
54    "discover": true
55  }
56}
Updates an existing bulk sync's top-level configuration. Updating a bulk sync is a **full replacement** of the sync's top-level configuration. Every field in the request body is written to the sync; any field you omit is cleared or reset to its default value. To make a partial change — for example, toggling `active` or swapping a schedule — fetch the current sync with [`GET /api/bulk/syncs/{id}`](../../../../api-reference/bulk-sync/get), modify the fields you want to change, and send the complete object back in the update request. Updates to `active`, `schedules`, and `policies` take effect immediately. Changes to source or destination configuration take effect on the sync's next execution. Because omitted fields are reset to their defaults, the discovery and naming options behave the same as on create when left out: - `automatically_add_new_objects` resets to not enabling newly discovered source objects automatically. - `automatically_add_new_fields` resets to enabling newly discovered fields on already selected objects. - `normalize_names` resets to enabled. Send the existing values explicitly if you want to preserve a non-default or non-empty setting, including schema and field selections. > 📘 Updating schemas > > Schema updates are not performed through this endpoint. Use the > [Update Bulk Sync Schemas](../../../../api-reference/bulk-sync/schemas/patch) > endpoint to change a subset of schemas, or > [Update Bulk Sync Schema](../../../../api-reference/bulk-sync/schemas/update) > to replace a single schema's configuration.
Was this page helpful?
Previous

Delete Bulk Sync

Next

Updates an existing bulk sync’s top-level configuration.

Updating a bulk sync is a full replacement of the sync’s top-level configuration. Every field in the request body is written to the sync; any field you omit is cleared or reset to its default value.

To make a partial change — for example, toggling active or swapping a schedule — fetch the current sync with GET /api/bulk/syncs/{id}, modify the fields you want to change, and send the complete object back in the update request.

Updates to active, schedules, and policies take effect immediately. Changes to source or destination configuration take effect on the sync’s next execution.

Because omitted fields are reset to their defaults, the discovery and naming options behave the same as on create when left out:

  • automatically_add_new_objects resets to not enabling newly discovered source objects automatically.
  • automatically_add_new_fields resets to enabling newly discovered fields on already selected objects.
  • normalize_names resets to enabled.

Send the existing values explicitly if you want to preserve a non-default or non-empty setting, including schema and field selections.

📘 Updating schemas

Schema updates are not performed through this endpoint. Use the Update Bulk Sync Schemas endpoint to change a subset of schemas, or Update Bulk Sync Schema to replace a single schema’s configuration.

Authentication

AuthorizationBasic

This is the Polytomic deployment key (on-premises only)

OR
AuthorizationBearer
This is the Polytomic API key

Path parameters

idstringRequiredformat: "uuid"

Headers

X-Polytomic-VersionstringRequired

Request

This endpoint expects an object.
destination_configurationmap from strings to anyRequired
destination_connection_idstringRequiredformat: "uuid"
modeenumRequired
Allowed values:
namestringRequired
scheduleobjectRequired
source_connection_idstringRequiredformat: "uuid"
activeboolean or nullOptional
automatically_add_new_fieldsenumOptional
Allowed values:
automatically_add_new_objectsenumOptional
Allowed values:
concurrency_limitinteger or nullOptional
Override the default concurrency limit for this sync.
data_cutoff_timestampstring or nullOptionalformat: "date-time"
disable_record_timestampsboolean or nullOptionalDefaults to false
discoverboolean or nullOptional

DEPRECATED: Use automatically_add_new_objects/automatically_add_new_fields instead

normalize_namesenumOptional
Allowed values:
organization_idstring or nullOptionalformat: "uuid"
policieslist of strings or nullOptional
resync_concurrency_limitinteger or nullOptional
Override the default resync concurrency limit for this sync.
schemaslist of strings or objects or nullOptional

List of schemas to sync; if omitted, all schemas will be selected for syncing.

source_configurationmap from strings to any or nullOptional

Response

OK
dataobject

Errors

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