Create Bulk Sync

POST

Headers

X-Polytomic-VersionstringOptional

Request

This endpoint expects an object.

destination_connection_idstringRequired

namestringRequired

scheduleobjectRequired

source_connection_idstringRequired

activebooleanOptional

automatically_add_new_fieldsenumOptional

Allowed values: allonlyIncrementalonlyNonIncrementalnone

automatically_add_new_objectsenumOptional

Allowed values: allonlyIncrementalonlyNonIncrementalnone

data_cutoff_timestampdatetimeOptional

destination_configurationmap from strings to anyOptional

disable_record_timestampsbooleanOptional

discoverbooleanOptional

DEPRECATED: Use automatically_add_new_objects/automatically_add_new_fields instead

modeenumOptional

organization_idstringOptional

policieslist of stringsOptional

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

This endpoint returns an object.

dataobjectOptional

Errors

POST

1 curl -X POST https://app.polytomic.com/api/bulk/syncs \
2      -H "Authorization: Bearer <token>" \
3      -H "Content-Type: application/json" \
4      -d '{
5   "destination_connection_id": "248df4b7-aa70-47b8-a036-33ac447e668d",
6   "name": "My Bulk Sync",
7   "schedule": {
8     "frequency": "manual"
9   },
10   "source_connection_id": "248df4b7-aa70-47b8-a036-33ac447e668d"
11 }'

200Successful

1 {
2   "data": {
3     "active": true,
4     "automatically_add_new_fields": "all",
5     "automatically_add_new_objects": "all",
6     "data_cutoff_timestamp": "2023-04-25T12:00:00Z",
7     "destination_configuration": {
8       "schema": "my_schema"
9     },
10     "destination_connection_id": "248df4b7-aa70-47b8-a036-33ac447e668d",
11     "disable_record_timestamps": false,
12     "discover": true,
13     "id": "248df4b7-aa70-47b8-a036-33ac447e668d",
14     "mode": "replace",
15     "name": "My Bulk Sync",
16     "organization_id": "248df4b7-aa70-47b8-a036-33ac447e668d",
17     "policies": [
18       "248df4b7-aa70-47b8-a036-33ac447e668d"
19     ],
20     "schedule": {
21       "frequency": "manual",
22       "day_of_month": "1",
23       "day_of_week": "monday",
24       "hour": "0",
25       "minute": "0",
26       "month": "1"
27     },
28     "source_configuration": {
29       "replication_slot": "slot"
30     },
31     "source_connection_id": "248df4b7-aa70-47b8-a036-33ac447e668d"
32   }
33 }

Get Bulk Sync

Up Next

1	curl -X POST https://app.polytomic.com/api/bulk/syncs \
2	-H "Authorization: Bearer <token>" \
3	-H "Content-Type: application/json" \
4	-d '{
5	"destination_connection_id": "248df4b7-aa70-47b8-a036-33ac447e668d",
6	"name": "My Bulk Sync",
7	"schedule": {
8	"frequency": "manual"
9	},
10	"source_connection_id": "248df4b7-aa70-47b8-a036-33ac447e668d"
11	}'

1	{
2	"data": {
3	"active": true,
4	"automatically_add_new_fields": "all",
5	"automatically_add_new_objects": "all",
6	"data_cutoff_timestamp": "2023-04-25T12:00:00Z",
7	"destination_configuration": {
8	"schema": "my_schema"
9	},
10	"destination_connection_id": "248df4b7-aa70-47b8-a036-33ac447e668d",
11	"disable_record_timestamps": false,
12	"discover": true,
13	"id": "248df4b7-aa70-47b8-a036-33ac447e668d",
14	"mode": "replace",
15	"name": "My Bulk Sync",
16	"organization_id": "248df4b7-aa70-47b8-a036-33ac447e668d",
17	"policies": [
18	"248df4b7-aa70-47b8-a036-33ac447e668d"
19	],
20	"schedule": {
21	"frequency": "manual",
22	"day_of_month": "1",
23	"day_of_week": "monday",
24	"hour": "0",
25	"minute": "0",
26	"month": "1"
27	},
28	"source_configuration": {
29	"replication_slot": "slot"
30	},
31	"source_connection_id": "248df4b7-aa70-47b8-a036-33ac447e668d"
32	}
33	}