QR Codes

Create or update link QR code settings

Saves the QR code settings for the link. Omitted fields are left untouched; send an empty string to clear a text field.

post/links/qr/settings/{linkIdString}

Request

  • Base URL: https://api.short.io
  • URL: https://api.short.io/links/qr/settings/{linkIdString}
  • Auth: API key in header Authorization

Path parameters

linkIdStringstring required

Link ID

Request body

logoUrlstring

URL of the logo image embedded in the QR code

colorstring

6 or 8-character hex color without # prefix (RRGGBB or RRGGBBAA)

backgroundColorstring

6 or 8-character hex color without # prefix (RRGGBB or RRGGBBAA)

logoHeightinteger

Logo height in pixels

logoWidthinteger

Logo width in pixels

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

QR code error correction level

borderRadiusinteger

Dot border radius on the dashboard 0-5 scale, 5 = fully round

noExcavateboolean

Disable logo excavation (cutout) in the QR code

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

Shape of the outer finder pattern

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

Shape of the inner finder pattern

finderColorstring

6 or 8-character hex color without # prefix (RRGGBB or RRGGBBAA)

cornerMode'individual' | 'merge'

Corner module rendering mode

labelTextstring

Optional text label rendered with the QR code

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

Label visual style

labelColorstring

6 or 8-character hex color without # prefix (RRGGBB or RRGGBBAA)

labelBgColorstring

6 or 8-character hex color without # prefix (RRGGBB or RRGGBBAA)

labelFontSizeinteger

Label font size in module units (rendered px = value * block size)

labelFontFamilystring

Label font family name

Example request

{
  "color": "FF0000",
  "backgroundColor": "FF0000",
  "logoHeight": 64,
  "logoWidth": 64,
  "borderRadius": 2,
  "finderColor": "FF0000",
  "labelText": "Scan me",
  "labelColor": "FF0000",
  "labelBgColor": "FF0000",
  "labelFontSize": 5,
  "labelFontFamily": "Arial"
}

Response

Default Response

Changes

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