Update Sync Filter

post

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

API for updating data filters on an existing sync

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

📘
Take a look at Sync Filtering Guide to learn more about how filters work
Do take a look at the Sync Filtering Guide to learn more about what filters are, and how to construct a filter object.

🚧
Updating the filter for a sync triggers an initial_sync
When you update the filter using this API, it would trigger an initial_sync, so as to baseline the data with the new filter
Use the triggerSync parameter to control this behavior.

Body Params

dataType

string

enum

required

triggerSync

boolean

Defaults to true

virtualFilters

json

For more information on how to create the payload for filters, refer to this guide -https://developers.getknit.dev/docs/filtering-data-in-syncs-1

nativeFilters

array of objects

For more information on how to create the payload for filters, refer to this guide -https://developers.getknit.dev/docs/filtering-data-in-syncs-1

nativeFilters

passThroughFilters

json

For more information on how to create the payload for filters, refer to this guide -https://developers.getknit.dev/docs/filtering-data-in-syncs-1

Responses

Language

Credentials

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

Take a look at Sync Filtering Guide to learn more about how filters work

Updating the filter for a sync triggers an initial_sync

200200

400400

Updating the filter for a sync triggers an `initial_sync`