Getting started

REST API V5 Migration Guide

This file describes the changes from earlier version of the API that must be adhered to in order to upgrade to this from the the API.

Interface Breakages

Model Sync: List Syncs

This API has been overhauled in the following ways:

  • Results are now paginated

  • Results from the sync list 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 are not provided

    If you require these details, they can be retrieved by through the Get Sync endpoint.

Bulk Sync: List

This API has been overhauled in the following ways:

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

Bulk Sync: Create

This API has been overhauled in the following ways:

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

Bulk Sync: Update

This API has been overhauled in the following ways:

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