Skip to main content
PATCH
Update workspace settings

Authorizations

Authorization
string
header
required

Bearer token authentication via Auth0. Users authenticate through Auth0 Universal Login. Include the access token in the Authorization header: Authorization: Bearer <token>

Path Parameters

workspaceId
string
required

The workspace ID

Pattern: ^ws_[a-z0-9]+$

Body

application/json
name
string

Workspace display name

Required string length: 1 - 255
logo_url
string<uri> | null

URL to workspace logo

industry
enum<string> | null
Available options:
retail,
manufacturing,
technology,
healthcare,
finance,
media,
other
company_size
enum<string> | null
Available options:
1-10,
11-50,
51-200,
201-500,
500+
allowed_email_domains
string<email>[]

Domains allowed for member invitations

ai_training_opt_out
boolean

Opt out of AI model training

Response

Workspace settings updated successfully

id
string
required

Unique workspace identifier

name
string
required

Workspace display name

slug
string
required

URL-friendly workspace slug

owner_id
string
required

User ID of workspace owner

plan
enum<string>
required
Available options:
standard,
pro,
business,
enterprise
created_at
string<date-time>
required
updated_at
string<date-time>
required
logo_url
string<uri> | null
role
enum<string> | null

The calling user's role in this workspace. Populated by GET /api/workspaces; null/absent when the workspace object comes from other endpoints.

Available options:
owner,
admin,
editor,
moderator,
analyst,
viewer,
null
industry
enum<string> | null
Available options:
retail,
manufacturing,
technology,
healthcare,
finance,
media,
other
company_size
enum<string> | null
Available options:
1-10,
11-50,
51-200,
201-500,
500+
allowed_email_domains
string[]

Email domains allowed for member invitations

ai_training_opt_out
boolean

Whether workspace data is excluded from AI training

onboarding_completed
boolean
onboarding_step
integer
Last modified on February 16, 2026