Create Sync | Polytomic Docs

Creates a new model sync.

Create a new sync from one or more models to a destination.

All of the functionality described in the product documentation is configurable via the API.

Guides:

Targets (Destinations)

Polytomic refers to a model sync’s destination as the “target object”, or target. Target objects are identified by a connection ID and an object ID. You can retrieve a list of all target objects for a connection using the Get Target Objects endpoint.

The target object in the request specifies information about the sync destination.

1 "target": {
2     "connection_id": "248df4b7-aa70-47b8-a036-33ac447e668d",
3     "object": "Users",
4 },

Some connections support additional configuration for targets. For example, Salesforce connections support optionally specifying the ingestion API to use. The target specific options are passed as configuration; consult the integration guides for details about specific connection configurations.

Creating a new target

Some integrations support creating a new target when creating a model sync. For example, an ad audience or database table.

When creating a new target, object is omitted and create is specified instead. The create property is an object containing integration specific configuration for the new target.

1 "target": {
2     "connection_id": "248df4b7-aa70-47b8-a036-33ac447e668d",
3     "create": {
4         "name": "New audience",
5         "type": "user_audience"
6     }
7 },

The Get Target List endpoint returns information about whether a connection supports target creation.

Creates a new model sync. Create a new sync from one or more models to a destination. All of the functionality described in [the product documentation](https://docs.polytomic.com/docs/sync-destinations) is configurable via the API. Guides: - [Model sync (Reverse ETL) from Snowflake query to Salesforce](https://apidocs.polytomic.com/2024-02-08/guides/code-examples/model-sync-reverse-etl-from-snowflake-query-to-salesforce) - [Joined model sync from Postgres, Airtable, and Stripe to Hubspot](https://apidocs.polytomic.com/2024-02-08/guides/code-examples/joined-model-sync-from-postgres-airtable-and-stripe-to-hubspot) ## Targets (Destinations) Polytomic refers to a model sync's destination as the "target object", or target. Target objects are identified by a connection ID and an object ID. You can retrieve a list of all target objects for a connection using the [Get Target Objects](./targets/list) endpoint. The `target` object in the request specifies information about the sync destination. ```json "target": { "connection_id": "248df4b7-aa70-47b8-a036-33ac447e668d", "object": "Users", }, ``` Some connections support additional configuration for targets. For example, [Salesforce connections](https://apidocs.polytomic.com/2024-02-08/guides/configuring-your-connections/connections/salesforce#target) support optionally specifying the ingestion API to use. The target specific options are passed as `configuration`; consult the [integration guides](https://apidocs.polytomic.com/2024-02-08/guides/configuring-your-connections/overview) for details about specific connection configurations. ### Creating a new target Some integrations support creating a new target when creating a model sync. For example, an ad audience or database table. When creating a new target, `object` is omitted and `create` is specified instead. The `create` property is an object containing integration specific configuration for the new target. ```json "target": { "connection_id": "248df4b7-aa70-47b8-a036-33ac447e668d", "create": { "name": "New audience", "type": "user_audience" } }, ``` The [Get Target List](./targets/list) endpoint returns information about whether a connection supports target creation.

Authentication

AuthorizationBasic

This is the Polytomic deployment key (on-premises only)

AuthorizationBearer

This is the Polytomic API key

Request

This endpoint expects an object.

fieldslist of objectsRequired

Fields to sync from source to destination.

modeenumRequired

namestringRequired

scheduleobjectRequired

targetobjectRequired

activebooleanOptional

Whether the sync is enabled and scheduled.

encryption_passphrasestringOptional

Passphrase for encrypting the sync data.

filter_logicstringOptional

Logical expression to combine filters.

filterslist of objects or nullOptional

Filters to apply to the source data.

identityobjectOptional

only_enrich_updatesbooleanOptional

Whether to use enrichment models as a source of possible changes to sync. If true, only changes to the base models will cause a record to sync.

organization_idstring or nullOptionalformat: "uuid"

Organization ID for the sync; read-only with a partner key.

override_fieldslist of objects or nullOptional

Values to set in the target unconditionally.

overrideslist of objects or nullOptional

Conditional value replacement for fields.

policieslist of strings or nullOptional

skip_initial_backfillbooleanOptional

Whether to skip the initial backfill of records; if true only records seen after the sync is enabled will be synced.

sync_all_recordsbooleanOptional

Whether to sync all records from the source, regardless of whether they've changed since the previous execution.

Response

dataobject

Errors

400

Bad Request Error

401

Unauthorized Error

403

Forbidden Error

422

Unprocessable Entity Error

500

Internal Server Error

Creates a new model sync.

Create a new sync from one or more models to a destination.

All of the functionality described in the product documentation is configurable via the API.

Guides:

Targets (Destinations)

The target object in the request specifies information about the sync destination.

1 "target": {
2     "connection_id": "248df4b7-aa70-47b8-a036-33ac447e668d",
3     "object": "Users",
4 },

Creating a new target

Some integrations support creating a new target when creating a model sync. For example, an ad audience or database table.

When creating a new target, object is omitted and create is specified instead. The create property is an object containing integration specific configuration for the new target.

1 "target": {
2     "connection_id": "248df4b7-aa70-47b8-a036-33ac447e668d",
3     "create": {
4         "name": "New audience",
5         "type": "user_audience"
6     }
7 },

The Get Target List endpoint returns information about whether a connection supports target creation.

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

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

Targets (Destinations)

Creating a new target

Authentication

Headers

Request

Response

Errors

Targets (Destinations)

Creating a new target