Update workspace configuration

PUT

/workspace-configuration

WorkspaceConfiguration

Updates the workspace configuration with full replacement semantics. Creates a new DRAFT version that must be published separately.

Request

Body Params application/jsonRequired

Examples

Responses

🟢200OK

application/json

Workspace configuration updated successfully

Bodyapplication/json

🟠401Unauthorized

🟠404Record Not Found

Request Example

Shell

JavaScript

Java

Swift

curl --location --request PUT 'https://api.aworld.cloud/dashboard/v1/workspace-configuration' \
--header 'Content-Type: application/json' \
--data '{
    "branding": {
        "name": "string",
        "description": "string",
        "logo": "http://example.com",
        "favicon": "http://example.com",
        "font": {
            "type": "google",
            "family": "string"
        }
    },
    "layout": {
        "radius": "string",
        "buttonRadius": "string",
        "transition": "string",
        "stroke": "string",
        "avatarsEnabled": true,
        "avatarPool": [
            "http://example.com"
        ]
    },
    "theme": {
        "light": {
            "background": "string",
            "foreground": "string",
            "card": "string",
            "cardForeground": "string",
            "popover": "string",
            "popoverForeground": "string",
            "primary": "string",
            "primaryForeground": "string",
            "secondary": "string",
            "secondaryForeground": "string",
            "muted": "string",
            "mutedForeground": "string",
            "accent": "string",
            "accentForeground": "string",
            "destructive": "string",
            "destructiveForeground": "string",
            "success": "string",
            "successForeground": "string",
            "warning": "string",
            "warningForeground": "string",
            "info": "string",
            "infoForeground": "string",
            "border": "string",
            "input": "string",
            "ring": "string",
            "chart1": "string",
            "chart2": "string",
            "chart3": "string",
            "chart4": "string",
            "chart5": "string",
            "sidebar": "string",
            "sidebarForeground": "string",
            "sidebarPrimary": "string",
            "sidebarPrimaryForeground": "string",
            "sidebarAccent": "string",
            "sidebarAccentForeground": "string",
            "sidebarBorder": "string",
            "sidebarRing": "string",
            "button": "string",
            "buttonForeground": "string",
            "buttonSecondary": "string",
            "buttonSecondaryForeground": "string",
            "primaryGradient": "string",
            "primaryGradientForeground": "string",
            "backgroundGradient": "string",
            "backgroundGradientForeground": "string"
        },
        "dark": {
            "background": "string",
            "foreground": "string",
            "card": "string",
            "cardForeground": "string",
            "popover": "string",
            "popoverForeground": "string",
            "primary": "string",
            "primaryForeground": "string",
            "secondary": "string",
            "secondaryForeground": "string",
            "muted": "string",
            "mutedForeground": "string",
            "accent": "string",
            "accentForeground": "string",
            "destructive": "string",
            "destructiveForeground": "string",
            "success": "string",
            "successForeground": "string",
            "warning": "string",
            "warningForeground": "string",
            "info": "string",
            "infoForeground": "string",
            "border": "string",
            "input": "string",
            "ring": "string",
            "chart1": "string",
            "chart2": "string",
            "chart3": "string",
            "chart4": "string",
            "chart5": "string",
            "sidebar": "string",
            "sidebarForeground": "string",
            "sidebarPrimary": "string",
            "sidebarPrimaryForeground": "string",
            "sidebarAccent": "string",
            "sidebarAccentForeground": "string",
            "sidebarBorder": "string",
            "sidebarRing": "string",
            "button": "string",
            "buttonForeground": "string",
            "buttonSecondary": "string",
            "buttonSecondaryForeground": "string",
            "primaryGradient": "string",
            "primaryGradientForeground": "string",
            "backgroundGradient": "string",
            "backgroundGradientForeground": "string"
        }
    },
    "languages": {
        "defaultLanguage": "aa",
        "supportedLanguages": [
            "en"
        ]
    },
    "features": {
        "learningPaths": true,
        "activities": true,
        "missions": true,
        "streak": true,
        "mobility": true,
        "mediaLibrary": true,
        "leaderboards": true,
        "tags": true,
        "rewardRules": true,
        "virtualCurrencies": true,
        "virtualTransactions": true,
        "users": true,
        "onboarding": true,
        "property1": "string",
        "property2": "string"
    },
    "networking": {
        "allowedOrigins": [
            "http://example.com"
        ]
    },
    "compliance": {
        "privacyPolicyUrl": "http://example.com",
        "cookieBanner": {
            "enabled": true
        },
        "posthog": {
            "enabled": true
        }
    },
    "security": {
        "signupMode": "INVITE_ONLY",
        "allowedDomains": [
            "string"
        ],
        "defaultUserRole": "member"
    },
    "extensions": {},
    "tagNamespaces": {}
}'

Response Example

{
    "workspaceConfigurationId": "stringstri",
    "branding": {},
    "layout": {},
    "theme": {},
    "languages": {},
    "features": {},
    "extensions": {},
    "networking": {},
    "compliance": {},
    "security": {
        "signupMode": "INVITE_ONLY",
        "defaultUserRole": "member"
    },
    "tagNamespaces": {},
    "accountId": "stringstri",
    "workspaceId": "stringstri",
    "sourceRegion": "us-east-1",
    "createdAt": "2019-08-24T14:15:22.123Z",
    "updatedAt": "2019-08-24T14:15:22.123Z",
    "stage": "DRAFT"
}

Modified at 2026-06-15 16:41:21

Get workspace configuration

Delete workspace configuration