Replaces the caller's console interface state.
const url = 'https://example.com/v1/m/consoleviews/ui-state';const options = { method: 'PUT', headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'}, body: '{"pane_widths":{"additionalProperty":1},"show_edition_badge":true,"sidebar":"full"}'};
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://example.com/v1/m/consoleviews/ui-state \ --header 'Authorization: Bearer <token>' \ --header 'Content-Type: application/json' \ --data '{ "pane_widths": { "additionalProperty": 1 }, "show_edition_badge": true, "sidebar": "full" }'Replaces the caller’s console interface state.
Authorizations
Section titled “ Authorizations ”Parameters
Section titled “ Parameters ”Header Parameters
Section titled “ Header Parameters ”Target tenant id; required when the principal can act in more than one tenant.
Request Body required
Section titled “ Request Body required ”The handler decodes one strict JSON document, bounded at 1 MiB.
object
Panel widths in pixels by pane id (lowercase letters, digits and dashes, up to 32 characters; at most 16 panes). Panes named here replace their saved width; a width of 0 puts a pane back to its default; panes not named keep theirs.
object
Show the active commercial edition badge. Defaults to true; omitted fields retain their saved value.
The console sidebar width: full (with labels) or rail (icons).
object
Panel widths in pixels by pane id (lowercase letters, digits and dashes, up to 32 characters; at most 16 panes). Panes named here replace their saved width; a width of 0 puts a pane back to its default; panes not named keep theirs.
object
Show the active commercial edition badge. Defaults to true; omitted fields retain their saved value.
The console sidebar width: full (with labels) or rail (icons).
object
Panel widths in pixels by pane id (lowercase letters, digits and dashes, up to 32 characters; at most 16 panes). Panes named here replace their saved width; a width of 0 puts a pane back to its default; panes not named keep theirs.
object
Show the active commercial edition badge. Defaults to true; omitted fields retain their saved value.
The console sidebar width: full (with labels) or rail (icons).
Responses
Section titled “ Responses ”OK
object
Example generated
{}Bad request
object
Example generated
{}Unauthenticated
object
Example generated
{}Forbidden
object
Example generated
{}Not found
object
Example generated
{}Conflict / setup required
object
Example generated
{}Rate limited
object
Example generated
{}