Join us now
← Back to API Reference overview

QR Code Designs

Endpoints for managing QR Code Designs in Linkbreakers. These endpoints allow you to create, retrieve, update, and delete QR Code Designs.

Shortcut: ⌘K

#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

object

BackgroundOptions represents the styling options for the QR code background

centralImageSignedUrl

string

The 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

object

CornersDotOptions represents the styling options for the dot corners in the QR code

cornersSquareOptions

object

CornersSquareOptions represents the styling options for the square corners in the QR code

createdAt

string (date-time)

When the QR code design was created

dotsOptions

object

DotsOptions represents the styling options for the dots in the QR code

errorCorrectionLevel

string

Error correction level forwarded to the QR renderer ("L","M","Q","H")

height

integer (int32)

Export height in pixels

hideBackgroundDots

boolean

Whether to remove dots behind the central image to improve contrast

id

string

The unique identifier of the QR code design (UUID)

outputFileFormat

string (enum)

The output file format for the QR code

Allowed values
OUTPUT_FILE_FORMAT_UNSPECIFIED

Output format not specified (defaults to PNG server-side)

OUTPUT_FILE_FORMAT_SVG

Scalable Vector Graphics format for infinite resolution

OUTPUT_FILE_FORMAT_PNG

Portable Network Graphics format with transparency support

OUTPUT_FILE_FORMAT_JPEG

Joint Photographic Experts Group format for compressed images

OUTPUT_FILE_FORMAT_WEBP

WebP format for modern web-optimized compression

shape

string (enum)

The shape of the QR code

Allowed values
SHAPE_UNSPECIFIED

Shape not specified (defaults to square modules)

SHAPE_SQUARE

Traditional square modules for QR code data points

SHAPE_CIRCLE

Circular 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

GET/v1/qrcode-designs/{id}Requires auth

#Get a QR code design

Fetch a QR code design by its identifier including computed metadata.

#Parameters

path parameters

id

stringRequiredpath

The ID of the QR code design to get (UUID)

#Response

200

Everything worked as expected.

qrcodeDesign

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.

#Error response

400-599

All endpoints may return an unexpected error payload when a request cannot be processed.

error

objectRequired

Wrapped error response.

POST/v1/qrcode-designsRequires auth

#Create a new QR code design

Provision a QR code styling preset that can be reused across links or templates.

#Parameters

This endpoint does not accept any parameters.

#Request body

backgroundOptions

object

BackgroundOptions represents the styling options for the QR code background

centralImageData

string

The image to use as the central image of the QR Code. The file size limit is 3MB. It must be transmitted in a base64 string format when sending it through HTTP.

centralImageSize

number (double)

The size of the central image relative to the QR code

cornersDotOptions

object

CornersDotOptions represents the styling options for the dot corners in the QR code

cornersSquareOptions

object

CornersSquareOptions represents the styling options for the square corners in the QR code

dotsOptions

object

DotsOptions represents the styling options for the dots in the QR code

errorCorrectionLevel

string

The error correction level of the QR code

height

integer (int32)

The height of the QR code

hideBackgroundDots

boolean

Whether to hide the background dots

outputFileFormat

string (enum)

The output file format for the QR code

Allowed values
OUTPUT_FILE_FORMAT_UNSPECIFIED

Output format not specified (defaults to PNG server-side)

OUTPUT_FILE_FORMAT_SVG

Scalable Vector Graphics format for infinite resolution

OUTPUT_FILE_FORMAT_PNG

Portable Network Graphics format with transparency support

OUTPUT_FILE_FORMAT_JPEG

Joint Photographic Experts Group format for compressed images

OUTPUT_FILE_FORMAT_WEBP

WebP format for modern web-optimized compression

shape

string (enum)

The shape of the QR code

Allowed values
SHAPE_UNSPECIFIED

Shape not specified (defaults to square modules)

SHAPE_SQUARE

Traditional square modules for QR code data points

SHAPE_CIRCLE

Circular modules for a rounded visual appearance

width

integer (int32)

The width of the QR code

#Response

200

Everything worked as expected.

qrcodeDesign

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.

#Error response

400-599

All endpoints may return an unexpected error payload when a request cannot be processed.

error

objectRequired

Wrapped error response.

PATCH/v1/qrcode-designs/{id}Requires auth

#Update a QR code design

Apply styling tweaks or media changes to an existing QR code design.

#Parameters

path parameters

id

stringRequiredpath

The ID of the QR code design to update (UUID)

#Request body

backgroundOptions

object

BackgroundOptions represents the styling options for the QR code background

centralImageData

string

The image to use as the central image of the QR Code. The file size limit is 3MB. It must be transmitted in a base64 string format when sending it through HTTP.

centralImageDelete

boolean

Set this to true to delete the central image. It can't be used at the same time as transmitting a central image.

centralImageSize

number (double)

The size of the central image relative to the QR code

cornersDotOptions

object

CornersDotOptions represents the styling options for the dot corners in the QR code

cornersSquareOptions

object

CornersSquareOptions represents the styling options for the square corners in the QR code

dotsOptions

object

DotsOptions represents the styling options for the dots in the QR code

errorCorrectionLevel

string

The error correction level of the QR code

height

integer (int32)

The height of the QR code

hideBackgroundDots

boolean

Whether to hide the background dots

outputFileFormat

string (enum)

The output file format for the QR code

Allowed values
OUTPUT_FILE_FORMAT_UNSPECIFIED

Output format not specified (defaults to PNG server-side)

OUTPUT_FILE_FORMAT_SVG

Scalable Vector Graphics format for infinite resolution

OUTPUT_FILE_FORMAT_PNG

Portable Network Graphics format with transparency support

OUTPUT_FILE_FORMAT_JPEG

Joint Photographic Experts Group format for compressed images

OUTPUT_FILE_FORMAT_WEBP

WebP format for modern web-optimized compression

shape

string (enum)

The shape of the QR code

Allowed values
SHAPE_UNSPECIFIED

Shape not specified (defaults to square modules)

SHAPE_SQUARE

Traditional square modules for QR code data points

SHAPE_CIRCLE

Circular modules for a rounded visual appearance

width

integer (int32)

The width of the QR code

#Response

200

Everything worked as expected.

qrcodeDesign

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.

#Error response

400-599

All endpoints may return an unexpected error payload when a request cannot be processed.

error

objectRequired

Wrapped error response.

DELETE/v1/qrcode-designs/{id}Requires auth

#Delete a QR code design

Remove a QR code design that is no longer in use by any assets.

#Parameters

path parameters

id

stringRequiredpath

The ID of the QR code design to delete

#Response

200

Everything worked as expected.

No structured schema available for this section.

#Error response

400-599

All endpoints may return an unexpected error payload when a request cannot be processed.

error

objectRequired

Wrapped error response.