Rivier/ Reference/ workspace

Set the logo (variant light or dark)

put/org/{orgId}/branding/logo

Set the logo (variant light or dark): base64 PNG, JPEG, WebP or SVG up to 512 KB; an SVG is sanitised. Needs an admin.

Before you call

Credential
Authorization: Bearer $KEY
Scope
workspace:write
Sdk
workspace.orgBranding.logoSet
Cli
branding logo set

Parameters

  • orgIdstring (uuid)required
    In the path

Request bodyapplication/json, required

  • variantstring
    One of: light, dark. Default: light.
  • mimestringrequired
    One of: image/png, image/jpeg, image/svg+xml, image/webp.
  • datastringrequired
    At most 699251 characters.

Responses

  • 200application/json
    Success
    • brandingobjectrequired
      • organizationIdstring (uuid)required
      • organizationNamestring
      • displayNamestringrequired
      • legalNamestringrequired
      • addressstringrequired
      • countrystringrequired
      • taxIdstringrequired
      • registrationstringrequired
      • bankstringrequired
      • footerstringrequired
      • accentstringrequired
      • fontstringrequired
      • fromNamestringrequired
      • replyTostringrequired
      • languagestringrequired
      • hasLogobooleanrequired
      • logoMimestring or nullrequired
      • hasDarkLogobooleanrequired
      • darkLogoMimestring or nullrequired
      • updatedBystringrequired
      • updatedAtstring or nullrequired
  • 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