REST API 2025-09-18 migration guide

This guide describes the breaking changes between 2024-02-08 and 2025-09-18 and explains why each one was made.

Interface changes

Model Sync: list syncs

The list endpoint now returns paginated results and a lighter response shape:

• Results are paginated.
• The response does not include every sync property. For example (non-exhaustive):
  • The target connection is not loaded. Polytomic returns target_connection_id and target ID fields instead.
  • Field mappings, overrides, and filters are not included.

If you need these details, fetch them from the Model Sync Get Sync endpoint. Use list to discover syncs in an account; use get to retrieve the full configuration of a single sync.

Bulk Sync: list, create, and update

The list, create, and update endpoints have changed in the same way:

• The schedule parameter has been removed.
• A schedules parameter has been added, with a new schema.

Bulk Syncs now support multiple schedules, so Polytomic exposes them as an array instead of collapsing them into a single object. The multi schedule type is deprecated — schedules operate in multi-schedule mode by default.

Example: schedule becomes schedules

The schedule parameter on Bulk Sync create, update, list, and get endpoints has been reformatted as schedules.

Old update payload, using schedule:

1
{
2
  "name": "my bulk sync",
3
  "schedule": {
4
    "frequency": "multi",
5
    "multi": {
6
      "schedules": [
7
        {
8
          "item": "incrementalFields",
9
          "schedule": {
10
            "frequency": "continuous"
11
          }
12
        },
13
        {
14
          "item": "nonincrementalFields",
15
          "schedule": {
16
            "frequency": "daily",
17
            "hour": "05",
18
            "minute": "00"
19
          }
20
        }
21
      ]
22
    }
23
  }
24
}

New update payload, using schedules:

1
{
2
  "name": "my bulk sync",
3
  "schedules": [
4
    {
5
      "frequency": "continuous",
6
      "selective_mode": "incrementalFields"
7
    },
8
    {
9
      "selective_mode": "nonincrementalFields",
10
      "frequency": "daily",
11
      "hour": "05",
12
      "minute": "00"
13
    }
14
  ]
15
}