Organizations

Update an organization

Updates an existing organization. Requires admin access.

patch/api/public/organizations/{id}

Request

  • Base URL
    https://charts.basedash.com
  • Auth
    HTTP bearer

Path parameters

idstring required

Organization ID

Query parameters

include'jwtSecret'

Include sensitive fields in the response. Use jwtSecret to include the embed JWT secret.

Request body

namestring

Name of the organization

customAiContextstring

Custom context for AI features

insightsAiContextstring nullable

Custom context for AI-generated insights

skipOnboardingboolean

Skip onboarding flow

fullEmbedEnabledboolean

Enable full embed functionality

embedAllowedOriginsstring[]

Allowed origins for embedding. Supports exact URLs (https://example.com) and wildcard patterns (https://*.example.com)

billingAccountIdstring

Billing account to attach the new organization to. Requires admin access to the billing account owner organization. The organization is billed through the account and treated as a paid (GROWTH) organization with no trial limitations.

isBillableboolean

[Self-hosted] Controls whether the organization is billable. Defaults to true. Relevant for self-hosted deployments where billing gates certain features. When false, the organization will not be counted towards billable usage and will have a limited set of features. When true, the organization will be counted towards billable usage (after a 14-day trial) and will have access to all features.

insightsEnabledboolean

Enable automated insights generation for this organization. Defaults to true.

modelsEnabledboolean

Show Models in the product and allow creating or editing models. Defaults to true.

automationNotificationsVisibleboolean

When true, the Slack and email notifications section is shown on the automation page. When false, that section is hidden. Does not affect existing notification delivery or the automations API. Defaults to true.

insightsFrequency'DAILY' | 'WEEKDAYS' | 'WEEKLY' | 'MONTHLY' | 'NEVER'

How often automated insights are generated. Defaults to DAILY.

insightsPreferredDayOfWeekinteger

Preferred day of week for WEEKLY insights. 0 is Sunday.

insightsPreferredDayOfMonthinteger

Preferred day of month for MONTHLY insights.

allowOnDemandAiUsageboolean

Allow users in the organization to continue using AI beyond included monthly AI credits. For an organization attached to a billing account, this controls access beyond the account's pooled included credits for this tenant; the billing account setting still applies to the whole account. Defaults to true.

aiUsageOverageLimitCentsinteger nullable

Maximum AI usage overage for the organization in cents. For an organization attached to a billing account, this is an absolute cap on that organization’s usage during the account billing period, not a share of the pooled credits. The billing account cap also applies. Null means no tenant limit. Only applies when on-demand AI usage is enabled.

billingEmailstring email

Email address used for billing communication and invoices

sendInvoicesToBillingEmailboolean

Whether paid invoices are emailed to the billing email address

defaultDashboardAccessAudience'EVERYONE' | 'CREATOR_ONLY' | 'CREATOR_GROUPS'

Default audience for newly created dashboards

defaultDashboardAccessLevel'MANAGE' | 'EDIT' | 'VIEW'

Default permission level for the audience. Creator always gets MANAGE regardless.

defaultChatAccessAudience'EVERYONE' | 'CREATOR_ONLY' | 'CREATOR_GROUPS'

Default audience for newly created chats

defaultChatAccessLevel'MANAGE' | 'EDIT' | 'VIEW'

Default permission level for new chats. Creator always gets MANAGE regardless.

defaultAutomationAccessAudience'EVERYONE' | 'CREATOR_ONLY' | 'CREATOR_GROUPS'

Default audience for newly created automations

defaultAutomationAccessLevel'MANAGE' | 'EDIT' | 'VIEW'

Default permission level for new automations. Creator always gets MANAGE regardless.

Response

Organization updated successfully. The jwtSecret field is only included when explicitly requested via ?include=jwtSecret.

Changes

No recorded changes to this operation across all 1 revision of this API.