Skip to main content
PUT

Authorizations

Authorization
string
header
required

Obtain a token via the CLI auth flow (POST /v1/auth/sessions) or GitHub OAuth

Path Parameters

workspace_id
string<uuid>
required

Workspace identifier (Universally Unique Identifier version 7)

pref_key
enum<string>
required

The preference to write. Must be a key the dashboard declares.

Available options:
getting_started_dismissed,
getting_started_collapsed,
getting_started_cli_ticked

Body

application/json

The preference value. Any JSON value up to 1 KiB.

The body is of type any.

Response

The caller's preference bag, including the written key

prefs
object
required