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"
]
}
'import requests
url = "https://app.alana.shopping/api/workspace/{workspaceId}/settings"
payload = {
"name": "Acme Corp Updated",
"industry": "retail",
"company_size": "51-200",
"allowed_email_domains": ["acme.com"]
}
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: 'Acme Corp Updated',
industry: 'retail',
company_size: '51-200',
allowed_email_domains: ['acme.com']
})
};
fetch('https://app.alana.shopping/api/workspace/{workspaceId}/settings', 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://app.alana.shopping/api/workspace/{workspaceId}/settings",
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' => 'Acme Corp Updated',
'industry' => 'retail',
'company_size' => '51-200',
'allowed_email_domains' => [
'acme.com'
]
]),
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://app.alana.shopping/api/workspace/{workspaceId}/settings"
payload := strings.NewReader("{\n \"name\": \"Acme Corp Updated\",\n \"industry\": \"retail\",\n \"company_size\": \"51-200\",\n \"allowed_email_domains\": [\n \"acme.com\"\n ]\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://app.alana.shopping/api/workspace/{workspaceId}/settings")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"Acme Corp Updated\",\n \"industry\": \"retail\",\n \"company_size\": \"51-200\",\n \"allowed_email_domains\": [\n \"acme.com\"\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.alana.shopping/api/workspace/{workspaceId}/settings")
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\": \"Acme Corp Updated\",\n \"industry\": \"retail\",\n \"company_size\": \"51-200\",\n \"allowed_email_domains\": [\n \"acme.com\"\n ]\n}"
response = http.request(request)
puts response.read_body{
"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>",
"role": "owner",
"industry": "retail",
"company_size": "1-10",
"allowed_email_domains": [
"<string>"
],
"ai_training_opt_out": true,
"onboarding_completed": true,
"onboarding_step": 123
}{
"error": "INVALID_REQUEST",
"details": {
"field": "email",
"message": "Invalid email format"
}
}{
"error": "UNAUTHORIZED",
"details": {
"message": "Missing or invalid authentication token"
}
}{
"error": "FORBIDDEN",
"details": {
"message": "User does not have permission to access this resource"
}
}{
"error": "NOT_FOUND",
"details": {
"message": "Resource not found"
}
}{
"error": "INTERNAL_SERVER_ERROR",
"details": {
"message": "An unexpected error occurred"
}
}Update Workspace Settings
Update workspace configuration, name, allowed domains, and preferences
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"
]
}
'import requests
url = "https://app.alana.shopping/api/workspace/{workspaceId}/settings"
payload = {
"name": "Acme Corp Updated",
"industry": "retail",
"company_size": "51-200",
"allowed_email_domains": ["acme.com"]
}
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: 'Acme Corp Updated',
industry: 'retail',
company_size: '51-200',
allowed_email_domains: ['acme.com']
})
};
fetch('https://app.alana.shopping/api/workspace/{workspaceId}/settings', 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://app.alana.shopping/api/workspace/{workspaceId}/settings",
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' => 'Acme Corp Updated',
'industry' => 'retail',
'company_size' => '51-200',
'allowed_email_domains' => [
'acme.com'
]
]),
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://app.alana.shopping/api/workspace/{workspaceId}/settings"
payload := strings.NewReader("{\n \"name\": \"Acme Corp Updated\",\n \"industry\": \"retail\",\n \"company_size\": \"51-200\",\n \"allowed_email_domains\": [\n \"acme.com\"\n ]\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://app.alana.shopping/api/workspace/{workspaceId}/settings")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"Acme Corp Updated\",\n \"industry\": \"retail\",\n \"company_size\": \"51-200\",\n \"allowed_email_domains\": [\n \"acme.com\"\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.alana.shopping/api/workspace/{workspaceId}/settings")
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\": \"Acme Corp Updated\",\n \"industry\": \"retail\",\n \"company_size\": \"51-200\",\n \"allowed_email_domains\": [\n \"acme.com\"\n ]\n}"
response = http.request(request)
puts response.read_body{
"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>",
"role": "owner",
"industry": "retail",
"company_size": "1-10",
"allowed_email_domains": [
"<string>"
],
"ai_training_opt_out": true,
"onboarding_completed": true,
"onboarding_step": 123
}{
"error": "INVALID_REQUEST",
"details": {
"field": "email",
"message": "Invalid email format"
}
}{
"error": "UNAUTHORIZED",
"details": {
"message": "Missing or invalid authentication token"
}
}{
"error": "FORBIDDEN",
"details": {
"message": "User does not have permission to access this resource"
}
}{
"error": "NOT_FOUND",
"details": {
"message": "Resource not found"
}
}{
"error": "INTERNAL_SERVER_ERROR",
"details": {
"message": "An unexpected error occurred"
}
}Authorizations
Bearer token authentication via Auth0. Users authenticate through Auth0 Universal Login. Include the access token in the Authorization header: Authorization: Bearer <token>
Path Parameters
The workspace ID
Pattern:
^ws_[a-z0-9]+$Body
application/json
Workspace display name
Required string length:
1 - 255URL to workspace logo
Available options:
retail, manufacturing, technology, healthcare, finance, media, other Available options:
1-10, 11-50, 51-200, 201-500, 500+ Domains allowed for member invitations
Opt out of AI model training
Response
Workspace settings updated successfully
Unique workspace identifier
Workspace display name
URL-friendly workspace slug
User ID of workspace owner
Available options:
standard, pro, business, enterprise 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 Available options:
retail, manufacturing, technology, healthcare, finance, media, other Available options:
1-10, 11-50, 51-200, 201-500, 500+ Email domains allowed for member invitations
Whether workspace data is excluded from AI training
Last modified on February 16, 2026
⌘I