Skip to main content
PUT
Write one dashboard preference

Authorizations

Authorization
string
header
required

Send a dashboard session token, an account API key (agt_t), or a command-line credential (afc_) as a Bearer token. Each endpoint lists accepted credential types.

Path Parameters

workspace_id
string
required

Workspace identifier (version 7 universally unique identifier, or UUID).

pref_key
string
required

The preference key.

Response

The whole bag as it now reads, the written key included

Every preference you have set in this workspace.

A write returns the whole set, including the keys it did not change.

prefs
object
required

Every key you have set in this workspace, ordered by key.

Each value is any well-formed JSON value, returned as it was stored. The order is stable between two reads.