Update application branding

Request

Path Params

application_identifier

string

required

slug of application (product)

Example:

default

Header Params

Content-Type

enum<string>

required

Details

Allowed value:

application/json

Default:

application/json

X-User-Agent

string

required

Arbitrary identifier of your client. Details

Default:

X-Product-Name

string

required

API Product for API context. Details

Default:

X-Loyalty-Club-Slug

string

required

LoyaltyClub for API context. Details

Default:

X-Customer

string

required

Customer for API context. Details

Default:

X-Client-Authorization

string

optional

Default:

Body Params application/json

application_branding

object (ApplicationBranding)

required

border

string | null

required

Color in hex-rgb format

Examples:

#F0F0F0#FFFFFF

Match pattern:

^#[0-9A-Fa-f]{6}$

border_size

number

required

brand_accent

string | null

required

Color in hex-rgb format

Examples:

#F0F0F0#FFFFFF

Match pattern:

^#[0-9A-Fa-f]{6}$

brand_main

string | null

required

Color in hex-rgb format

Examples:

#F0F0F0#FFFFFF

Match pattern:

^#[0-9A-Fa-f]{6}$

font_family_body

string

required

font_family_header

string

required

font_weight_body_bold

string

required

font_weight_body_regular

string

required

font_weight_header

string

required

radius_large

number

required

radius_small

number

required

semantic_error

string | null

required

Color in hex-rgb format

Examples:

#F0F0F0#FFFFFF

Match pattern:

^#[0-9A-Fa-f]{6}$

semantic_info

string | null

required

Color in hex-rgb format

Examples:

#F0F0F0#FFFFFF

Match pattern:

^#[0-9A-Fa-f]{6}$

semantic_success

string | null

required

Color in hex-rgb format

Examples:

#F0F0F0#FFFFFF

Match pattern:

^#[0-9A-Fa-f]{6}$

semantic_warning

string | null

required

Color in hex-rgb format

Examples:

#F0F0F0#FFFFFF

Match pattern:

^#[0-9A-Fa-f]{6}$

surface_inverse

string | null

required

Color in hex-rgb format

Examples:

#F0F0F0#FFFFFF

Match pattern:

^#[0-9A-Fa-f]{6}$

surface_primary

string | null

required

Color in hex-rgb format

Examples:

#F0F0F0#FFFFFF

Match pattern:

^#[0-9A-Fa-f]{6}$

surface_secondary

string | null

required

Color in hex-rgb format

Examples:

#F0F0F0#FFFFFF

Match pattern:

^#[0-9A-Fa-f]{6}$

text_inverse

string | null

required

Color in hex-rgb format

Examples:

#F0F0F0#FFFFFF

Match pattern:

^#[0-9A-Fa-f]{6}$

text_primary

string | null

required

Color in hex-rgb format

Examples:

#F0F0F0#FFFFFF

Match pattern:

^#[0-9A-Fa-f]{6}$

text_secondary

string | null

required

Color in hex-rgb format

Examples:

#F0F0F0#FFFFFF

Match pattern:

^#[0-9A-Fa-f]{6}$

text_tertiary

string | null

required

Color in hex-rgb format

Examples:

#F0F0F0#FFFFFF

Match pattern:

^#[0-9A-Fa-f]{6}$

Example

{
  "application_branding": {
    "border": "#F0F0F0",
    "border_size": 0,
    "brand_accent": "#F0F0F0",
    "brand_main": "#F0F0F0",
    "font_family_body": "string",
    "font_family_header": "string",
    "font_weight_body_bold": "string",
    "font_weight_body_regular": "string",
    "font_weight_header": "string",
    "radius_large": 0,
    "radius_small": 0,
    "semantic_error": "#F0F0F0",
    "semantic_info": "#F0F0F0",
    "semantic_success": "#F0F0F0",
    "semantic_warning": "#F0F0F0",
    "surface_inverse": "#F0F0F0",
    "surface_primary": "#F0F0F0",
    "surface_secondary": "#F0F0F0",
    "text_inverse": "#F0F0F0",
    "text_primary": "#F0F0F0",
    "text_secondary": "#F0F0F0",
    "text_tertiary": "#F0F0F0"
  }
}

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Responses

🟢200OK

application/json

Body

application_branding

object (ApplicationBranding)

required

integer <uint64>

read-onlyrequired

Example:

border

string | null

required

Color in hex-rgb format

Examples:

#F0F0F0#FFFFFF

Match pattern:

^#[0-9A-Fa-f]{6}$

border_size

number

required

brand_accent

string | null

required

Color in hex-rgb format

Examples:

#F0F0F0#FFFFFF

Match pattern:

^#[0-9A-Fa-f]{6}$

brand_main

string | null

required

Color in hex-rgb format

Examples:

#F0F0F0#FFFFFF

Match pattern:

^#[0-9A-Fa-f]{6}$

font_family_body

string

required

font_family_header

string

required

font_weight_body_bold

string

required

font_weight_body_regular

string

required

font_weight_header

string

required

radius_large

number

required

radius_small

number

required

semantic_error

string | null

required

Color in hex-rgb format

Examples:

#F0F0F0#FFFFFF

Match pattern:

^#[0-9A-Fa-f]{6}$

semantic_info

string | null

required

Color in hex-rgb format

Examples:

#F0F0F0#FFFFFF

Match pattern:

^#[0-9A-Fa-f]{6}$

semantic_success

string | null

required

Color in hex-rgb format

Examples:

#F0F0F0#FFFFFF

Match pattern:

^#[0-9A-Fa-f]{6}$

semantic_warning

string | null

required

Color in hex-rgb format

Examples:

#F0F0F0#FFFFFF

Match pattern:

^#[0-9A-Fa-f]{6}$

surface_inverse

string | null

required

Color in hex-rgb format

Examples:

#F0F0F0#FFFFFF

Match pattern:

^#[0-9A-Fa-f]{6}$

surface_primary

string | null

required

Color in hex-rgb format

Examples:

#F0F0F0#FFFFFF

Match pattern:

^#[0-9A-Fa-f]{6}$

surface_secondary

string | null

required

Color in hex-rgb format

Examples:

#F0F0F0#FFFFFF

Match pattern:

^#[0-9A-Fa-f]{6}$

text_inverse

string | null

required

Color in hex-rgb format

Examples:

#F0F0F0#FFFFFF

Match pattern:

^#[0-9A-Fa-f]{6}$

text_primary

string | null

required

Color in hex-rgb format

Examples:

#F0F0F0#FFFFFF

Match pattern:

^#[0-9A-Fa-f]{6}$

text_secondary

string | null

required

Color in hex-rgb format

Examples:

#F0F0F0#FFFFFF

Match pattern:

^#[0-9A-Fa-f]{6}$

text_tertiary

string | null

required

Color in hex-rgb format

Examples:

#F0F0F0#FFFFFF

Match pattern:

^#[0-9A-Fa-f]{6}$

created_at

string <date-time>

read-onlyrequired

Time of record creation

Example:

2022-11-05T16:25:58.099512Z

updated_at

string <date-time>

read-onlyrequired

Time of the last record update

Example:

2022-11-15T16:25:58.099512Z

application_id

integer <uint64>

read-onlyrequired

Example:

Example

{
  "application_branding": {
    "id": 1,
    "border": "#F0F0F0",
    "border_size": 0,
    "brand_accent": "#F0F0F0",
    "brand_main": "#F0F0F0",
    "font_family_body": "string",
    "font_family_header": "string",
    "font_weight_body_bold": "string",
    "font_weight_body_regular": "string",
    "font_weight_header": "string",
    "radius_large": 0,
    "radius_small": 0,
    "semantic_error": "#F0F0F0",
    "semantic_info": "#F0F0F0",
    "semantic_success": "#F0F0F0",
    "semantic_warning": "#F0F0F0",
    "surface_inverse": "#F0F0F0",
    "surface_primary": "#F0F0F0",
    "surface_secondary": "#F0F0F0",
    "text_inverse": "#F0F0F0",
    "text_primary": "#F0F0F0",
    "text_secondary": "#F0F0F0",
    "text_tertiary": "#F0F0F0",
    "created_at": "2022-11-05T16:25:58.099512Z",
    "updated_at": "2022-11-15T16:25:58.099512Z",
    "application_id": 1
  }
}