Update workspace branding

Sets custom branding for the workspace. Overwrites all fields. Enterprise license required.

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

logoUrl?|

URL to custom logo image. Set to null to clear.

logoText?|

Text to show next to/instead of logo (e.g. company name). Set to null to clear.

primaryColor?|

Hex color to replace Atlas brand color. Must be 6-digit hex (e.g. #FF5500). Set to null to clear.

faviconUrl?|

URL to custom favicon. Set to null to clear.

hideAtlasBranding?boolean

When true, remove 'Atlas' / 'Powered by Atlas' text from the UI.

Response Body

`application/json`

curl -X PUT "http://localhost:3001/api/v1/admin/branding" \  -H "Content-Type: application/json" \  -d '{}'

{
  "branding": {
    "id": "string",
    "orgId": "string",
    "logoUrl": "string",
    "logoText": "string",
    "primaryColor": "string",
    "faviconUrl": "string",
    "hideAtlasBranding": true,
    "createdAt": "string",
    "updatedAt": "string"
  }
}

{
  "error": "string",
  "message": "string",
  "requestId": "string"
}

{
  "property1": null,
  "property2": null
}

{
  "property1": null,
  "property2": null
}

{
  "error": "string",
  "message": "string",
  "requestId": "string"
}

{
  "property1": null,
  "property2": null
}

{
  "error": "string",
  "message": "string",
  "requestId": "string"
}

Update workspace branding

Request Body

Response Body

200application/json

400application/json

401application/json

403application/json

404application/json

429application/json

500application/json

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`