QR THEME

Style information for QR code themes

QR themes can be applied to chat flows to customize the appearance of the QR codes that are generated when publishing.

Request

{
    "name":           "STRING",
    "background":     "STRING",
    "foreground":     "STRING",
    "hasBorder":      BOOLEAN,
    "imageUrl":       "STRING",
    "textIdentifier": "STRING"
}

Response

{
    "qrThemeId":      INTEGER IDENTIFIER,
    "name":           "STRING",
    "background":     "STRING",
    "foreground":     "STRING",
    "hasBorder":      BOOLEAN,
    "imageUrl":       "STRING",
    "textIdentifier": "STRING",
    "updated":        DATETIME
}

Meta Attributes

name

The human readable name for the theme.

qrThemeId

The unique integer identifier for the theme which is generated while creating the theme.

textIdentifier

A human readable string that is displayed below the QR code.

updated

The datetime the theme was created in RFC3339 format.

Style Attributes

background

The hex color code for the background color of the QR code.

foreground

The hex color code for the foreground color of the QR code.

hasBorder

Setting this attribute true will add a margin around the edges of the QR code with the background color.

imageUrl

The URL for the hosted image. This image will be applied to the center of the QR code.

textIdentifier

A human readable string that is displayed below the QR code.