Skip to content

Start Delta Sync

POST
/integrations/migrations/delta-sync

Import only what changed since a watermark.

OMIT since unless you have a reason: the app picks the last successful watermark, which is both what you usually want and safer than guessing. The response echoes back the watermark actually used, so read it rather than assuming yours was accepted.

Org admin, matching the app.

Authorizations

Parameters

Header Parameters

X-Target-Org-Id
Any of:
string

Request Body required

Import only what changed since a watermark.

The response echoes since back as ISO 8601, so the caller learns the watermark the server actually used rather than assuming its own was accepted.

object
connection_id
required
string
entity_types
Any of:
Array<string>
recover_missing

Also re-fetch records the previous run should have imported and did not. Slower, and the reason to use it is a suspected gap rather than routine.

boolean
since
Any of:
string

Responses

202

Successful Response

object
data
required

An open envelope for a connection, a token or a migration report.

Open because the migration STATUS payload carries a per-entity progress map, a discovered-field map and a pipeline list that all grow with the providers - and because a dropped warning on a migration report reads as “nothing went wrong”.

object
key
additional properties
any
pagination
Any of:
object
has_next
required

Whether there are more pages

boolean
limit
required

Items per page

integer
next_cursor
Any of:
string
page
required

Current page number (1-indexed)

integer
total
required

Total number of items

integer

422

Validation Error

object
detail
Array<object>
object
loc
required
Array
msg
required
string
type
required
string