Sign in
System Configuration

Save company basic info and branding

Updates the company's portal URL, email address, branding colors, logos, and background image. Navigation bar logo requires Enterprise license.

put/api/v1/configuration/branding

Request body

portalURLstring required

Portal URL for the dotCMS instance

emailAddressstring required

Company email address used as the system sender. Accepts plain email (e.g. 'admin@dotcms.com') or display name format (e.g. 'dotCMS Website website@dotcms.com'). The mx domain is derived from this value when mx is not provided.

mxstring

Mail exchange domain (derived from emailAddress if not provided)

primaryColorstring required

Primary branding color (hex)

secondaryColorstring required

Secondary branding color (hex)

backgroundColorstring

Background branding color (hex). Cleared if omitted.

backgroundImagestring

Background image path (dotAsset path starting with /dA). Cleared if omitted.

loginScreenLogostring

Login screen logo path (dotAsset path starting with /dA). Cleared if omitted.

navBarLogostring

Navigation bar logo path (dotAsset path starting with /dA, Enterprise only). Cleared if omitted.

Example request

{
  "portalURL": "http://localhost:8080",
  "emailAddress": "admin@dotcms.com",
  "mx": "dotcms.com",
  "primaryColor": "#C336E5",
  "secondaryColor": "#54428E",
  "backgroundColor": "#3C1361",
  "backgroundImage": "/dA/abc123/background.png",
  "loginScreenLogo": "/dA/abc123/logo.png",
  "navBarLogo": "/dA/abc123/nav-logo.png"
}

Response

Company basic info updated successfully

i18nMessagesMapobject
permissionsstring[]

Example response

{
  "entity": {
    "companyId": "dotcms.org",
    "companyName": "dotcms.org",
    "portalURL": "http://localhost:8080",
    "emailAddress": "admin@dotcms.com",
    "mx": "dotcms.com",
    "primaryColor": "#C336E5",
    "secondaryColor": "#54428E",
    "backgroundColor": "#3C1361",
    "backgroundImage": "/dA/abc123/background.png",
    "loginScreenLogo": "/dA/abc123/logo.png",
    "navBarLogo": "/dA/abc123/nav-logo.png",
    "authType": "emailAddress",
    "languageId": "en_US",
    "timeZoneId": "America/New_York"
  }
}

Changes

No recorded changes to this endpoint across all 1 revision of this API.