Sign in
Organizations

Update an organization

Update an existing organization identified by its ID.

Only provided fields will be updated.

patch/organizations/{organization_id}

Path parameters

organization_idstring required

Request body

namestring nullable

New name of the organization

nav_configobject nullable

Per-organization nav config: { '<key>': { 'show': bool, 'disabled': bool, 'badgeLabel': str | None, 'badgeTooltip': str | None } }

plotting_preferencesstring nullable

Free-text markdown describing how the agent should format plots for this organization. Injected into the agent's system prompt.

Response

Successful Response

idstring required
namestring required
slugstring required
nav_configobject nullable

Per-organization nav config: { '<key>': { 'show': bool, 'disabled': bool, 'badgeLabel': str | None, 'badgeTooltip': str | None } }

plotting_preferencesstring nullable

Free-text markdown describing how this organization wants the battery agent to format plots; injected into the agent's system prompt each turn. None means not set (nothing is injected).

logo_pathstring nullable

Storage object path of the light-mode organization logo, or None when unset. Not a URL: the bucket is private, so clients fetch the image from GET /organizations/{id}/logo, which returns a signed URL. Set via POST /organizations/{id}/logo, not via PATCH.

logo_path_darkstring nullable

Storage object path of the dark-mode organization logo, or None when unset. Optional: dark mode falls back to logo_path when this is None, and light mode falls back to this when logo_path is None. Set via POST /organizations/{id}/logo?variant=dark.

created_atstring date-time nullable

Timestamp of creation

updated_atstring date-time nullable

Timestamp of last update

Changes