Create Sync

POST

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

Either field or field_id must be provided. If field is provided, field_id is ignored.

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 }'

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

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