Create Sync

POST

Headers

X-Polytomic-VersionstringOptional

Request

This endpoint expects an object.

fieldslist of objectsRequired

Fields to sync from source to target.

modestringRequired

namestringRequired

scheduleobjectRequired

targetobjectRequired

activebooleanOptional

enricherobjectOptional

filter_logicstringOptional

filterslist of objectsOptional

identityobjectOptional

organization_idstringOptional

override_fieldslist of objectsOptional

Values to set in the target unconditionally.

overrideslist of objectsOptional

Conditional value replacement for fields.

policieslist of stringsOptional

sync_all_recordsbooleanOptional

Response

This endpoint returns an object.

dataobjectOptional

Errors

POST

1 curl -X POST https://app.polytomic.com/api/syncs \
2      -H "Authorization: Bearer <token>" \
3      -H "Content-Type: application/json" \
4      -d '{
5   "fields": [
6     {
7       "target": "name"
8     }
9   ],
10   "mode": "create",
11   "name": "Users Sync",
12   "schedule": {},
13   "target": {
14     "connection_id": "248df4b7-aa70-47b8-a036-33ac447e668d",
15     "object": "Users"
16   }
17 }'

200Successful

1 {
2   "data": {
3     "active": true,
4     "created_at": "2024-01-15T09:30:00Z",
5     "created_by": {
6       "id": "248df4b7-aa70-47b8-a036-33ac447e668d",
7       "name": "name",
8       "type": "type"
9     },
10     "fields": [
11       {
12         "target": "name",
13         "override_value": "fixed_value",
14         "source": {
15           "field": "id",
16           "model_id": "248df4b7-aa70-47b8-a036-33ac447e668d"
17         },
18         "sync_mode": "create"
19       }
20     ],
21     "filter_logic": "filter_logic",
22     "filters": [
23       {
24         "function": "Equality",
25         "field": {
26           "field": "id",
27           "model_id": "248df4b7-aa70-47b8-a036-33ac447e668d"
28         },
29         "field_id": "field1",
30         "label": "A"
31       }
32     ],
33     "id": "248df4b7-aa70-47b8-a036-33ac447e668d",
34     "identity": {
35       "function": "Equality",
36       "source": {
37         "field": "id",
38         "model_id": "248df4b7-aa70-47b8-a036-33ac447e668d"
39       },
40       "target": "name",
41       "new_field": true,
42       "remote_field_type_id": "string"
43     },
44     "mode": "create",
45     "name": "Users Sync",
46     "organization_id": "248df4b7-aa70-47b8-a036-33ac447e668d",
47     "override_fields": [
48       {
49         "target": "name",
50         "override_value": "fixed_value",
51         "source": {
52           "field": "id",
53           "model_id": "248df4b7-aa70-47b8-a036-33ac447e668d"
54         },
55         "sync_mode": "create"
56       }
57     ],
58     "overrides": [
59       {
60         "field": {
61           "field": "id",
62           "model_id": "248df4b7-aa70-47b8-a036-33ac447e668d"
63         },
64         "field_id": "field1"
65       }
66     ],
67     "policies": [
68       "248df4b7-aa70-47b8-a036-33ac447e668d"
69     ],
70     "schedule": {
71       "connection_id": "248df4b7-aa70-47b8-a036-33ac447e668d",
72       "day_of_month": "1",
73       "day_of_week": "monday",
74       "frequency": "manual",
75       "hour": "12",
76       "job_id": 1,
77       "minute": "30",
78       "month": "1",
79       "run_after": {
80         "bulk_sync_ids": [
81           "248df4b7-aa70-47b8-a036-33ac447e668d"
82         ],
83         "sync_ids": [
84           "248df4b7-aa70-47b8-a036-33ac447e668d"
85         ]
86       },
87       "run_after_success_only": true
88     },
89     "sync_all_records": false,
90     "target": {
91       "connection_id": "248df4b7-aa70-47b8-a036-33ac447e668d",
92       "object": "Users",
93       "configuration": {
94         "key": "value"
95       },
96       "filter_logic": "filter_logic",
97       "new_name": "new_name",
98       "search_values": {
99         "name": "value"
100       }
101     },
102     "updated_at": "2024-01-15T09:30:00Z",
103     "updated_by": {
104       "id": "248df4b7-aa70-47b8-a036-33ac447e668d",
105       "name": "name",
106       "type": "type"
107     }
108   }
109 }

Get Sync Schedule Options

Up Next

1	curl -X POST https://app.polytomic.com/api/syncs \
2	-H "Authorization: Bearer <token>" \
3	-H "Content-Type: application/json" \
4	-d '{
5	"fields": [
6	{
7	"target": "name"
8	}
9	],
10	"mode": "create",
11	"name": "Users Sync",
12	"schedule": {},
13	"target": {
14	"connection_id": "248df4b7-aa70-47b8-a036-33ac447e668d",
15	"object": "Users"
16	}
17	}'

1	{
2	"data": {
3	"active": true,
4	"created_at": "2024-01-15T09:30:00Z",
5	"created_by": {
6	"id": "248df4b7-aa70-47b8-a036-33ac447e668d",
7	"name": "name",
8	"type": "type"
9	},
10	"fields": [
11	{
12	"target": "name",
13	"override_value": "fixed_value",
14	"source": {
15	"field": "id",
16	"model_id": "248df4b7-aa70-47b8-a036-33ac447e668d"
17	},
18	"sync_mode": "create"
19	}
20	],
21	"filter_logic": "filter_logic",
22	"filters": [
23	{
24	"function": "Equality",
25	"field": {
26	"field": "id",
27	"model_id": "248df4b7-aa70-47b8-a036-33ac447e668d"
28	},
29	"field_id": "field1",
30	"label": "A"
31	}
32	],
33	"id": "248df4b7-aa70-47b8-a036-33ac447e668d",
34	"identity": {
35	"function": "Equality",
36	"source": {
37	"field": "id",
38	"model_id": "248df4b7-aa70-47b8-a036-33ac447e668d"
39	},
40	"target": "name",
41	"new_field": true,
42	"remote_field_type_id": "string"
43	},
44	"mode": "create",
45	"name": "Users Sync",
46	"organization_id": "248df4b7-aa70-47b8-a036-33ac447e668d",
47	"override_fields": [
48	{
49	"target": "name",
50	"override_value": "fixed_value",
51	"source": {
52	"field": "id",
53	"model_id": "248df4b7-aa70-47b8-a036-33ac447e668d"
54	},
55	"sync_mode": "create"
56	}
57	],
58	"overrides": [
59	{
60	"field": {
61	"field": "id",
62	"model_id": "248df4b7-aa70-47b8-a036-33ac447e668d"
63	},
64	"field_id": "field1"
65	}
66	],
67	"policies": [
68	"248df4b7-aa70-47b8-a036-33ac447e668d"
69	],
70	"schedule": {
71	"connection_id": "248df4b7-aa70-47b8-a036-33ac447e668d",
72	"day_of_month": "1",
73	"day_of_week": "monday",
74	"frequency": "manual",
75	"hour": "12",
76	"job_id": 1,
77	"minute": "30",
78	"month": "1",
79	"run_after": {
80	"bulk_sync_ids": [
81	"248df4b7-aa70-47b8-a036-33ac447e668d"
82	],
83	"sync_ids": [
84	"248df4b7-aa70-47b8-a036-33ac447e668d"
85	]
86	},
87	"run_after_success_only": true
88	},
89	"sync_all_records": false,
90	"target": {
91	"connection_id": "248df4b7-aa70-47b8-a036-33ac447e668d",
92	"object": "Users",
93	"configuration": {
94	"key": "value"
95	},
96	"filter_logic": "filter_logic",
97	"new_name": "new_name",
98	"search_values": {
99	"name": "value"
100	}
101	},
102	"updated_at": "2024-01-15T09:30:00Z",
103	"updated_by": {
104	"id": "248df4b7-aa70-47b8-a036-33ac447e668d",
105	"name": "name",
106	"type": "type"
107	}
108	}
109	}