Skip to main content
PUT
Choose a consumer's capabilities and modes

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
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
selected
string[]
required

Keys of the main capabilities the consumer turns on. Replaces the previous choice.

Example:
modes
Modes · object

Capability key -> mode key, for the capabilities where the consumer chooses.

Example:
preflight
boolean
default:false

Check the choice without saving it: the answer, or the refusal, is the one saving it would give, so a draft can be shown as it would run.

Response

Successful Response

flowid
string<uuid>
required

The sync's one flow: what enable, disable, the answers' PATCH and the executions take as {flowid}.

enabled
boolean
required

Whether the sync is enabled for this consumer.

capabilities
ConsumerCapabilityItem · object[]
required

The capabilities the account offers.

tables
ConsumerTable · object[]
required

The mapping tables the running capabilities need.

questions
ConsumerQuestion · object[]
required

The questions the running capabilities ask.

completeness
SetupCompleteness · object
required

What stops the sync from being enabled.

connections
SyncConnection · object[]
required

Each vertical of the sync, source first: whether the consumer's connection to it is in place.

latest_preview_id
string<uuid> | null
required

The most recent preview of this consumer sync, if any.

changes
CapabilityChanges · object
required

What the request changed, compared with the setup before it.