Update Sync | Polytomic Docs

curl -X PUT https://app.polytomic.com/api/syncs/248df4b7-aa70-47b8-a036-33ac447e668d \
     -H "X-Polytomic-Version: X-Polytomic-Version" \
     -H "Content-Type: application/json" \
     -u "<username>:<password>" \
     -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"
      }
    ],
    "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"
        }
      }
    ],
    "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"
    },
    "mode": "create",
    "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"
    ],
    "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"
      },
      "filter_logic": "A and B",
      "object": "Users",
      "new_name": "string",
      "search_values": {
        "name": "value"
      }
    },
    "updated_at": "2024-01-15T09:30:00Z",
    "updated_by": {
      "id": "12345678-1234-1234-1234-123456789012",
      "name": "John Doe",
      "type": "user"
    }
  }
}

Updates a model sync’s configuration.

Updating a model sync is a full replacement of the sync’s configuration. Every field in the request body is written to the sync; any field you omit is cleared or reset to its default value.

To make a partial change — for example, toggling active or adjusting a single field mapping — fetch the current sync with GET /api/syncs/{id}, modify the fields you want to change, and send the complete object back in the update request.

Updates to active, schedule, and policies take effect immediately. Changes to source fields, target configuration, filters, or field mappings take effect on the sync’s next execution.

Updates a model sync's configuration. Updating a model sync is a **full replacement** of the sync's configuration. Every field in the request body is written to the sync; any field you omit is cleared or reset to its default value. To make a partial change — for example, toggling `active` or adjusting a single field mapping — fetch the current sync with [`GET /api/syncs/{id}`](../../../api-reference/model-sync/get), modify the fields you want to change, and send the complete object back in the update request. Updates to `active`, `schedule`, and `policies` take effect immediately. Changes to source fields, target configuration, filters, or field mappings take effect on the sync's next execution.

Authentication

AuthorizationBasic

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

AuthorizationBearer

This is the Polytomic API key

Path parameters

idstringRequiredformat: "uuid"

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 combining this sync’s model filters — the entries in ‘filters’ whose ‘field_type’ is ‘Model’ — by their labels. Target filters are combined by ‘target.filter_logic’.

filterslist of objects or nullOptional

Filters on this sync. The array holds both filters on the records read from the source and filters on the records written to the destination; a filter’s ‘field_type’ says which it is.

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

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.

Response

dataobjectOptional

Errors

400

Bad Request Error

401

Unauthorized Error

403

Forbidden Error

404

Not Found Error

422

Unprocessable Entity Error

500

Internal Server Error

Authentication

Path parameters

Headers

Request

Response

Errors