API Reference
DashboardSignup For Free

Update a Sync

post
https://api.getknit.dev/v1.0/sync.update

Update the configuration of an existing sync — including the data models being synced, the polling frequency, or the webhook destination. Changing the subscribed models will automatically trigger an initial_sync to ensure you receive complete data for the new models.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
🚧

Knit will trigger an initial_sync if you update data models' subscription using this API so that you can get the latest data with the new models. initial_sync will not be triggered if you just update webhook destination or sync frequency.


Body Params
string
required

The sync job id you want to update

string
enum
required

The data category you want to sync. payroll and communication syncs are coming soon.

Allowed:
models
array of strings

The types of data models you want to sync.

models
string
enum

The polling frequency for the sync. Default is standard

Allowed:
Responses

Updated 3 months ago

Language
Credentials
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 3 months ago