Skip to main content
PATCH
Update Warehouse Sync
Updates a sync. Send only what changes. Requires warehouse:write and subscribers:write (plus events:write for event syncs).
  • query, mapping and cursorColumn are checked against the query’s columns. A changed query or cursor reads from the beginning again; unchanged rows are still skipped.
  • Other changes save without contacting the warehouse.
  • Turning on triggerAutomations or double_opt_in needs automations:trigger. On a sync that already has either on, so does changing query, mapping, cursorColumn or listIds.
  • Saving makes you the user the sync’s imports run as.
  • Setting frequency to manual cancels the next scheduled run.
  • A run in progress stops at its next page of rows and runs again with the new settings.
string
required
Sync ID.
string
string
object
Replaces the mapping. See Create.
string | null
null removes the cursor.
string
string[]
Lists that contacts the sync creates join. Existing contacts keep theirs.
string
boolean
boolean
false pauses the sync, true resumes it.