Skip to main content
Update an organization

Path Parameters

organization_id
string
required

Body

application/json

Model for updating an existing organization. All fields are optional.

name
string | null

New name of the organization

usage_limit

Monthly usage limit

nav_config
Nav Config · object | null

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

plotting_preferences
string | null

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

Maximum string length: 20000

Response

Successful Response

Pydantic model for an organization.

id
string
required
name
string
required
slug
string
required
usage_limit

Monthly usage limit

nav_config
Nav Config · object | null

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

plotting_preferences
string | null

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_path
string | null

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

user_organization_roles
UserOrganizationRole · object[] | null

List of user organization roles

created_at
string<date-time> | null

Timestamp of creation

updated_at
string<date-time> | null

Timestamp of last update