Skip to main content
PUT
Choose which capabilities your consumers are offered

Authorizations

Authorization
string
header
required

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

Path Parameters

syncid
string<uuid>
required

Query Parameters

language
string | null

ISO 639-1 code of the language of the texts (en, fr, nl, de, es; any case), falling back to English. Without it, translation keys.

Body

application/json
cron
string | null
required

When the sync runs for each consumer that enabled it, as a cron expression; it can always be started by hand. Null: only by hand.

Example:

"0 * * * *"

offered
Offered · object

Capability key -> offered. A capability left out keeps its value.

Example:
default_modes
Default Modes · object | null

Capability key -> mode key. Replaces every default mode when given; leave it out to keep them.

Response

Successful Response

What the account offers its consumers. Whether a capability is available depends on each consumer's connections.

capabilities
SyncCapabilityItem · object[]
required

Every capability of the sync, offered or not.

cron
string | null
required

When the sync runs for each consumer that enabled it, as a cron expression. Null: it runs only when started by hand.

Example:

"0 * * * *"