Sign in
Portal Appearance

Update Appearance Configuration

Updates the current appearance configuration for this portal including setting pre-defined or custom themes, fonts, colors, and images. Note that portals using the fully-customizable portal client may override or ignore these settings by disregarding them in the code.

patch/v2/portals/{portalId}/appearance

Path parameters

portalIdstring uuid required
Example:f32d905a-ed33-46a3-a093-d8f536af9a8a

The Portal identifier

Request body

theme_name'mint_rocket' | 'dark_mode' | 'custom'

Select a pre-existing default theme or specify 'custom' to use custom_theme variables.

use_custom_fontsboolean

If true, fonts in custom_fonts will be used over the theme's default fonts

Example request

{
  "theme_name": "custom",
  "use_custom_fonts": true,
  "custom_theme": {
    "colors": {
      "section": {
        "header": {
          "value": "#F8F8F8",
          "description": "Background for header"
        },
        "body": {
          "value": "#FFFFFF",
          "description": "Background for main content"
        },
        "hero": {
          "value": "#F8F8F8",
          "description": "Background for hero section"
        },
        "accent": {
          "value": "#F8F8F8",
          "description": "Subtle background"
        },
        "tertiary": {
          "value": "#FFFFFF",
          "description": "Tertiary background"
        },
        "stroke": {
          "value": "rgba(0,0,0,0.1)",
          "description": "Border color"
        },
        "footer": {
          "value": "#07A88D",
          "description": "Background for footer"
        }
      },
      "text": {
        "header": {
          "value": "rgba(0,0,0,0.8)",
          "description": "Header text"
        },
        "hero": {
          "value": "#FFFFFF",
          "description": "Hero text"
        },
        "headings": {
          "value": "rgba(0,0,0,0.8)",
          "description": "Headings text"
        },
        "primary": {
          "value": "rgba(0,0,0,0.8)",
          "description": "Main content text"
        },
        "secondary": {
          "value": "rgba(0,0,0,0.8)",
          "description": "Supporting text"
        },
        "accent": {
          "value": "#07A88D",
          "description": "Subtle text"
        },
        "link": {
          "value": "#07A88D",
          "description": "Link text"
        },
        "footer": {
          "value": "#FFFFFF",
          "description": "Footer text"
        }
      },
      "button": {
        "primary_fill": {
          "value": "#1155CB",
          "description": "Background for Primary Button"
        },
        "primary_text": {
          "value": "#FFFFFF",
          "description": "Text for Primary Button"
        }
      }
    }
  },
  "custom_fonts": {
    "base": "Roboto",
    "code": "Roboto",
    "headings": "Roboto"
  },
  "text": {
    "catalog": {
      "welcome_message": "Welcome",
      "primary_header": "Come one in!"
    }
  },
  "images": {
    "favicon": {
      "data": "data:image/png;base64,bmljZV9sb29raW5nX3BpY3R1cmU=",
      "filename": "favicon.ico"
    },
    "logo": {
      "data": "data:image/png;base64,bmljZV9sb29raW5nX3BpY3R1cmU=",
      "filename": "logo.png"
    },
    "catalog_cover": {
      "data": "data:image/jpeg;base64,bmljZV9sb29raW5nX3BpY3R1cmU="
    }
  }
}

Response

Details about the appearance settings being updated.

theme_name'mint_rocket' | 'dark_mode' | 'custom' required

Select a pre-existing default theme or specify 'custom' to use custom_theme variables.

use_custom_fontsboolean required

If true, fonts in custom_fonts will be used over the theme's default fonts

Example response

{
  "theme_name": "custom",
  "use_custom_fonts": true,
  "custom_theme": {
    "colors": {
      "section": {
        "header": {
          "value": "#F8F8F8",
          "description": "Background for header"
        },
        "body": {
          "value": "#FFFFFF",
          "description": "Background for main content"
        },
        "hero": {
          "value": "#F8F8F8",
          "description": "Background for hero section"
        },
        "accent": {
          "value": "#F8F8F8",
          "description": "Subtle background"
        },
        "tertiary": {
          "value": "#FFFFFF",
          "description": "Tertiary background"
        },
        "stroke": {
          "value": "rgba(0,0,0,0.1)",
          "description": "Border color"
        },
        "footer": {
          "value": "#07A88D",
          "description": "Background for footer"
        }
      },
      "text": {
        "header": {
          "value": "rgba(0,0,0,0.8)",
          "description": "Header text"
        },
        "hero": {
          "value": "#FFFFFF",
          "description": "Hero text"
        },
        "headings": {
          "value": "rgba(0,0,0,0.8)",
          "description": "Headings text"
        },
        "primary": {
          "value": "rgba(0,0,0,0.8)",
          "description": "Main content text"
        },
        "secondary": {
          "value": "rgba(0,0,0,0.8)",
          "description": "Supporting text"
        },
        "accent": {
          "value": "#07A88D",
          "description": "Subtle text"
        },
        "link": {
          "value": "#07A88D",
          "description": "Link text"
        },
        "footer": {
          "value": "#FFFFFF",
          "description": "Footer text"
        }
      },
      "button": {
        "primary_fill": {
          "value": "#1155CB",
          "description": "Background for Primary Button"
        },
        "primary_text": {
          "value": "#FFFFFF",
          "description": "Text for Primary Button"
        }
      }
    }
  },
  "custom_fonts": {
    "base": "Roboto",
    "code": "Roboto",
    "headings": "Roboto"
  },
  "text": {
    "catalog": {
      "welcome_message": "Welcome",
      "primary_header": "Come one in!"
    }
  },
  "images": {
    "favicon": {
      "data": "data:image/png;base64,bmljZV9sb29raW5nX3BpY3R1cmU=",
      "filename": "favicon.ico"
    },
    "logo": {
      "data": "data:image/png;base64,bmljZV9sb29raW5nX3BpY3R1cmU=",
      "filename": "logo.png"
    },
    "catalog_cover": {
      "data": "data:image/jpeg;base64,bmljZV9sb29raW5nX3BpY3R1cmU="
    }
  }
}

Changes

Changed in 6 of the 52 revisions of this API.3049

  • 06734a9c491f6See the full diff
    • ○

      response property allOf[V2PortalAppearance]/custom_fonts deprecated

      response-property-deprecated

    • ○

      response property allOf[V2PortalAppearance]/custom_theme deprecated

      response-property-deprecated

    • ○

      response property allOf[V2PortalAppearance]/images deprecated

      response-property-deprecated

    • ○

      response property allOf[V2PortalAppearance]/text deprecated

      response-property-deprecated

    • ○

      response property allOf[V2PortalAppearance]/theme_name deprecated

      response-property-deprecated

    • ○

      response property allOf[V2PortalAppearance]/use_custom_fonts deprecated

      response-property-deprecated

    This revision also has 5 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • 19e869275e281See the full diff
    • ●

      added the new type enum value to the allOf[subschema #2]/invalid_parameters/items/oneOf[InvalidParameterStandard]/rule response property for the response status 400

      response-property-enum-value-added

    This revision also has 4 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • 96118a9cd7f429See the full diff
    • ▲

      the response property allOf[V2PortalAppearance]/custom_theme/colors/button/primary_fill/description became nullable for the status 200

      response-property-became-nullable

    • ▲

      the response property allOf[V2PortalAppearance]/custom_theme/colors/button/primary_text/description became nullable for the status 200

      response-property-became-nullable

    • ▲

      the response property allOf[V2PortalAppearance]/custom_theme/colors/section/accent/description became nullable for the status 200

      response-property-became-nullable

    • ▲

      the response property allOf[V2PortalAppearance]/custom_theme/colors/section/body/description became nullable for the status 200

      response-property-became-nullable

    • ▲

      the response property allOf[V2PortalAppearance]/custom_theme/colors/section/footer/description became nullable for the status 200

      response-property-became-nullable

    • ▲

      the response property allOf[V2PortalAppearance]/custom_theme/colors/section/header/description became nullable for the status 200

      response-property-became-nullable

    • ▲

      the response property allOf[V2PortalAppearance]/custom_theme/colors/section/hero/description became nullable for the status 200

      response-property-became-nullable

    • ▲

      the response property allOf[V2PortalAppearance]/custom_theme/colors/section/stroke/description became nullable for the status 200

      response-property-became-nullable

    • ▲

      the response property allOf[V2PortalAppearance]/custom_theme/colors/section/tertiary/description became nullable for the status 200

      response-property-became-nullable

    • ▲

      the response property allOf[V2PortalAppearance]/custom_theme/colors/text/accent/description became nullable for the status 200

      response-property-became-nullable

    • ▲

      the response property allOf[V2PortalAppearance]/custom_theme/colors/text/footer/description became nullable for the status 200

      response-property-became-nullable

    • ▲

      the response property allOf[V2PortalAppearance]/custom_theme/colors/text/header/description became nullable for the status 200

      response-property-became-nullable

    • ▲

      the response property allOf[V2PortalAppearance]/custom_theme/colors/text/headings/description became nullable for the status 200

      response-property-became-nullable

    • ▲

      the response property allOf[V2PortalAppearance]/custom_theme/colors/text/hero/description became nullable for the status 200

      response-property-became-nullable

    • ▲

      the response property allOf[V2PortalAppearance]/custom_theme/colors/text/link/description became nullable for the status 200

      response-property-became-nullable

    • ▲

      the response property allOf[V2PortalAppearance]/custom_theme/colors/text/primary/description became nullable for the status 200

      response-property-became-nullable

    • ▲

      the response property allOf[V2PortalAppearance]/custom_theme/colors/text/secondary/description became nullable for the status 200

      response-property-became-nullable

    • ▲

      the response property allOf[V2PortalAppearance]/images/catalog_cover/filename became nullable for the status 200

      response-property-became-nullable

    • ▲

      the response property allOf[V2PortalAppearance]/images/favicon/filename became nullable for the status 200

      response-property-became-nullable

    • ▲

      the response property allOf[V2PortalAppearance]/images/logo/filename became nullable for the status 200

      response-property-became-nullable

    • ▲

      the response property allOf[subschema #2]/invalid_parameters/items/oneOf[InvalidParameterChoiceItem]/source became nullable for the status 400

      response-property-became-nullable

    • ▲

      the response property allOf[subschema #2]/invalid_parameters/items/oneOf[InvalidParameterDependentItem]/source became nullable for the status 400

      response-property-became-nullable

    • ▲

      the response property allOf[subschema #2]/invalid_parameters/items/oneOf[InvalidParameterMaximumLength]/source became nullable for the status 400

      response-property-became-nullable

    • ▲

      the response property allOf[subschema #2]/invalid_parameters/items/oneOf[InvalidParameterMinimumLength]/source became nullable for the status 400

      response-property-became-nullable

    • ▲

      the response property allOf[subschema #2]/invalid_parameters/items/oneOf[InvalidParameterStandard]/source became nullable for the status 400

      response-property-became-nullable

    • ▲

      the response property detail became nullable for the status 401

      response-property-became-nullable

    • ▲

      the response property instance became nullable for the status 401

      response-property-became-nullable

    • ▲

      the response property status became nullable for the status 401

      response-property-became-nullable

    • ▲

      the response property title became nullable for the status 401

      response-property-became-nullable

    This revision also has 7 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • ab1a51b761442See the full diff
    • ○

      added V2PortalAppearance to the response body allOf list for the response status 200

      response-body-all-of-added

    • ○

      removed PortalAppearance from the response body allOf list for the response status 200

      response-body-all-of-removed

    This revision also has 40 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • d833d4dbb1fa1See the full diff
    • ●

      added the new missing_reference enum value to the allOf[subschema #2]/invalid_parameters/items/oneOf[InvalidParameterStandard]/rule response property for the response status 400

      response-property-enum-value-added

  • 08ead66e9ebb121See the full diff
    • ▲

      added InvalidParameterMaximumLength to the allOf[subschema #2]/invalid_parameters/items/ response property oneOf list for the response status 400

      response-property-one-of-added

    • ●

      added the new min enum value to the allOf[subschema #2]/invalid_parameters/items/oneOf[InvalidParameterMinimumLength]/rule response property for the response status 400

      response-property-enum-value-added

    • ●

      added the new min_items enum value to the allOf[subschema #2]/invalid_parameters/items/oneOf[InvalidParameterMinimumLength]/rule response property for the response status 400

      response-property-enum-value-added

    • ○

      removed the max_length enum value from the allOf[subschema #2]/invalid_parameters/items/oneOf[InvalidParameterStandard]/rule response property for the response status 400

      response-property-enum-value-removed

    This revision also has 88 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog