SPA Brands

SPA: Updates a Brand

SPA: Updates a Brand

PATCH/api/spa/brands/{id}

Authorizations

X-AUTH-TOKEN
stringheaderrequired

Value for the X-AUTH-TOKEN header parameter.

Path Parameters

id
stringrequired

Brand identifier

Request Body

application/json
required

The updated Brand resource

{
  "id": 123,
  "identifier": "",
  "displayName": "",
  "condition": "true",
  "color": "#083E5D",
  "priority": 1,
  "ciCheckEnabled": false,
  "ciSettings": [
    "string"
  ],
  "layoutPath": "string",
  "layoutFileName": "Example name",
  "layoutChecksum": "string",
  "layoutInspection": [
    "string"
  ],
  "layoutFile": "data:application/docx;base64,UEsDBBQABg...",
  "removeLayout": false,
  "createdBy": "user1@company.com",
  "updatedBy": "user1@company.com",
  "createdAt": "2024-08-23T00:00:00+00:00",
  "updatedAt": "2024-08-23T00:00:00+00:00",
  "subClient": {},
  "active": true,
  "activeFrom": "2024-01-01",
  "versionGroup": "123e4567-e89b-12d3-a456-426614174000",
  "versionNumber": 1,
  "supersededAt": "2024-08-23T00:00:00+00:00",
  "changeSummaryDe": "string",
  "changeSummaryEn": "string",
  "summaryStatus": "pending",
  "hasLayout": true,
  "layoutWarningCount": 1,
  "subClientId": 3,
  "subClientDescription": "Branch Office A",
  "subClientColor": "#083E5D"
}

Response

200application/json

Brand resource updated

id
integer
identifier
stringrequired

Example: ""

displayName
stringrequired

Example: ""

condition
stringrequired

Example: "true"

color
stringrequired

Example: "#083E5D"

priority
integer

Example: 1

ciCheckEnabled
boolean

Available options: truefalse

Example: false

ciSettings
string | null[] | null
layoutPath
string | null

Storage path of the brand's document layout ("Briefbogen") inside the Tornado template store. Null means the brand has no layout and renders exactly as it does today.

layoutFileName
string | null

Name the file was uploaded under, for the download and the UI.

layoutChecksum
string | null
layoutInspection
string | null[] | null

Result of the upload preflight - fonts, styles, headers, page geometry and the reserved content reference. Shown next to the upload, never used for rendering.

layoutFile
string<binary>

base64 encoded document layout (.docx)

Example: "data:application/docx;base64,UEsDBBQABg..."

removeLayout
boolean

Explicit removal, because a merge-patch cannot distinguish "absent" from "clear".

Available options: truefalse

Example: false

createdBy
string

User, created this entry

Example: "user1@company.com"

updatedBy
string

User, updated this entry

Example: "user1@company.com"

createdAt
string<date-time>

UTC date time of entry creation

Example: "2024-08-23T00:00:00+00:00"

updatedAt
string<date-time>

UTC date time of last entry update

Example: "2024-08-23T00:00:00+00:00"

client
object
subClient
object
active
boolean

Active flag. Default: true

Available options: truefalse

Example: true

activeFrom
string<date-time>

Date to activate the entry. Default: today

Example: "2024-01-01"

versionGroup
string<uuid>

Immutable lineage key shared by all versions of this configuration entry.

versionNumber
integer

Monotonic version counter within the version group. Display/audit only, not part of resolution.

Example: 1

supersededAt
string<date-time>

Moment from which this version is superseded by a newer version of the same version group. Null while the version is (or is scheduled to become) the current one.

changeSummaryDe
string

AI generated German summary of the changes introduced by this version.

changeSummaryEn
string

AI generated English summary of the changes introduced by this version.

summaryStatus
enum<string>

Generation status of the AI change summary.

Available options: pendingdonefailed

hasLayout
boolean

Available options: truefalse

layoutWarningCount
integer

The list needs to show whether a layout has findings, but not the findings themselves - the inspection carries the full design report and would bloat every list response.

default
boolean

Available options: truefalse

subClientId
integer

SubClient ID. Provided on instances with enabled sub-client module only.

Example: 3

subClientDescription
string

SubClient description. Provided on instances with enabled sub-client module only.

Example: "Branch Office A"

subClientColor
string

SubClient display colour. Provided on instances with enabled sub-client module only.

Example: "#083E5D"