Skip to main content
PATCH
Update reporting database sync settings

Authorizations

Authorization
string
header
required

A Bearer token for a company admin user. A company API token with no user behind it is refused with 401.

Body

application/json

Either or both fields. Only the keys sent are applied, so toggling enabled never resets the interval.

enabled
boolean

Turn the sync on or off. Must be a real boolean; "yes" and 1 are rejected.

Example:

true

sync_interval_hours
integer

Hours between scheduled refreshes. Must be a positive integer; there is no upper bound.

Required range: x >= 1
Example:

12

Response

The reporting database settings after the change

The Fluid half of the page, after a change.

fluid
object
required

The company's Fluid reporting database contract and the state the pipeline last reported for it.

status
integer
required

The HTTP status code echoed in the envelope.

Example:

200

meta
object
required

Request metadata included in every settings response.