Skip to main content
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>",
  "skipOnboarding": true,
  "fullEmbedEnabled": true,
  "embedAllowedOrigins": [
    "<string>"
  ]
}
'
{
  "data": {
    "id": "<string>",
    "name": "<string>",
    "slug": "<string>",
    "customAiContext": "<string>",
    "onboardingStatus": "STARTED",
    "fullEmbedEnabled": true,
    "embedAllowedOrigins": [
      "<string>"
    ],
    "jwtSecret": "<string>"
  }
}

Authorizations

​
Authorization
string
header
required

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

Path Parameters

​
id
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

​
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)

Response

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

​
data
object
required