Create 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:

• Model sync (Reverse ETL) from Snowflake query to Salesforce
• 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 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.