Warehouse Sync

Update warehouse sync

Changed on

Changes a sync. Omitted fields keep their current values. Query, mapping and cursor changes are checked against the query's columns; a changed query or cursor reads from the beginning again, while unchanged rows are still skipped. Other changes do not contact the warehouse. Saving makes the caller the user imports run as. On a sync that starts automations or sends double opt-in emails, changing the query, mapping, cursor or lists needs automations:trigger. A run in progress stops at its next page and runs again with the new settings.

patch/warehouse-syncs/{id}

Request

  • Base URL
    https://api.sequenzy.com/api/v1
  • URL
    https://api.sequenzy.com/api/v1/warehouse-syncs/{id}
  • Auth
    HTTP bearer

Path parameters

idstring required

Request body

namestring
querystring
cursorColumnstring nullable

Column read incrementally, for example updated_at. Each run reads rows at or after the last value it saw.

frequency'every_15_minutes' | 'hourly' | 'daily' | 'weekly' | 'manual'

manual cancels the next scheduled run.

listIdsstring[]

Subscriber syncs only. Lists that contacts the sync creates join; existing contacts keep their list memberships.

optInMode'confirmed' | 'double_opt_in'

Subscriber syncs only. double_opt_in needs automations:trigger.

triggerAutomationsboolean

Let new contacts, or events from the last hour, start automations. Needs automations:trigger.

isEnabledboolean

false pauses the sync, true resumes it.

Response

Sync updated

successboolean

Example response

{
  "success": true
}

Changes