Update Bulk Sync | Polytomic Docs

from polytomic import BulkSchedule, Polytomic
client = Polytomic(
    version="YOUR_VERSION",
    token="YOUR_TOKEN",
)
client.bulk_sync.update(
    id="248df4b7-aa70-47b8-a036-33ac447e668d",
    destination_configuration={"schema": "my_schema"},
    destination_connection_id="248df4b7-aa70-47b8-a036-33ac447e668d",
    name="My Bulk Sync",
    schedule=BulkSchedule(
        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,
    "schedules": [
      {
        "frequency": "weekly",
        "created_at": "2023-04-25T12:00:00Z",
        "created_by": {
          "id": "12345678-1234-1234-1234-123456789012",
          "name": "John Doe",
          "type": "user"
        },
        "day_of_month": "1",
        "day_of_week": "monday",
        "hour": "12",
        "id": "248df4b7-aa70-47b8-a036-33ac447e668d",
        "minute": "30",
        "month": "1",
        "selective_mode": "nonincrementalFields",
        "updated_at": "2023-04-25T12:00:00Z",
        "updated_by": {
          "id": "12345678-1234-1234-1234-123456789012",
          "name": "John Doe",
          "type": "user"
        }
      },
      {
        "frequency": "continuous",
        "created_at": "2023-04-25T12:00:00Z",
        "created_by": {
          "id": "12345678-1234-1234-1234-123456789012",
          "name": "John Doe",
          "type": "user"
        },
        "day_of_month": "1",
        "day_of_week": "monday",
        "hour": "12",
        "id": "248df4b7-aa70-47b8-a036-33ac447e668d",
        "minute": "30",
        "month": "1",
        "selective_mode": "incrementalFields",
        "updated_at": "2023-04-25T12:00:00Z",
        "updated_by": {
          "id": "12345678-1234-1234-1234-123456789012",
          "name": "John Doe",
          "type": "user"
        }
      }
    ],
    "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"
    }
  }
}

Authentication

AuthorizationBearer

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

Path parameters

idstringRequired

Request

This endpoint expects an object.

destination_configurationmap from strings to anyRequired

destination_connection_idstringRequiredformat: "uuid"

namestringRequired

scheduleslist of objectsRequired

source_connection_idstringRequiredformat: "uuid"

activebooleanOptional

automatically_add_new_fieldsenumOptional

Allowed values:

automatically_add_new_objectsenumOptional

Allowed values:

concurrency_limitintegerOptional

Override the default concurrency limit for this sync.

data_cutoff_timestampdatetimeOptional

disable_record_timestampsbooleanOptionalDefaults to false

modeenumOptional

Allowed values:

normalize_namesenumOptional

Allowed values:

organization_idstringOptionalformat: "uuid"

policieslist of stringsOptional

resync_concurrency_limitintegerOptional

Override the default resync concurrency limit for this sync.

schemaslist of strings or objectsOptional

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

source_configurationmap from strings to anyOptional

Response

dataobject

Errors

400

Bulk Sync Update Request Bad Request Error

401

Bulk Sync Update Request Unauthorized Error

403

Bulk Sync Update Request Forbidden Error

404

Bulk Sync Update Request Not Found Error

500

Bulk Sync Update Request Internal Server Error

Authentication

Path parameters

Headers

Request

Response

Errors