Create Sync | Polytomic Docs

curl -X POST https://app.polytomic.com/api/syncs \
     -H "Authorization: Bearer <token>" \
     -H "Content-Type: application/json" \
     -d '{
  "fields": [
    {
      "target": "name"
    }
  ],
  "mode": "create",
  "name": "Users Sync",
  "schedule": {},
  "target": {
    "connection_id": "248df4b7-aa70-47b8-a036-33ac447e668d"
  }
}'

{
  "data": {
    "active": true,
    "created_at": "2024-01-15T09:30:00Z",
    "created_by": {
      "id": "12345678-1234-1234-1234-123456789012",
      "name": "John Doe",
      "type": "user"
    },
    "encryption_passphrase": "string",
    "fields": [
      {
        "target": "name",
        "encryption_enabled": true,
        "new": false,
        "override_value": "fixed_value",
        "source": {
          "field": "id",
          "model_id": "248df4b7-aa70-47b8-a036-33ac447e668d"
        },
        "sync_mode": "create"
      }
    ],
    "id": "248df4b7-aa70-47b8-a036-33ac447e668d",
    "identities": {
      "mappings": [
        {
          "function": "Equality",
          "source": {
            "field": "id",
            "model_id": "248df4b7-aa70-47b8-a036-33ac447e668d"
          },
          "target": "name",
          "new_field": true,
          "remote_field_type_id": "string"
        }
      ],
      "strategy": "priority"
    },
    "mode": "create",
    "model_filters": {
      "conditions": [
        {
          "function": "Equality",
          "source": {
            "field": "id",
            "model_id": "248df4b7-aa70-47b8-a036-33ac447e668d"
          },
          "label": "A",
          "value": null
        }
      ],
      "logic": "A and B or C"
    },
    "model_ids": [
      "string"
    ],
    "name": "Users Sync",
    "only_enrich_updates": false,
    "organization_id": "248df4b7-aa70-47b8-a036-33ac447e668d",
    "override_fields": [
      {
        "override_value": "fixed_value",
        "target": "name",
        "new": false,
        "sync_mode": "create"
      }
    ],
    "overrides": [
      {
        "field": {
          "field": "id",
          "model_id": "248df4b7-aa70-47b8-a036-33ac447e668d"
        },
        "field_id": "field1",
        "function": "Equality",
        "override": null,
        "value": null
      }
    ],
    "policies": [
      "248df4b7-aa70-47b8-a036-33ac447e668d"
    ],
    "problems": [
      {
        "code": "unknown_target_field",
        "message": "string",
        "path": "target_filters.conditions[1].field",
        "severity": "error"
      }
    ],
    "schedule": {
      "connection_id": "248df4b7-aa70-47b8-a036-33ac447e668d",
      "day_of_month": "1",
      "day_of_week": "monday",
      "frequency": "manual",
      "hour": "12",
      "job_id": 1,
      "minute": "30",
      "month": "1",
      "run_after": {
        "bulk_sync_ids": [
          "248df4b7-aa70-47b8-a036-33ac447e668d"
        ],
        "sync_ids": [
          "248df4b7-aa70-47b8-a036-33ac447e668d"
        ]
      },
      "run_after_success_only": true
    },
    "skip_initial_backfill": false,
    "sync_all_records": false,
    "target": {
      "connection_id": "248df4b7-aa70-47b8-a036-33ac447e668d",
      "configuration": {
        "key": "value"
      },
      "create": {
        "name": "value"
      },
      "object": "Users",
      "filter_logic": "string",
      "new_name": "string",
      "search_values": {
        "name": "value"
      }
    },
    "target_filters": {
      "conditions": [
        {
          "field": "Email",
          "function": "Equality",
          "label": "A",
          "value": null,
          "value_source": {
            "field": "id",
            "model_id": "248df4b7-aa70-47b8-a036-33ac447e668d"
          }
        }
      ],
      "logic": "A and B"
    },
    "updated_at": "2024-01-15T09:30:00Z",
    "updated_by": {
      "id": "12345678-1234-1234-1234-123456789012",
      "name": "John Doe",
      "type": "user"
    },
    "filter_logic": "string",
    "filters": [
      {
        "function": "Equality",
        "field": {
          "field": "id",
          "model_id": "248df4b7-aa70-47b8-a036-33ac447e668d"
        },
        "field_id": "field1",
        "field_type": "Model",
        "label": "A",
        "value": null,
        "value_field": {
          "field": "id",
          "model_id": "248df4b7-aa70-47b8-a036-33ac447e668d"
        }
      }
    ],
    "identity": {
      "function": "Equality",
      "source": {
        "field": "id",
        "model_id": "248df4b7-aa70-47b8-a036-33ac447e668d"
      },
      "target": "name",
      "new_field": true,
      "remote_field_type_id": "string"
    }
  }
}

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.

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

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.

"target": {
    "connection_id": "248df4b7-aa70-47b8-a036-33ac447e668d",
    "create": {
        "name": "New audience",
        "type": "user_audience"
    }
},

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

Authentication

AuthorizationBearer

Bearer user API key

AuthorizationBasic

Basic organization-scoped 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.

identitiesobjectOptional

Identity mappings for the sync and the strategy combining them, replacing any the sync has. When this is omitted, 'identity' is used instead; updating a sync with more than one mapping requires this property.

model_filtersobjectOptional

Filters applied to the records read from the source.

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

Target fields which are set to a fixed value for every record, rather than mapped from a model field.

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.

target_filtersobjectOptional

Filters applied to the destination records the sync has matched. Only some destinations and sync modes support them; 'supports_target_filters' on the mode returned by GET /api/connections/{id}/modelsync/target/fields says which.

filter_logicstringOptionalDeprecated

Deprecated. Use 'model_filters.logic'. Combines the model filters in 'filters' only.

filterslist of objects or nullOptionalDeprecated

Deprecated. Use 'model_filters.conditions' and 'target_filters.conditions', which say which kind each condition is rather than inferring it. Ignored when either of those is present, except that a request carrying both shapes is rejected if they describe different filters.

identityobjectOptionalDeprecated

Deprecated. Use 'identities'. Reports and accepts the first identity mapping only.

Response

dataobjectOptional

Errors

400

Bad Request Error

403

Forbidden Error

404

Not Found Error

422

Unprocessable Entity Error

500

Internal Server Error