Skip to main content
PATCH
/
api
/
workspace
/
{workspaceId}
/
settings
Update workspace settings
curl --request PATCH \
  --url https://app.alana.shopping/api/workspace/{workspaceId}/settings \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "Acme Corp Updated",
  "industry": "retail",
  "company_size": "51-200",
  "allowed_email_domains": [
    "acme.com"
  ]
}
'
{
  "id": "<string>",
  "name": "<string>",
  "slug": "<string>",
  "owner_id": "<string>",
  "plan": "standard",
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "logo_url": "<string>",
  "industry": "retail",
  "company_size": "1-10",
  "allowed_email_domains": [
    "<string>"
  ],
  "ai_training_opt_out": true,
  "onboarding_completed": true,
  "onboarding_step": 123
}

Authorizations

​
Authorization
string
header
required

Bearer token authentication. Obtain a token via the authentication endpoint and include it in the Authorization header: Authorization: Bearer <token>

Path Parameters

​
workspaceId
string
required

The workspace ID

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