Bulk Sync

Update Bulk Sync

PUT

Path parameters

idstringRequired

Request

This endpoint expects an object.
destination_connection_id
stringRequired
mode
stringRequired
Either 'replicate' or 'snapshot'.
name
stringRequired
schedule
objectRequired
source_connection_id
stringRequired
active
booleanOptional
automatically_add_new_fields
enumOptional
Allowed values: allonlyIncrementalonlyNonIncrementalnone
automatically_add_new_objects
enumOptional
Allowed values: allonlyIncrementalonlyNonIncrementalnone
destination_configuration
map from strings to anyOptional
disable_record_timestamps
booleanOptional
discover
booleanOptional

DEPRECATED: Use automatically_add_new_objects/automatically_add_new_fields instead

organization_id
stringOptional
policies
list of stringsOptional
schemas
list of stringsOptional
source_configuration
map from strings to anyOptional

Response

This endpoint returns an object
data
objectOptional

Errors

PUT
1curl -X PUT https://app.polytomic.com/api/bulk/syncs/248df4b7-aa70-47b8-a036-33ac447e668d \
2 -H "Authorization: Bearer <token>" \
3 -H "Content-Type: application/json" \
4 -d '{
5 "destination_connection_id": "248df4b7-aa70-47b8-a036-33ac447e668d",
6 "mode": "replicate",
7 "name": "My Bulk Sync",
8 "schedule": {
9 "frequency": "manual"
10 },
11 "source_connection_id": "248df4b7-aa70-47b8-a036-33ac447e668d"
12}'
1{
2 "data": {
3 "active": true,
4 "destination_configuration": {
5 "schema": "my_schema"
6 },
7 "destination_connection_id": "248df4b7-aa70-47b8-a036-33ac447e668d",
8 "discover": true,
9 "id": "248df4b7-aa70-47b8-a036-33ac447e668d",
10 "mode": "replace",
11 "name": "My Bulk Sync",
12 "organization_id": "248df4b7-aa70-47b8-a036-33ac447e668d",
13 "policies": [
14 "248df4b7-aa70-47b8-a036-33ac447e668d"
15 ],
16 "schedule": {
17 "frequency": "manual",
18 "day_of_month": "1",
19 "day_of_week": "monday",
20 "hour": "0",
21 "minute": "0",
22 "month": "1",
23 "multi": {
24 "type": "type"
25 }
26 },
27 "source_configuration": {
28 "replication_slot": "slot"
29 },
30 "source_connection_id": "248df4b7-aa70-47b8-a036-33ac447e668d"
31 }
32}