Skip to main content

Settings

The organization's general settings: name, support e-mail, time zone and the record rules (allow creating customers and portal users, editing e-mails and documents, upper-case names).

CommandHTTPDescription
settings listGET /v1/settingsGet organization settings
settings updatePUT /v1/settingsUpdate organization settings

Examples​

--params carries query, path and header parameters (id, page, filters, X-Workspace-Id); --json carries the request body; --fields limits which fields come back — worth using on every list/get to save context. See Global flags for the full reference.

# Get organization settings
kobana dashboards settings list

# Update organization settings
kobana dashboards settings update \
--json '{"timezone": "America/Sao_Paulo", "support_email": "suporte@example.com"}'

Next steps​