set-active-theme
dci set-active-theme [body]
Sets the theme active for the authenticated user. Send the reserved
sentinel themeId: "default" to clear the active theme and fall back
to the built-in default. Returns the updated active theme.
Pass the request body as name: value arguments or pipe JSON on stdin — see Command structure.
Examples
# Activate a custom theme by ID (from `dci list-custom-themes`) for the authenticated user.
dci set-active-theme themeId: <custom-theme-id>
# Clear the active theme and fall back to the built-in default.
dci set-active-theme themeId: default
The updated active theme is returned; `dci get-active-theme` confirms it.
Request
Content-Type: application/json
| Field | Type | Required | Description |
|---|---|---|---|
themeId | string | yes | Identifier of the theme to activate. Send the reserved sentinel "default" to clear the active theme and fall back to the built-in default. Default: "default". |
Raw JSON schema
{
"type": "object",
"required": [
"themeId"
],
"description": "Request body for setting the active custom or preset theme for the authenticated user.",
"properties": {
"themeId": {
"type": "string",
"default": "default",
"description": "Identifier of the theme to activate. Send the reserved sentinel\n`\"default\"` to clear the active theme and fall back to the built-in\ndefault."
}
}
}
Output
OK - Active theme updated.
By default dci renders the result as a table. Use --output json to get the full structure described below — see Output formats.
| Field | Type | Description |
|---|---|---|
themeId | string | Identifier of the active theme. The reserved sentinel "default" is returned when the user is using the built-in default (no custom or preset theme stored). Default: "default". |
Raw JSON schema
{
"type": "object",
"required": [
"themeId"
],
"description": "The theme currently active for the authenticated user.",
"properties": {
"themeId": {
"type": "string",
"default": "default",
"description": "Identifier of the active theme. The reserved sentinel `\"default\"` is\nreturned when the user is using the built-in default (no custom or\npreset theme stored)."
}
}
}
Errors
On failure, dci prints a single error message — with a hint when one is available — and exits with a typed code your scripts can branch on. See Errors and exit codes for the full contract.
HTTP status to exit code mapping
| HTTP status | Exit code | Error code | Meaning |
|---|---|---|---|
| 400 | 30 | VALIDATION_ERROR | The arguments or request body were rejected. Review the command's flags and payload. |
| 401 | 10 | AUTHENTICATION_FAILED | Not signed in, or the API token is invalid. Run dci login or check DCI_API_KEY. |
| 403 | 11 | PERMISSION_DENIED | The DoiT user or the active customer context does not have access. |
| 404 | 20 | RESOURCE_NOT_FOUND | The requested resource does not exist. Check the identifier argument. |
Related
- get-active-theme — Get the active theme
- list-custom-themes — List custom themes
- get-custom-theme — Retrieve a custom theme
- create-custom-theme — Create a custom theme
- API reference: PUT /analytics/v1/settings/active-theme
Aliases: setactivetheme