Skip to main content
POST
/
consumers
/
{consumer_id}
/
connections
/
{connection_id}
/
enable_datalayer
Enable the datalayer sync for a connection
curl --request POST \
  --url https://api.chift.eu/consumers/{consumer_id}/connections/{connection_id}/enable_datalayer \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "from_date": "2023-12-25",
  "fiscal_years_back": 1,
  "full_history": false
}
'
{
  "message": "The datalayer is not configured on this account.",
  "status": "error"
}

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. Mutually exclusive with fiscal_years_back and full_history.

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. Mutually exclusive with from_date and full_history.

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

Sync the whole history, without a lower date bound. Mutually exclusive with from_date and fiscal_years_back.

Response

Successful Response