Brand Kit | Subrite

Brand Kit

Endpoints for Brand Kit

ReferenceUpdated October 13, 2026View as Markdown

GET/api/v1/brand-kits/{id}

Authentication: Bearer token (JWT)

Parameters

Path parameters1

idstringRequired

Responses

6 status codes

Responses 200

Status200 400 401 403 404 500application/json

Schema ExampleBrandKitResponseDto

26 top-level fieldsSelect an object to expand

idstringRequired
namestringRequired
maxLength: 255
smsOtpboolean
emailOtpEnabledboolean
smsOtpEnabledboolean
smsOtpFallbackEnabledboolean

Responses 400

Status200 400 401 403 404 500application/json

The id is neither a UUID nor the tenant id

Schema ExampleErrorResponse

3 top-level fieldsSelect an object to expand

messageCodestringRequired
Allowed values: "badRequest"
messagestring
errorsarray of FieldError

Responses 401

unauthorized

This response has no body.

Responses 403

Status200 400 401 403 404 500application/json

forbiddenResource

Schema ExampleErrorResponse

3 top-level fieldsSelect an object to expand

messageCodestringRequired
messagestring
errorsarray of FieldErrorRequired7 fields

Responses 404

Status200 400 401 403 404 500application/json

brandKitNotFound

Schema ExampleErrorResponse

3 top-level fieldsSelect an object to expand

messageCodestringRequired
Allowed values: "brandKitNotFound"
messagestring
errorsarray of FieldError

Responses 500

Status200 400 401 403 404 500application/json

internalServerError

SchemaErrorResponse

Same fields as Get a brand kit by id (403).

Example requestcurl

curl

curl 'https://api.subrite.no/api/v1/brand-kits/{id}' \
  --header 'Authorization: Bearer <token>'

Try it

Update a brand kit#

POST/api/v1/brand-kits/{id}

Authentication: Bearer token (JWT)

Parameters

Path parameters1

idstringRequired

Request body

Required bodymultipart/form-data

SchemaBrandKitUpdateDto

34 top-level fieldsSelect an object to expand

namestringOptional
maxLength: 255
smsOtpboolean

DELETE/api/v1/brand-kits/{id}

Authentication: Bearer token (JWT)

Parameters

Path parameters1

idstringRequired

Responses

6 status codes

Responses 200

Status200 400 401 403 409 500application/json

Schema Exampleboolean

No named fields are defined for this schema.

GET/api/v1/brand-kits

Authentication: Bearer token (JWT)

Responses

4 status codes

Responses 200

Status200 401 403 500application/json

Schema Examplearray of BrandKitResponseDto

26 top-level fieldsSelect an object to expand

idstringRequired when parent is present
namestring

Create a brand kit#

POST/api/v1/brand-kits

Authentication: Bearer token (JWT)

Request body

Required bodyapplication/json

Schema ExampleBrandKitCreateDto

2 top-level fields

namestringRequired
maxLength: 255
hostnameIdsarray of numberOptional

2 documented fields · Scroll to see moreShow full heightShow compact view

Schema ExampleBrandKitResponseDto

200 · application/json

{
  "id": "string",
  "name": "string",
  "smsOtp": true,
  "emailOtpEnabled": true,
  "smsOtpEnabled": true,
  "smsOtpFallbackEnabled": true,
  "primaryOtpChannel": "email",
  "favicon": "string",
  "authLogo": "string",
  "authLogoHeight": 1,
  "siteUrl": "string",
  "termsUrl": "string",
  "privacyUrl": "string",
  "defaultLogoutUrl": "string",
  "pageHeader": {
    "logo": "string",
    "logoHeight": 0,
    "textContent": "string",
    "textColor": "string",
    "bgColor": "string"
  },
  "primaryButton": {
    "bgColor": "string",
    "textColor": "string",
    "hoverColor": "string",
    "stepColor": "string"
  },
  "primaryFont": {
    "family": "string",
    "url": "string",
    "type": "string",
    "style": "string",
    "display": "string",
    "weight": "string"
  },
  "secondaryFont": {
    "family": "string",
    "url": "string",
    "type": "string",
    "style": "string",
    "display": "string",
    "weight": "string"
  },
  "otpTemplateId": {
    "en": "string",
    "no": "string",
    "sv": "string",
    "da": "string",
    "key": "string"
  },
  "tenantId": 0,
  "smsSenderId": 0,
  "emailSenderId": 0,
  "isDefault": true,
  "emailSender": {
    "id": 0,
    "senderName": "<senderName>",
    "senderEmail": "string",
    "replyTo": "string",
    "status": "pending",
    "communicationChannel": "sms",
    "requestSentAt": "2019-08-24T14:15:22Z",
    "providerRegion": "global"
  },
  "smsSender": {
    "id": 0,
    "senderName": "<senderName>",
    "senderEmail": "string",
    "replyTo": "string",
    "status": "pending",
    "communicationChannel": "sms",
    "requestSentAt": "2019-08-24T14:15:22Z",
    "providerRegion": "global"
  },
  "hostnames": [
    {}
  ]
}

Example · 79 linesShow full heightShow compact view

errors

Responses

8 status codes

Responses 201

Status201 400 401 403 404 409 500 502application/json

Schema ExampleBrandKitResponseDto

Same fields as Get a brand kit by id (200).

Schema ExampleBrandKitResponseDto

201 · application/json

{
  "id": "string",
  "name": "string",
  "smsOtp": true,
  "emailOtpEnabled": true,
  "smsOtpEnabled": true,
  "smsOtpFallbackEnabled": true,
  "primaryOtpChannel": "email",
  "favicon": "string",
  "authLogo": "string",
  "authLogoHeight": 1,
  "siteUrl": "string",
  "termsUrl": "string",
  "privacyUrl": "string",
  "defaultLogoutUrl": "string",
  "pageHeader": {
    "logo": "string",
    "logoHeight": 0,
    "textContent": "string",
    "textColor": "string",
    "bgColor": "string"
  },
  "primaryButton": {
    "bgColor": "string",
    "textColor": "string",
    "hoverColor": "string",
    "stepColor": "string"
  },
  "primaryFont": {
    "family": "string",
    "url": "string",
    "type": "string",
    "style": "string",
    "display": "string",
    "weight": "string"
  },
  "secondaryFont": {
    "family": "string",
    "url": "string",
    "type": "string",
    "style": "string",
    "display": "string",
    "weight": "string"
  },
  "otpTemplateId": {
    "en": "string",
    "no": "string",
    "sv": "string",
    "da": "string",
    "key": "string"
  },
  "tenantId": 0,
  "smsSenderId": 0,
  "emailSenderId": 0,
  "isDefault": true,
  "emailSender": {
    "id": 0,
    "senderName": "<senderName>",
    "senderEmail": "string",
    "replyTo": "string",
    "status": "pending",
    "communicationChannel": "sms",
    "requestSentAt": "2019-08-24T14:15:22Z",
    "providerRegion": "global"
  },
  "smsSender": {
    "id": 0,
    "senderName": "<senderName>",
    "senderEmail": "string",
    "replyTo": "string",
    "status": "pending",
    "communicationChannel": "sms",
    "requestSentAt": "2019-08-24T14:15:22Z",
    "providerRegion": "global"
  },
  "hostnames": [
    {}
  ]
}

Example · 79 linesShow full heightShow compact view

Responses 400

Status201 400 401 403 404 409 500 502application/json

Body validation failed, the id is neither a UUID nor the tenant id, an uploaded file is not an accepted type, or the login-method settings contradict each other; field codes in errors[]

Schema ExampleErrorResponse

3 top-level fieldsSelect an object to expand

messageCodestringRequired
Allowed values: "badRequest", "internalServerError", "invalidFileType", "otpChannelRequired", "primaryOtpChannelDisabled", "smsSenderRequired"

Responses 401

unauthorized

This response has no body.

Responses 403

Status201 400 401 403 404 409 500 502application/json

forbiddenResource

Schema ExampleErrorResponse

Same fields as Get a brand kit by id (403).

Schema ExampleErrorResponse

403 · application/json

Responses 404

Status201 400 401 403 404 409 500 502application/json

brandKitNotFound, tenantNotFound

Schema ExampleErrorResponse

3 top-level fieldsSelect an object to expand

messageCodestringRequired
Allowed values: "brandKitNotFound", "tenantNotFound"
messagestring

Responses 409

Status201 400 401 403 404 409 500 502application/json

Another brand kit already uses the name (in errors[] against name), or a selected default sender is not approved for this tenant

Schema ExampleErrorResponse

3 top-level fieldsSelect an object to expand

messageCodestringRequired
Allowed values: "brandKitNameAlreadyExists", "emailSenderNotApproved", "smsSenderNotApproved"
message

Responses 500

Status201 400 401 403 404 409 500 502application/json

internalServerError

SchemaErrorResponse

Same fields as Get a brand kit by id (403).

Responses 502

Status201 400 401 403 404 409 500 502application/json

An uploaded logo, favicon or font could not be stored; nothing was saved

Schema ExampleErrorResponse

3 top-level fieldsSelect an object to expand

messageCodestringRequired
Allowed values: "tenantAssetUploadFailed"
messagestring

Example requestcurl

curl

curl 'https://api.subrite.no/api/v1/brand-kits/{id}' \
  --request POST \
  --header 'Authorization: Bearer <token>' \
  --form 'logoImage=@<file>' \
  --form 'faviconImage=@<file>' \
  --form 'authLogoImage=@<file>' \
  --form 'primaryFontFile=@<file>' \
  --form 'secondaryFontFile=@<file>'

Responses 400

Status200 400 401 403 409 500application/json

The id is not a UUID

Schema ExampleErrorResponse

Same fields as Get a brand kit by id (400).

Schema ExampleErrorResponse

400 · application/json

{
  "messageCode": "badRequest",
  "message": "string",
  "errors": [
    {}
  ]
}

Example · 7 linesShow full heightShow compact view

Responses 403

Status200 400 401 403 409 500application/json

forbiddenResource

Schema ExampleErrorResponse

Same fields as Get a brand kit by id (403).

Schema ExampleErrorResponse

403 · application/json

{
  "messageCode": "string",
  "message": "string",
  "errors": [
    {}
  ]
}

Example · 7 linesShow full heightShow compact view

Responses 409

Status200 400 401 403 409 500application/json

The brand kit is still assigned to one or more hostnames

Schema ExampleErrorResponse

3 top-level fieldsSelect an object to expand

messageCodestringRequired
Allowed values: "brandKitInUse"
messagestring
errorsarray of FieldErrorRequired7 fields
errors
- fieldstringRequired when parent is presentField path: errors[].field
- fieldValuestringRequired when parent is presentField path: errors[].fieldValue
- identifierstringRequired when parent is presentField path: errors[].identifier
- identifierValuestringRequired when parent is presentField path: errors[].identifierValue
- messageCodestringRequired when parent is presentField path: errors[].messageCode
- messagestringField path: errors[].message
- errorTypestringRequired when parent is present

10 documented fields · Scroll to see moreShow full heightShow compact view

Schema ExampleErrorResponse

409 · application/json

{
  "messageCode": "brandKitInUse",
  "message": "string",
  "errors": [
    {}
  ]
}

Example · 7 linesShow full heightShow compact view

Schema Examplearray of BrandKitResponseDto

200 · application/json

[
  {
    "id": "string",
    "name": "string",
    "smsOtp": true,
    "emailOtpEnabled": true,
    "smsOtpEnabled": true,
    "smsOtpFallbackEnabled": true,
    "primaryOtpChannel": "email",
    "favicon": "string",
    "authLogo": "string",
    "authLogoHeight": 1,
    "siteUrl": "string",
    "termsUrl": "string",
    "privacyUrl": "string",
    "defaultLogoutUrl": "string",
    "pageHeader": {},
    "primaryButton": {},
    "primaryFont": {},
    "secondaryFont": {},
    "otpTemplateId": {},
    "tenantId": 0,
    "smsSenderId": 0,
    "emailSenderId": 0,
    "isDefault": true,
    "emailSender": {},
    "smsSender": {},
    "hostnames": []
  }
]

Example · 30 linesShow full heightShow compact view

Responses 403

Status200 401 403 500application/json

forbiddenResource

Schema ExampleErrorResponse

Same fields as Get a brand kit by id (403).

Schema ExampleErrorResponse

403 · application/json

{
  "messageCode": "string",
  "message": "string",
  "errors": [
    {}
  ]
}

Example · 7 linesShow full heightShow compact view

BrandKitCreateDto

Responses

6 status codes

Responses 201

Status201 400 401 403 409 500application/json

Schema ExampleBrandKitResponseDto

Same fields as Get a brand kit by id (200).

Schema ExampleBrandKitResponseDto

201 · application/json

{
  "id": "string",
  "name": "string",
  "smsOtp": true,
  "emailOtpEnabled": true,
  "smsOtpEnabled": true,
  "smsOtpFallbackEnabled": true,
  "primaryOtpChannel": "email",
  "favicon": "string",
  "authLogo": "string",
  "authLogoHeight": 1,
  "siteUrl": "string",
  "termsUrl": "string",
  "privacyUrl": "string",
  "defaultLogoutUrl": "string",
  "pageHeader": {
    "logo": "string",
    "logoHeight": 0,
    "textContent": "string",
    "textColor": "string",
    "bgColor": "string"
  },
  "primaryButton": {
    "bgColor": "string",
    "textColor": "string",
    "hoverColor": "string",
    "stepColor": "string"
  },
  "primaryFont": {
    "family": "string",
    "url": "string",
    "type": "string",
    "style": "string",
    "display": "string",
    "weight": "string"
  },
  "secondaryFont": {
    "family": "string",
    "url": "string",
    "type": "string",
    "style": "string",
    "display": "string",
    "weight": "string"
  },
  "otpTemplateId": {
    "en": "string",
    "no": "string",
    "sv": "string",
    "da": "string",
    "key": "string"
  },
  "tenantId": 0,
  "smsSenderId": 0,
  "emailSenderId": 0,
  "isDefault": true,
  "emailSender": {
    "id": 0,
    "senderName": "<senderName>",
    "senderEmail": "string",
    "replyTo": "string",
    "status": "pending",
    "communicationChannel": "sms",
    "requestSentAt": "2019-08-24T14:15:22Z",
    "providerRegion": "global"
  },
  "smsSender": {
    "id": 0,
    "senderName": "<senderName>",
    "senderEmail": "string",
    "replyTo": "string",
    "status": "pending",
    "communicationChannel": "sms",
    "requestSentAt": "2019-08-24T14:15:22Z",
    "providerRegion": "global"
  },
  "hostnames": [
    {}
  ]
}

Example · 79 linesShow full heightShow compact view

Responses 400

Status201 400 401 403 409 500application/json

Body validation failed; field codes in errors[]

Schema ExampleErrorResponse

3 top-level fieldsSelect an object to expand

messageCodestringRequired
Allowed values: "badRequest", "internalServerError"
messagestring
errors

Responses 401

unauthorized

This response has no body.

Responses 403

Status201 400 401 403 409 500application/json

forbiddenResource

Schema ExampleErrorResponse

Same fields as Get a brand kit by id (403).

Schema ExampleErrorResponse

403 · application/json

{
  "messageCode": "string",
  "message": "string",
  "errors": [
    {}
  ]
}

Example · 7 lines

Responses 409

Status201 400 401 403 409 500application/json

A brand kit with this name already exists; the code arrives in errors[] against name. This was documented as a 404 before SUBRITE-638 and has always been a 409

Schema ExampleErrorResponse

3 top-level fieldsSelect an object to expand

messageCodestringRequired
Allowed values: "brandKitAlreadyExists"
messagestring

Responses 500

Status201 400 401 403 409 500application/json

internalServerError

SchemaErrorResponse

Same fields as Get a brand kit by id (403).

Example requestcurl

curl

curl https://api.subrite.no/api/v1/brand-kits \
  --request POST \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "name": "string",
  "hostnameIds": [
    0
  ]
}'

{
  "messageCode": "string",
  "message": "string",
  "errors": [
    {}
  ]
}

string

Schema ExampleErrorResponse

409 · application/json

{
  "messageCode": "brandKitNameAlreadyExists",
  "message": "string",
  "errors": [
    {}
  ]
}

Example · 7 linesShow full heightShow compact view

Schema ExampleErrorResponse

502 · application/json

{
  "messageCode": "tenantAssetUploadFailed",
  "message": "string",
  "errors": [
    {}
  ]
}

Example · 7 linesShow full heightShow compact view

array of FieldError

Schema ExampleErrorResponse

409 · application/json

{
  "messageCode": "brandKitAlreadyExists",
  "message": "string",
  "errors": [
    {}
  ]
}

Example · 7 linesShow full heightShow compact view

Get a brand kit by id#

Parameters

Responses

Responses 200

Responses 400

Responses 401

Responses 403

Responses 404

Responses 500

Update a brand kit#

Parameters

Request body

Delete a brand kit#

Parameters

Responses

Responses 200

Get all brand kits#

Responses

Responses 200

Create a brand kit#

Request body

Get a brand kit by id#

Parameters

Responses

Responses 200

Responses 400

Responses 401

Responses 403

Responses 404

Responses 500

Update a brand kit#

Parameters

Request body

Delete a brand kit#

Parameters

Responses

Responses 200

Get all brand kits#

Responses

Responses 200

Create a brand kit#

Request body

Responses

Responses 201

Responses 400

Responses 401

Responses 403

Responses 404

Responses 409

Responses 500

Responses 502

Responses 400

Responses 401

Responses 403

Responses 409

Responses 500

Responses 401

Responses 403

Responses 500

Responses

Responses 201

Responses 400

Responses 401

Responses 403

Responses 409

Responses 500