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

QrcodeDesign represents a QR code design configuration

backgroundOptions

object

centralImageSignedUrl

string

centralImageSize

number (double)

cornersDotOptions

object

cornersSquareOptions

object

createdAt

string (date-time)

dotsOptions

object

errorCorrectionLevel

string

height

integer (int32)

hideBackgroundDots

boolean

id

string

outputFileFormat

string (enum)
Allowed values
OUTPUT_FILE_FORMAT_UNSPECIFIED
OUTPUT_FILE_FORMAT_SVG
OUTPUT_FILE_FORMAT_PNG
OUTPUT_FILE_FORMAT_JPEG
OUTPUT_FILE_FORMAT_WEBP

shape

string (enum)
Allowed values
SHAPE_UNSPECIFIED
SHAPE_SQUARE
SHAPE_CIRCLE

updatedAt

string (date-time)

width

integer (int32)
GET/v1/qrcode-designs/{id}Requires auth

#Get a QR code design

#Parameters

path parameters

id

stringRequiredpath

#Response

200

Everything worked as expected.

qrcodeDesign

object

#Error response

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

If you don't attach it to any link or QR Code template, it will automatically be deleted after 1 day.

#Parameters

This endpoint does not accept any parameters.

#Request body

backgroundOptions

object

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)

cornersDotOptions

object

cornersSquareOptions

object

dotsOptions

object

errorCorrectionLevel

string

height

integer (int32)

hideBackgroundDots

boolean

outputFileFormat

string (enum)
Allowed values
OUTPUT_FILE_FORMAT_UNSPECIFIED
OUTPUT_FILE_FORMAT_SVG
OUTPUT_FILE_FORMAT_PNG
OUTPUT_FILE_FORMAT_JPEG
OUTPUT_FILE_FORMAT_WEBP

shape

string (enum)
Allowed values
SHAPE_UNSPECIFIED
SHAPE_SQUARE
SHAPE_CIRCLE

width

integer (int32)

#Response

200

Everything worked as expected.

qrcodeDesign

object

#Error response

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

#Parameters

path parameters

id

stringRequiredpath

#Request body

backgroundOptions

object

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)

cornersDotOptions

object

cornersSquareOptions

object

dotsOptions

object

errorCorrectionLevel

string

height

integer (int32)

hideBackgroundDots

boolean

outputFileFormat

string (enum)
Allowed values
OUTPUT_FILE_FORMAT_UNSPECIFIED
OUTPUT_FILE_FORMAT_SVG
OUTPUT_FILE_FORMAT_PNG
OUTPUT_FILE_FORMAT_JPEG
OUTPUT_FILE_FORMAT_WEBP

shape

string (enum)
Allowed values
SHAPE_UNSPECIFIED
SHAPE_SQUARE
SHAPE_CIRCLE

width

integer (int32)

#Response

200

Everything worked as expected.

qrcodeDesign

object

#Error response

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

You can only delete a QR code design if it is not used in any QR code or QR Code template.

#Parameters

path parameters

id

stringRequiredpath

#Response

200

Everything worked as expected.

No structured schema available for this section.

#Error response

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

error

objectRequired

Wrapped error response.