Update Bulk Sync | Polytomic Docs

curl -X PATCH 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"
}'

{
  "data": {
    "active": true,
    "automatically_add_new_fields": "all",
    "automatically_add_new_objects": "all",
    "concurrency_limit": 50,
    "created_at": "2024-01-15T09:30:00Z",
    "created_by": {
      "id": "12345678-1234-1234-1234-123456789012",
      "name": "John Doe",
      "type": "user"
    },
    "data_cutoff_timestamp": "2023-04-25T12:00:00Z",
    "destination_configuration": {
      "schema": "my_schema"
    },
    "destination_connection_id": "248df4b7-aa70-47b8-a036-33ac447e668d",
    "disable_record_timestamps": false,
    "id": "248df4b7-aa70-47b8-a036-33ac447e668d",
    "mode": "snapshot",
    "name": "My Bulk Sync",
    "normalize_names": "enabled",
    "organization_id": "248df4b7-aa70-47b8-a036-33ac447e668d",
    "policies": [
      "248df4b7-aa70-47b8-a036-33ac447e668d"
    ],
    "resync_concurrency_limit": 10,
    "schedule": {
      "frequency": "manual",
      "day_of_month": "1",
      "day_of_week": "monday",
      "hour": "0",
      "minute": "0",
      "month": "1",
      "multi": {
        "schedules": [
          {
            "item": "none"
          }
        ],
        "type": "string"
      }
    },
    "source_configuration": {
      "replication_slot": "slot"
    },
    "source_connection_id": "248df4b7-aa70-47b8-a036-33ac447e668d",
    "updated_at": "2024-01-15T09:30:00Z",
    "updated_by": {
      "id": "12345678-1234-1234-1234-123456789012",
      "name": "John Doe",
      "type": "user"
    },
    "discover": true
  }
}

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.

📘 Updating schemas

When schemas is present, it replaces the sync’s schema selection: schemas not in the list are disabled. When schemas is omitted or empty, the sync’s schemas are left unchanged. 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.

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. > 📘 Updating schemas > > When `schemas` is present, it replaces the sync's schema selection: schemas > not in the list are disabled. When `schemas` is omitted or empty, the sync's > schemas are left unchanged. 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.

Authentication

AuthorizationBasic

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

AuthorizationBearer

This is the Polytomic API key

Path parameters

idstringRequiredformat: "uuid"

Request

This endpoint expects an object.

destination_configurationmap from strings to anyRequired

destination_connection_idstringRequiredformat: "uuid"

modeenumRequired

namestringRequired

scheduleobjectRequired

source_connection_idstringRequiredformat: "uuid"

activeboolean or nullOptional

automatically_add_new_fieldsenumOptional

automatically_add_new_objectsenumOptional

concurrency_limitinteger or nullOptional

Override the default concurrency limit for this sync.

data_cutoff_timestampdatetime or nullOptional

disable_record_timestampsboolean or nullOptionalDefaults to false

discoverboolean or nullOptional

DEPRECATED: Use automatically_add_new_objects/automatically_add_new_fields instead

normalize_namesenumOptional

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

Schemas to sync. Schemas not in the list are disabled; if omitted or empty, the sync’s schemas are left unchanged.

source_configurationmap from strings to any or nullOptional

Response

dataobjectOptional

Errors

400

Bad Request Error

401

Unauthorized Error

403

Forbidden Error

404

Not Found Error

409

Conflict Error

500

Internal Server Error