Triggers a sync for a specific integration. Use this to perform an initial sync or a delta sync on demand.
| Time | Status | User Agent | |
|---|---|---|---|
Retrieving recent requests… | |||
Syncs must be enabledSyncs must be enabled for the category to which the integration belongs. For more info, look at Enabling Syncs In the Getting Started Journey
Use thehonorSchedulerparameter to control when the nextdelta_syncshould happenThe default behavior for running ad-hoc syncs using this API is that the next
delta_syncruns after the subscribed frequency when the ad-hoc sync completes. For example, lets say that thedelta_syncsare running every 24 hours at 5 PM. However, at 1 PM, an ad-hoc sync was triggered using this API, which completed at 1:15 PM. The nextdelta_syncwould be triggered at 1:15PM the following day, i.e. 24 hours after the previous sync, and not at 5 PM.If the
honorScheduleris true, then thedelta_syncswould happen at their given schedule without taking ad-hoc syncs into account. In the above example, if an ad-hoc sync is triggered at 1 PM and completed at 1:15 PM, the nextdelta_syncwould be triggered at 5 PM itself, honoring the original scheduler that was present before the ad-hoc sync was triggered.
Use the
startHourandstartMinuteparamters to update the next start time of a sync to a particular hour and minute. For example, if you set the startHour as 23 and startMinute as 0 using this API, then the next sync run would be scheduled for 23:00 UTC