Settings Admin

Update admin appearance settings

Changed on

Update admin appearance system settings. <br> Allows updating branding and asset configuration options.

post/pimcore-studio/api/settings/admin/save

Request

  • Base URL: / (relative, and the document was published on a file host, not at the API’s origin)
  • URL: /pimcore-studio/api/settings/admin/save
  • Auth: none declared

Request body

additionalAttributesobject

AdditionalAttributes

Example request

{
  "branding": {
    "backgroundShade": "#CCCCCC",
    "brandColor": "#FFCC00",
    "loginScreenCustomBackgroundImage": {
      "id": 83,
      "type": "object",
      "subtype": "Product",
      "fullPath": "/path/to/element",
      "isPublished": true,
      "hasViewAccess": true
    },
    "customLogo": {
      "id": 83,
      "type": "object",
      "subtype": "Product",
      "fullPath": "/path/to/element",
      "isPublished": true,
      "hasViewAccess": true
    }
  },
  "assets": {
    "disable_tree_preview": true
  }
}

Response

Admin system settings updated successfully

Changes

    • breaking

      added the new required request property ///

    • breaking

      added the new required request property ///

    • info

      added the new optional request property