SPA Brands

SPA: Updates a Brand

Updates the Brand resource.

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

{
  "identifier": "string",
  "displayName": "Example name",
  "condition": "true",
  "color": "#083E5D",
  "priority": 1,
  "ciCheckEnabled": true,
  "ciSettings": [
    "string"
  ],
  "subClient": {},
  "active": true,
  "activeFrom": "2024-01-01"
}

Response

200application/json

Brand resource updated

id
integer
identifier
stringrequired
displayName
stringrequired
condition
stringrequired

Example: "true"

color
stringrequired

Example: "#083E5D"

priority
integer

Example: 1

ciCheckEnabled
boolean

Available options: truefalse

ciSettings
string[] | null
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"

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"

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"