POST
/
core
/
pipeline
/
{id}
/
_sync
curl --request POST \
  --url https://api.openint.dev/v0/core/pipeline/{id}/_sync \
  --header 'Content-Type: application/json' \
  --header 'x-apikey: <api-key>' \
  --header 'x-connection-id: <api-key>' \
  --data '{
  "async": true,
  "metaOnly": true,
  "fullResync": true,
  "todo_upstreamRefresh": true,
  "todo_removeUnsyncedData": true
}'
{}

Authorizations

​
x-apikey
string
header
required
​
x-connection-id
string
header
required

Path Parameters

​
id
string
required

Must start with 'pipe_'

Body

application/json
​
async
boolean | null

Run sync in the background, not compatible with other options for now...

​
metaOnly
boolean | null

Only sync connection metadata and skip pipelines

​
fullResync
boolean | null

Remove state of pipeline and trigger a full resync

​
todo_upstreamRefresh
boolean | null
Triggers provider to refresh data from its source
https://plaid.com/docs/api/products/transactions/#transactionsrefresh
This may also load historical transactions. For example,
Finicity treats historical transaction as premium service.
​
todo_removeUnsyncedData
boolean | null
See coda's implmementation. Requires adding a new message to the sync protocol
to remove all data from a particular source_id

Response

200
application/json
Successful response

The response is of type object.

Previous
List Contacts
Next