Update workspace appearance settings

Updates workspace appearance settings. All fields are optional - only provided fields will be updated.

What can be updated:

Main workspace color: Changes the primary color theme used throughout the workspace
Navigation animations: Turns left-right page slides on or off for users who follow the workspace default
Logo: Upload a logo file for light theme display
Logo dark theme: Upload a separate logo file optimized for dark theme display

To upload logo files:

Call POST /api/public/workspace/upload to upload each logo file
Get the file ID from the response
Use that file ID in the logoId or logoDarkThemeId field
Set to null to remove an existing logo

Note: This endpoint requires the WsSettings.manageSettings permission. Changes affect how the workspace appears to all users. The system validates that provided file IDs exist and belong to the workspace.

PATCH/administration/appearance-settings

Authorization

AuthorizationOAuth2 access token · headerrequired

Scopes:api:write

AuthorizationBearer token (JWT) · headerrequired

Request body

requiredapplication/json

logoDarkThemeIdobject | null

File ID for the workspace logo (dark theme). Upload file via POST /workspace/upload first.

logoIdobject | null

File ID for the workspace logo (default theme). Upload file via POST /workspace/upload first.

mainWorkspaceColorstring

Main workspace color theme

Allowed:DEFAULTBLACKREDROSEMAGENTAGREENBLUESKYYELLOWVIOLET

navigationAnimationsEnabledboolean

When true, workspace pages slide left and right during navigation. Off by default. Users can override this in their profile.

Responses

200

Appearance settings updated successfully

successboolean

401

Unauthorized - Invalid or missing authentication token

403

Forbidden - Insufficient API scopes or permissions

404

File not found - Invalid logoId or logoDarkThemeId provided

Try it

Server

Base URLCustom base URLOverrides the selected server when set.

Authorization

OAuth2 access tokenRemember on this deviceInclude my values in samples

Bodyapplication/json

Request body

Request

curl -X PATCH "https://leadtime.app/api/public/administration/appearance-settings" \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
  "logoDarkThemeId": "123e4567-e89b-12d3-a456-426614174001",
  "logoId": "123e4567-e89b-12d3-a456-426614174000",
  "mainWorkspaceColor": "BLUE",
  "navigationAnimationsEnabled": false
}'

const response = await fetch("https://leadtime.app/api/public/administration/appearance-settings", {
  method: "PATCH",
  headers: {
    "Authorization": "Bearer YOUR_ACCESS_TOKEN",
    "Content-Type": "application/json"
  },
  body: "{\n  \"logoDarkThemeId\": \"123e4567-e89b-12d3-a456-426614174001\",\n  \"logoId\": \"123e4567-e89b-12d3-a456-426614174000\",\n  \"mainWorkspaceColor\": \"BLUE\",\n  \"navigationAnimationsEnabled\": false\n}"
});

import requests

response = requests.patch(
    "https://leadtime.app/api/public/administration/appearance-settings",
    headers={
        "Authorization": "Bearer YOUR_ACCESS_TOKEN",
        "Content-Type": "application/json"
    },
    data="{\n  \"logoDarkThemeId\": \"123e4567-e89b-12d3-a456-426614174001\",\n  \"logoId\": \"123e4567-e89b-12d3-a456-426614174000\",\n  \"mainWorkspaceColor\": \"BLUE\",\n  \"navigationAnimationsEnabled\": false\n}",
)

Response

{
  "success": true
}