Update an organization

curl --request PATCH \
  --url https://charts.basedash.com/api/public/organizations/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "customAiContext": "<string>",
  "insightsAiContext": "<string>",
  "skipOnboarding": true,
  "fullEmbedEnabled": true,
  "embedAllowedOrigins": [
    "<string>"
  ],
  "billingAccountId": "<string>",
  "isBillable": true,
  "insightsEnabled": true,
  "automationNotificationsVisible": true,
  "insightsPreferredDayOfWeek": 3,
  "insightsPreferredDayOfMonth": 16,
  "allowOnDemandAiUsage": true,
  "aiUsageOverageLimitCents": 123,
  "billingEmail": "jsmith@example.com",
  "sendInvoicesToBillingEmail": true
}
'

import requests

url = "https://charts.basedash.com/api/public/organizations/{id}"

payload = {
    "name": "<string>",
    "customAiContext": "<string>",
    "insightsAiContext": "<string>",
    "skipOnboarding": True,
    "fullEmbedEnabled": True,
    "embedAllowedOrigins": ["<string>"],
    "billingAccountId": "<string>",
    "isBillable": True,
    "insightsEnabled": True,
    "automationNotificationsVisible": True,
    "insightsPreferredDayOfWeek": 3,
    "insightsPreferredDayOfMonth": 16,
    "allowOnDemandAiUsage": True,
    "aiUsageOverageLimitCents": 123,
    "billingEmail": "jsmith@example.com",
    "sendInvoicesToBillingEmail": True
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.patch(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PATCH',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    name: '<string>',
    customAiContext: '<string>',
    insightsAiContext: '<string>',
    skipOnboarding: true,
    fullEmbedEnabled: true,
    embedAllowedOrigins: ['<string>'],
    billingAccountId: '<string>',
    isBillable: true,
    insightsEnabled: true,
    automationNotificationsVisible: true,
    insightsPreferredDayOfWeek: 3,
    insightsPreferredDayOfMonth: 16,
    allowOnDemandAiUsage: true,
    aiUsageOverageLimitCents: 123,
    billingEmail: 'jsmith@example.com',
    sendInvoicesToBillingEmail: true
  })
};

fetch('https://charts.basedash.com/api/public/organizations/{id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://charts.basedash.com/api/public/organizations/{id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PATCH",
  CURLOPT_POSTFIELDS => json_encode([
    'name' => '<string>',
    'customAiContext' => '<string>',
    'insightsAiContext' => '<string>',
    'skipOnboarding' => true,
    'fullEmbedEnabled' => true,
    'embedAllowedOrigins' => [
        '<string>'
    ],
    'billingAccountId' => '<string>',
    'isBillable' => true,
    'insightsEnabled' => true,
    'automationNotificationsVisible' => true,
    'insightsPreferredDayOfWeek' => 3,
    'insightsPreferredDayOfMonth' => 16,
    'allowOnDemandAiUsage' => true,
    'aiUsageOverageLimitCents' => 123,
    'billingEmail' => 'jsmith@example.com',
    'sendInvoicesToBillingEmail' => true
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://charts.basedash.com/api/public/organizations/{id}"

	payload := strings.NewReader("{\n  \"name\": \"<string>\",\n  \"customAiContext\": \"<string>\",\n  \"insightsAiContext\": \"<string>\",\n  \"skipOnboarding\": true,\n  \"fullEmbedEnabled\": true,\n  \"embedAllowedOrigins\": [\n    \"<string>\"\n  ],\n  \"billingAccountId\": \"<string>\",\n  \"isBillable\": true,\n  \"insightsEnabled\": true,\n  \"automationNotificationsVisible\": true,\n  \"insightsPreferredDayOfWeek\": 3,\n  \"insightsPreferredDayOfMonth\": 16,\n  \"allowOnDemandAiUsage\": true,\n  \"aiUsageOverageLimitCents\": 123,\n  \"billingEmail\": \"jsmith@example.com\",\n  \"sendInvoicesToBillingEmail\": true\n}")

	req, _ := http.NewRequest("PATCH", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.patch("https://charts.basedash.com/api/public/organizations/{id}")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"<string>\",\n  \"customAiContext\": \"<string>\",\n  \"insightsAiContext\": \"<string>\",\n  \"skipOnboarding\": true,\n  \"fullEmbedEnabled\": true,\n  \"embedAllowedOrigins\": [\n    \"<string>\"\n  ],\n  \"billingAccountId\": \"<string>\",\n  \"isBillable\": true,\n  \"insightsEnabled\": true,\n  \"automationNotificationsVisible\": true,\n  \"insightsPreferredDayOfWeek\": 3,\n  \"insightsPreferredDayOfMonth\": 16,\n  \"allowOnDemandAiUsage\": true,\n  \"aiUsageOverageLimitCents\": 123,\n  \"billingEmail\": \"jsmith@example.com\",\n  \"sendInvoicesToBillingEmail\": true\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://charts.basedash.com/api/public/organizations/{id}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"name\": \"<string>\",\n  \"customAiContext\": \"<string>\",\n  \"insightsAiContext\": \"<string>\",\n  \"skipOnboarding\": true,\n  \"fullEmbedEnabled\": true,\n  \"embedAllowedOrigins\": [\n    \"<string>\"\n  ],\n  \"billingAccountId\": \"<string>\",\n  \"isBillable\": true,\n  \"insightsEnabled\": true,\n  \"automationNotificationsVisible\": true,\n  \"insightsPreferredDayOfWeek\": 3,\n  \"insightsPreferredDayOfMonth\": 16,\n  \"allowOnDemandAiUsage\": true,\n  \"aiUsageOverageLimitCents\": 123,\n  \"billingEmail\": \"jsmith@example.com\",\n  \"sendInvoicesToBillingEmail\": true\n}"

response = http.request(request)
puts response.read_body

{
  "data": {
    "id": "<string>",
    "name": "<string>",
    "slug": "<string>",
    "customAiContext": "<string>",
    "insightsAiContext": "<string>",
    "onboardingStatus": "STARTED",
    "fullEmbedEnabled": true,
    "embedAllowedOrigins": [
      "<string>"
    ],
    "billingAccountId": "<string>",
    "isBillable": true,
    "insightsEnabled": true,
    "automationNotificationsVisible": true,
    "insightsFrequency": "DAILY",
    "insightsPreferredDayOfWeek": 123,
    "insightsPreferredDayOfMonth": 123,
    "allowOnDemandAiUsage": true,
    "aiUsageOverageLimitCents": 123,
    "billingEmail": "<string>",
    "sendInvoicesToBillingEmail": true,
    "defaultDashboardAccessAudience": "EVERYONE",
    "defaultDashboardAccessLevel": "MANAGE",
    "defaultChatAccessAudience": "EVERYONE",
    "defaultChatAccessLevel": "MANAGE",
    "defaultAutomationAccessAudience": "EVERYONE",
    "defaultAutomationAccessLevel": "MANAGE",
    "trialEndsAt": "<string>",
    "jwtSecret": "<string>"
  }
}

{
  "error": {
    "title": "<string>",
    "detail": "<string>"
  }
}

{
  "error": {
    "title": "<string>",
    "detail": "<string>"
  }
}

{
  "error": {
    "title": "<string>",
    "detail": "<string>"
  }
}

{
  "error": {
    "title": "RateLimitExceeded",
    "detail": "<string>",
    "retryAfterMs": 123
  }
}

{
  "error": {
    "title": "<string>",
    "detail": "<string>"
  }
}

PATCH

api

public

organizations

{id}

Update an organization

curl --request PATCH \
  --url https://charts.basedash.com/api/public/organizations/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "customAiContext": "<string>",
  "insightsAiContext": "<string>",
  "skipOnboarding": true,
  "fullEmbedEnabled": true,
  "embedAllowedOrigins": [
    "<string>"
  ],
  "billingAccountId": "<string>",
  "isBillable": true,
  "insightsEnabled": true,
  "automationNotificationsVisible": true,
  "insightsPreferredDayOfWeek": 3,
  "insightsPreferredDayOfMonth": 16,
  "allowOnDemandAiUsage": true,
  "aiUsageOverageLimitCents": 123,
  "billingEmail": "jsmith@example.com",
  "sendInvoicesToBillingEmail": true
}
'

import requests

url = "https://charts.basedash.com/api/public/organizations/{id}"

payload = {
    "name": "<string>",
    "customAiContext": "<string>",
    "insightsAiContext": "<string>",
    "skipOnboarding": True,
    "fullEmbedEnabled": True,
    "embedAllowedOrigins": ["<string>"],
    "billingAccountId": "<string>",
    "isBillable": True,
    "insightsEnabled": True,
    "automationNotificationsVisible": True,
    "insightsPreferredDayOfWeek": 3,
    "insightsPreferredDayOfMonth": 16,
    "allowOnDemandAiUsage": True,
    "aiUsageOverageLimitCents": 123,
    "billingEmail": "jsmith@example.com",
    "sendInvoicesToBillingEmail": True
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.patch(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PATCH',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    name: '<string>',
    customAiContext: '<string>',
    insightsAiContext: '<string>',
    skipOnboarding: true,
    fullEmbedEnabled: true,
    embedAllowedOrigins: ['<string>'],
    billingAccountId: '<string>',
    isBillable: true,
    insightsEnabled: true,
    automationNotificationsVisible: true,
    insightsPreferredDayOfWeek: 3,
    insightsPreferredDayOfMonth: 16,
    allowOnDemandAiUsage: true,
    aiUsageOverageLimitCents: 123,
    billingEmail: 'jsmith@example.com',
    sendInvoicesToBillingEmail: true
  })
};

fetch('https://charts.basedash.com/api/public/organizations/{id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://charts.basedash.com/api/public/organizations/{id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PATCH",
  CURLOPT_POSTFIELDS => json_encode([
    'name' => '<string>',
    'customAiContext' => '<string>',
    'insightsAiContext' => '<string>',
    'skipOnboarding' => true,
    'fullEmbedEnabled' => true,
    'embedAllowedOrigins' => [
        '<string>'
    ],
    'billingAccountId' => '<string>',
    'isBillable' => true,
    'insightsEnabled' => true,
    'automationNotificationsVisible' => true,
    'insightsPreferredDayOfWeek' => 3,
    'insightsPreferredDayOfMonth' => 16,
    'allowOnDemandAiUsage' => true,
    'aiUsageOverageLimitCents' => 123,
    'billingEmail' => 'jsmith@example.com',
    'sendInvoicesToBillingEmail' => true
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://charts.basedash.com/api/public/organizations/{id}"

	payload := strings.NewReader("{\n  \"name\": \"<string>\",\n  \"customAiContext\": \"<string>\",\n  \"insightsAiContext\": \"<string>\",\n  \"skipOnboarding\": true,\n  \"fullEmbedEnabled\": true,\n  \"embedAllowedOrigins\": [\n    \"<string>\"\n  ],\n  \"billingAccountId\": \"<string>\",\n  \"isBillable\": true,\n  \"insightsEnabled\": true,\n  \"automationNotificationsVisible\": true,\n  \"insightsPreferredDayOfWeek\": 3,\n  \"insightsPreferredDayOfMonth\": 16,\n  \"allowOnDemandAiUsage\": true,\n  \"aiUsageOverageLimitCents\": 123,\n  \"billingEmail\": \"jsmith@example.com\",\n  \"sendInvoicesToBillingEmail\": true\n}")

	req, _ := http.NewRequest("PATCH", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.patch("https://charts.basedash.com/api/public/organizations/{id}")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"<string>\",\n  \"customAiContext\": \"<string>\",\n  \"insightsAiContext\": \"<string>\",\n  \"skipOnboarding\": true,\n  \"fullEmbedEnabled\": true,\n  \"embedAllowedOrigins\": [\n    \"<string>\"\n  ],\n  \"billingAccountId\": \"<string>\",\n  \"isBillable\": true,\n  \"insightsEnabled\": true,\n  \"automationNotificationsVisible\": true,\n  \"insightsPreferredDayOfWeek\": 3,\n  \"insightsPreferredDayOfMonth\": 16,\n  \"allowOnDemandAiUsage\": true,\n  \"aiUsageOverageLimitCents\": 123,\n  \"billingEmail\": \"jsmith@example.com\",\n  \"sendInvoicesToBillingEmail\": true\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://charts.basedash.com/api/public/organizations/{id}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"name\": \"<string>\",\n  \"customAiContext\": \"<string>\",\n  \"insightsAiContext\": \"<string>\",\n  \"skipOnboarding\": true,\n  \"fullEmbedEnabled\": true,\n  \"embedAllowedOrigins\": [\n    \"<string>\"\n  ],\n  \"billingAccountId\": \"<string>\",\n  \"isBillable\": true,\n  \"insightsEnabled\": true,\n  \"automationNotificationsVisible\": true,\n  \"insightsPreferredDayOfWeek\": 3,\n  \"insightsPreferredDayOfMonth\": 16,\n  \"allowOnDemandAiUsage\": true,\n  \"aiUsageOverageLimitCents\": 123,\n  \"billingEmail\": \"jsmith@example.com\",\n  \"sendInvoicesToBillingEmail\": true\n}"

response = http.request(request)
puts response.read_body

{
  "data": {
    "id": "<string>",
    "name": "<string>",
    "slug": "<string>",
    "customAiContext": "<string>",
    "insightsAiContext": "<string>",
    "onboardingStatus": "STARTED",
    "fullEmbedEnabled": true,
    "embedAllowedOrigins": [
      "<string>"
    ],
    "billingAccountId": "<string>",
    "isBillable": true,
    "insightsEnabled": true,
    "automationNotificationsVisible": true,
    "insightsFrequency": "DAILY",
    "insightsPreferredDayOfWeek": 123,
    "insightsPreferredDayOfMonth": 123,
    "allowOnDemandAiUsage": true,
    "aiUsageOverageLimitCents": 123,
    "billingEmail": "<string>",
    "sendInvoicesToBillingEmail": true,
    "defaultDashboardAccessAudience": "EVERYONE",
    "defaultDashboardAccessLevel": "MANAGE",
    "defaultChatAccessAudience": "EVERYONE",
    "defaultChatAccessLevel": "MANAGE",
    "defaultAutomationAccessAudience": "EVERYONE",
    "defaultAutomationAccessLevel": "MANAGE",
    "trialEndsAt": "<string>",
    "jwtSecret": "<string>"
  }
}

{
  "error": {
    "title": "<string>",
    "detail": "<string>"
  }
}

{
  "error": {
    "title": "<string>",
    "detail": "<string>"
  }
}

{
  "error": {
    "title": "<string>",
    "detail": "<string>"
  }
}

{
  "error": {
    "title": "RateLimitExceeded",
    "detail": "<string>",
    "retryAfterMs": 123
  }
}

{
  "error": {
    "title": "<string>",
    "detail": "<string>"
  }
}

Authorizations

Authorization

string

header

required

API key authentication using Bearer token format: Bearer <basedash_api_key>

Path Parameters

string

required

Organization ID

Query Parameters

include

enum<string>

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

Available options:

jwtSecret

Body

application/json

name

string

Name of the organization

Minimum string length: 1

customAiContext

string

Custom context for AI features

insightsAiContext

string | null

Custom context for AI-generated insights

skipOnboarding

boolean

Skip onboarding flow

fullEmbedEnabled

boolean

Enable full embed functionality

embedAllowedOrigins

string[]

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

billingAccountId

string

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.

isBillable

boolean

[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.

insightsEnabled

boolean

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

automationNotificationsVisible

boolean

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

enum<string>

How often automated insights are generated. Defaults to DAILY.

Available options:

DAILY,

WEEKDAYS,

WEEKLY,

MONTHLY,

NEVER

insightsPreferredDayOfWeek

integer

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

Required range: 0 <= x <= 6

insightsPreferredDayOfMonth

integer

Preferred day of month for MONTHLY insights.

Required range: 1 <= x <= 31

allowOnDemandAiUsage

boolean

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.

aiUsageOverageLimitCents

integer | null

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.

Required range: x <= 2147483647

billingEmail

string<email>

Email address used for billing communication and invoices

sendInvoicesToBillingEmail

boolean

Whether paid invoices are emailed to the billing email address

defaultDashboardAccessAudience

enum<string>

Default audience for newly created dashboards

Available options:

EVERYONE,

CREATOR_ONLY,

CREATOR_GROUPS

defaultDashboardAccessLevel

enum<string>

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

Available options:

MANAGE,

EDIT,

VIEW

defaultChatAccessAudience

enum<string>

Default audience for newly created chats

Available options:

EVERYONE,

CREATOR_ONLY,

CREATOR_GROUPS

defaultChatAccessLevel

enum<string>

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

Available options:

MANAGE,

EDIT,

VIEW

defaultAutomationAccessAudience

enum<string>

Default audience for newly created automations

Available options:

EVERYONE,

CREATOR_ONLY,

CREATOR_GROUPS

defaultAutomationAccessLevel

enum<string>

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

Available options:

MANAGE,

EDIT,

VIEW

Response

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

data

object

required

Show child attributes

⌘I

Overview

Endpoints

Update an organization

Authorizations

Path Parameters

Query Parameters

Body

Response