PUT v1/bunits/{bunitId}/brand

Update existing brand settings.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
bunitId The ID of the business unit whose brand is being updated integer

Required

Body Parameters

The brand configuration object

BrandConfig
NameDescriptionTypeAdditional information
Logo A Base64 encoded logo.
string

None.

Favicon An SVG displayed in the browsertab for Cloutility
string

None.

Styles A set of styles that will replace the default styles for users
of the business unit and its descendants
Collection of BrandConfigStyle

None.

Id A unique ID for the object.
integer

Read-only.

CreatedDate Time and date the object was created.
date

Read-only.

ArchivedDate Time and date the object was or is going to be archived.

Unarchived objects have no value in ArchivedDate
date

Read-only.

Request Formats

application/json

Sample:

Sample not available.

text/json

Sample:

Sample not available.

application/xml, text/xml

Sample:
<BrandConfig xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <Id>3</Id>
  <CreatedDate>2024-05-20T16:34:19.3053803+02:00</CreatedDate>
  <ArchivedDate>2024-05-20T16:34:19.3053803+02:00</ArchivedDate>
  <Logo>sample string 1</Logo>
  <Favicon>sample string 2</Favicon>
  <Styles>
    <BrandConfigStyle>
      <Key>sample string 1</Key>
      <Value>sample string 2</Value>
    </BrandConfigStyle>
    <BrandConfigStyle>
      <Key>sample string 1</Key>
      <Value>sample string 2</Value>
    </BrandConfigStyle>
  </Styles>
</BrandConfig>

Response Information

Resource Description

The updated brand configuration

IHttpActionResult

None.

Response Formats

application/json, text/json

Sample:

Sample not available.