Change the branding

Before you call

Credential

Authorization: Bearer $KEY

Scope

workspace:write

Sdk

workspace.orgBranding.set

Cli

branding set

Parameters

• orgIdstring (uuid)required
  In the path

Request bodyapplication/json, required

• displayNamestring
  At most 200 characters.
• legalNamestring
  At most 200 characters.
• addressstring
  At most 1000 characters.
• countrystring
  At most 2 characters. Pattern: ^([A-Za-z]{2})?$.
• taxIdstring
  At most 60 characters.
• registrationstring
  At most 60 characters.
• bankstring
  At most 2000 characters.
• footerstring
  At most 1000 characters.
• accentstring
• fontstring
  One of: system, sans, serif, rounded, mono.
• fromNamestring
  At most 120 characters.
• replyTostring (email)
• languagestring
  At most 20 characters. Pattern: ^[a-z]{2,3}(-[A-Za-z0-9]{2,8})*$.
• removeLogoboolean
• removeDarkLogoboolean

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