QR Codes

Create or update domain QR code settings

Creates or updates the default QR code settings applied to the domain's links.

post/domains/qrCodeSettings/{domainId}

Request

  • Base URL: https://api.short.io
  • URL: https://api.short.io/domains/qrCodeSettings/{domainId}
  • Auth: API key in header Authorization

Path parameters

domainIdnumber required

Domain ID

Request body

colorstring

QR code foreground color as hex (RRGGBB or RRGGBBAA)

backgroundColorstring

QR code background color as hex

logoUrlstring

URL of the logo image embedded in the QR code

logoHeightnumber

Logo height in pixels

logoWidthnumber

Logo width in pixels

ecLevel'L' | 'M' | 'Q' | 'H'

QR code error correction level

borderRadiusnumber

Module border radius in pixels

noExcavateboolean

Disable logo area excavation

finderOuterShape'square' | 'rounded' | 'circle' | 'drop'

Shape of the outer finder pattern

finderInnerShape'square' | 'rounded' | 'circle' | 'drop'

Shape of the inner finder pattern

finderColorstring

Finder pattern color as hex

cornerMode'individual' | 'merge'

Corner module rendering mode

labelTextstring

Optional text label rendered with the QR code

labelStyle'below' | 'pill' | 'box'

Label visual style

labelColorstring

Label text color as hex

labelBgColorstring

Label background color as hex

labelFontSizenumber

Label font size in pixels

labelFontFamilystring

Label font family name

Example request

{
  "color": "000000",
  "backgroundColor": "ffffff",
  "logoUrl": "https://shortiougc.com/qr-code-settings-logo/example.com/logo.png",
  "logoHeight": 64,
  "logoWidth": 64,
  "borderRadius": 4,
  "finderColor": "000000",
  "labelText": "Scan me",
  "labelColor": "000000",
  "labelBgColor": "ffffff",
  "labelFontSize": 14,
  "labelFontFamily": "Arial"
}

Response

Default Response

Changes

No recorded changes to this operation across all 1 revision of this API.