Praecise Platform
Menu

Rivier/ Reference/ hosting

Hosting library brand preview

post/hosting/sites/{id}/design-library/brand/preview

What applying a palette built from the brand colours (the stored brand kit when none is passed) would change on the site: before and after tokens, every contrast correction listed, the checks. Changes nothing.

Before you call

Credential
Authorization: Bearer $KEY
Scope
hosting:read
Mcp
rivier_design_library_brand_preview
Graphql
Query.hostingLibraryBrandPreview
Sdk
hosting.libraryBrand.preview
Cli
hosting library brand preview

Parameters

  • idstring (uuid)required
    In the path

Request bodyapplication/json, required

  • brandobject
    • draftboolean
    • namestring
      At most 60 characters.
    • colorslist of stringrequired
    • fontslist of object
      • familystringrequired
        At most 60 characters.
      • rolestring
        One of: heading, body, both.
      • stylestring
        One of: sans, serif, mono, display.
      • webLicenceboolean or unknownrequired
    • imagerystring
      At most 200 characters.
    • voicelist of string
    • logoTextstring
      At most 40 characters.
  • modestring
    One of: light, dark.
  • approveboolean

Responses

  • 200application/json
    Success
    • 400application/json
      The request was malformed
      • errorstringrequired
      • messagestring
    • 401application/json
      No valid credential
      • errorstringrequired
      • messagestring
    • 403application/json
      The credential lacks the scope, origin or address
      • errorstringrequired
      • messagestring
    • 429application/json
      Over the key's rate limit; see Retry-After
      • errorstringrequired
      • messagestring

    This page as Markdown