HIhightouch

Trigger Sync

Trigger a new run for the given sync.

If a run is already in progress, this queues a sync run that will get executed immediately after the current run completes.

post/syncs/{syncId}/trigger

Request

  • Base URL
    https://api.hightouch.com/api/v1
  • Auth
    HTTP bearer

Path parameters

syncIdstring required

The id of the sync to trigger a run

Request body

clearAndFillboolean

Whether to clear the audience and then sync the full query to the destination

resetCDCboolean

Whether to sync all the rows in the query without executing changes on the destination.

fullResyncboolean

Whether to resync all the rows in the query (i.e. ignoring previously synced rows).

Response

Ok

idstring required

The id of the triggered sync run. This can be passed to /sync/runs to get the run's status.

Changes

No recorded changes to this operation across all 19 revisions of this API.