#The QR Code Design object
Captures the visual recipe Linkbreakers uses when rendering downloadable QR codes, including colors, shapes, export options, and center media. QR Code Designs are the visual representation of a link. They can be attached to QR Code Templates for reusability. They can only be attached to one record at a time.
backgroundOptions
objectBackgroundOptions represents the styling options for the QR code background
centralImageSignedUrl
stringThe signed URL for the central image This URL eventually expires
centralImageSize
number (double)The size of the central image relative to the QR code (0.0-1.0 proportion)
cornersDotOptions
objectCornersDotOptions represents the styling options for the dot corners in the QR code
cornersSquareOptions
objectCornersSquareOptions represents the styling options for the square corners in the QR code
createdAt
string (date-time)When the QR code design was created
dotsOptions
objectDotsOptions represents the styling options for the dots in the QR code
errorCorrectionLevel
stringError correction level forwarded to the QR renderer ("L","M","Q","H")
height
integer (int32)Export height in pixels
hideBackgroundDots
booleanWhether to remove dots behind the central image to improve contrast
id
stringThe unique identifier of the QR code design (UUID)
outputFileFormat
string (enum)The output file format for the QR code
Allowed values
OUTPUT_FILE_FORMAT_UNSPECIFIEDOutput format not specified (defaults to PNG server-side)
OUTPUT_FILE_FORMAT_SVGScalable Vector Graphics format for infinite resolution
OUTPUT_FILE_FORMAT_PNGPortable Network Graphics format with transparency support
OUTPUT_FILE_FORMAT_JPEGJoint Photographic Experts Group format for compressed images
OUTPUT_FILE_FORMAT_WEBPWebP format for modern web-optimized compression
shape
string (enum)The shape of the QR code
Allowed values
SHAPE_UNSPECIFIEDShape not specified (defaults to square modules)
SHAPE_SQUARETraditional square modules for QR code data points
SHAPE_CIRCLECircular modules for a rounded visual appearance
updatedAt
string (date-time)When the QR code design was last updated
width
integer (int32)Export width in pixels