Initiating a synchronisation

Synchronisations can be triggered on schedule, which can be setup in the configuration, or through the manual sync endpoint in the API.

Scheduled synchronisations

Synchronisations will run on a scheduled basis, according to the configuration.

Manual synchronisations

A synchronisation can be triggered immediately by making a call to the /company/{companyId}/sync endpoint.

Queuing multiple syncs

When the manual sync endpoint is called, if there is already a sync in progress an additional sync will not be queued.

Updated 2 months ago

Initiating a synchronisation

Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.