Skip to main content
POST
Enable the datalayer sync for a connection

Authorizations

Authorization
string
header
required

This access token needs to be included in each of your request to the Chift API.

Path Parameters

consumer_id
string<uuid>
required
connection_id
string<uuid>
required

Body

application/json
from_date
string<date> | null

Date from which the data is synced. Defaults to one year ago when omitted.

fiscal_years_back
integer | null

Sync from the start of the book year this many fiscal years back (accounting only). 0 syncs from the start of the current fiscal year.

Required range: x >= 0
full_history
boolean
default:false

Sync the whole history, without a lower date bound. Mirrors the 'infinite' automatic-activation policy.

entity_filter
Entity Filter · object | null

Restrict the datalayer to specific entities of the connection instead of every one the end-user selected, keyed by entity kind applicable to the connection's vertical (e.g. folder_ids, location_ids). The ids are validated against the ones available on the connection when the sync runs. Omit to sync every selected entity.

Response

Successful Response