Files
dashback/docs/api/routes/companysetting/set.md
2026-09-30 19:29:13 +02:00

57 lines
1.2 KiB
Markdown

# `PUT /company/setting/{key}`
Protected. Requires a valid session cookie (`credentials: 'include'`).
Upsert company setting
Sets (upserts) a company setting for the selected company.
Only a fixed allow-list of keys can be set: `ui.theme`, `keys.tavily`,
`keys.openrouter`, `keys.serper`, `labelprinter.addr`, `labelprinter.type`.
## Path parameters
| Param | Required | Type | Description |
|-------|----------|------|-------------|
| `key` | yes | string | |
## Body (JSON)
| Field | Required | Type | Description |
|-------|----------|------|-------------|
| `value` | yes | string | |
| `frontend` | no | boolean | |
```json
{
"value": "dark",
"frontend": true
}
```
## Response `200`
Upserted company setting
```json
{
"setting": {
"key": "…",
"value": "…"
}
}
```
## Errors
| Status | Description |
|--------|-------------|
| 400 | Invalid setting, invalid key, or no company selected — `{"error":"…"}` |
| 401 | Unauthorized — `{"error":"…"}` |
| 403 | Not authorized — `{"error":"…"}` |
| 404 | Company not found — `{"error":"…"}` |
---
_Generated from `@openapi` JSDoc. Do not edit by hand — run `npm run docs:api`._