Mark setup wizard completed

POST

/setup/complete

const url = 'https://example.com/api/v1/setup/complete';
const options = {method: 'POST'};

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

curl --request POST \
  --url https://example.com/api/v1/setup/complete

Marks the setup wizard completed.

Terminal and idempotent by design: unlike GET/PATCH /state, this endpoint does not require the wizard to still be in progress, so a repeated call succeeds instead of rejecting once setup is already completed.

Responses

200

Wizard marked completed

application/json

object

wizard

required

object

completed

required

Whether the wizard has been marked completed

boolean

dismissedAt

required

Timestamp the wizard was dismissed, or null if never dismissed

string format: date-time

nullable

currentStep

required

Ordered setup wizard step

string

Allowed values: welcome connect-arr link-database select-profiles preview-sync done

Example

{
  "wizard": {
    "currentStep": "welcome"
  }
}