Create Bulk Sync

POST

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

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

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     "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     },
24     "source_configuration": {
25       "replication_slot": "slot"
26     },
27     "source_connection_id": "248df4b7-aa70-47b8-a036-33ac447e668d"
28   }
29 }

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	"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	},
24	"source_configuration": {
25	"replication_slot": "slot"
26	},
27	"source_connection_id": "248df4b7-aa70-47b8-a036-33ac447e668d"
28	}
29	}