2025-09-18 Migration Guide

This document describes the breaking changes between 2024-02-08 and 2025-09-18. It should serve as an easy guide to understand what changed, and why.

Interface Breakages

Model Sync: List Syncs

This API has been overhauled in the following ways:

Results are now paginated
Results now do not include all sync properties. For example (non-exhustive):
- the target connection is not loaded, and instead we provide target connection id/target id fields
- a list of field mappings/overrides/filters are not provided
If you require these details, they can be retrieved by through the Model Sync > Get Sync endpoint.

The list sync endpoint is intended to be a light-weight way to discover all available syncs in an account, rather than retreive exhaustive details of a sync.

Bulk Sync: List

This API has been overhauled in the following way:

The Schedule parameter has been removed
A Schedules parameter has been added with a new schema.

Given that syncs now support multiple schedules, they are more conveniently exposed as array of schedules instead of collapsed into a single object.

The multi schedule type is also deprecated; schedules by default may operate in a multi-schedule mode. See example below for how the parameter has been adjusted.

Bulk Sync: Create

This API has been overhauled in the following way:

The Schedule parameter has been removed
A Schedules parameter has been added with a new schema.

Given that syncs now support multiple schedules, they are more conveniently exposed as array of schedules instead of collapsed into a single object.

The multi schedule type is also deprecated; schedules by default may operate in a multi-schedule mode. See example below for how the parameter has been adjusted.

Bulk Sync: Update

This API has been overhauled in the following way:

The Schedule parameter has been removed
A Schedules parameter has been added with a new schema.

Given that syncs now support multiple schedules, they are more conveniently exposed as array of schedules instead of collapsed into a single object.

The multi schedule type is also deprecated; schedules by default may operate in a multi-schedule mode. See example below for how the parameter has been adjusted.

Examples

Here is an example of how the schedule parameter has been reformatted to schedules in the Bulk Create/Update/List/Get endpoints.

Old Update Bulk Sync payload, with schedule parameter:

{
  "name": "my bulk sync",
  ...
  "schedule": {
    "frequency": "multi",
    "multi": {
      "schedules": [
        {
          "item": "incrementalFields",
          "schedule": {
            "frequency": "continuous"
          }
        },
        {
          "item": "nonincrementalFields",
          "schedule": {
            "frequency": "daily",
            "hour": "05",
            "minute": "00",  
          }
        }
      ]
    }
  },
  ...
}

New Update Bulk Sync payload, with schedules parameter:

{
  "name": "my bulk sync",
  ...
  "schedules": [
    {
      "frequency": "continuous"
      "selective_mode": "incrementalFields"
    },
    {
      "selective_mode": "nonincrementalFields",
      "frequency": "daily",
      "hour": "05",
      "minute": "00"
    }
  ],
  ...
}