Set onboarding state

PUT

/config/onboarding

const url = 'https://demo.evcc.io/api/config/onboarding';
const options = {
  method: 'PUT',
  headers: {cookie: 'auth=<auth>', 'Content-Type': 'application/json'},
  body: '{"done":true,"dismissed":["battery"]}'
};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request PUT \
  --url https://demo.evcc.io/api/config/onboarding \
  --header 'Content-Type: application/json' \
  --cookie auth=<auth> \
  --data '{ "done": true, "dismissed": [ "battery" ] }'

Setup wizard completion and dismissed setup checklist items.

Authorizations

cookieAuth
bearerAuth

Request Body^required

application/json

Setup wizard and checklist state.

object

done

required

Setup wizard was finished or skipped.

boolean

dismissed

required

Dismissed setup checklist items.

Array<string>

Allowed values: battery pv grid loadpoint heater consumer gridImport gridExport co2 solar

Responses

200

Updated onboarding state

application/json

Setup wizard and checklist state.

object

done

required

Setup wizard was finished or skipped.

boolean

dismissed

required

Dismissed setup checklist items.

Array<string>

Allowed values: battery pv grid loadpoint heater consumer gridImport gridExport co2 solar

Example

{
  "dismissed": [
    "battery"
  ]
}

400

Invalid item

Set onboarding state

Authorizations

Request Bodyrequired

Responses

200

Example

400

Request Body^required