Update portal settings

Update portal settings

Partially updates portal settings from a flat key-value JSON body. Key absent = leave unchanged. Key present (even with null) = update. Returns the full updated settings map.

License requirements:

  • appearance.* and branding.* keys require the Branding module.
  • answerGenius.* keys require the AI Suite add-on.

File path validation: values for branding.faviconFullName and branding.logoFullName must be paths to files that already exist in the portal Storage (e.g. Storage/Branding/logo.png). Pass null to clear the value.

Body
application/json

Flat key-value map of portal settings. All values are strings or null.

appearance.hoverColor
string | null

Hover color (hex, e.g. #3399ff).

Example#3399ff
appearance.selectionColor
string | null

Selection highlight color.

branding.faviconFullName
string | null

Storage path to favicon (e.g. Storage/Branding/favicon.ico).

ExampleStorage/Branding/favicon.ico
branding.logoFullName
string | null

Storage path to logo image.

answerGenius.primaryColor
string | null

AnswerGenius widget primary color.

answerGenius.greetingPopupMessage
string | null

HTML shown in the greeting popup.

answerGenius.chatWindowTitle
string | null

AnswerGenius chat window title text.

ExampleAnswerGenius
answerGenius.chatWelcomeMessage
string | null

HTML shown as the welcome message in chat.

answerGenius.personaText
string | null

Persona/tone description for AnswerGenius.

answerGenius.searchExpansionHints
string | null

Hints for expanding search queries.

answerGenius.answerStyleText
string | null

Style instructions for AnswerGenius answers.

additional properties
string | null
Responses
PATCH/settings

{
  "appearance.hoverColor": "#3399ff",
  "branding.faviconFullName": "Storage/Branding/favicon.ico",
  "answerGenius.chatWindowTitle": "AnswerGenius"
}