Skip to main content
POST
Update a QR code

Authorizations

X-API-Key
string
header
required

Your API key, for example dlk_live_.... Create one in the dashboard under Settings → API Keys. Keys are shown once at creation and stored only as a hash, so they cannot be recovered.

Body

multipart/form-data
name
string
required

The resource identifier.

background_color
string

QR background fill color, as a hex string. Defaults to #FFFFFF.

background_color_secondary
string

Second gradient stop color when background_style is Gradient, as hex. Defaults to #FFFFFF.

background_style
string

Background fill: Solid or Gradient. Defaults to Solid.

Center-logo style for the code, by name. Determines whether a center image or text is shown.

center_logo_size_rem
string

Center-logo size in rem. Clamped to 0.9–5.0; defaults to 3.0.

center_logo_text
string

Text rendered as the center logo when the center style is the custom-text type.

code_corner_style
string

Finder/corner-eye style: square, rounded, circle, circle-rounded, circle-diamond, circle-star or rounded-circle. Defaults to square.

code_pattern
string

Module (dot) pattern: square, rounded, dot, dot-small, diamond, star, fluid, fluid-line, stripe, stripe-row, stripe-column or tile. Defaults to square.

code_shape
string

Overall code outline: square or circle. Defaults to square.

corner_color
string

Color of the corner/finder eyes, as hex. Defaults to #000000.

frame
string

Decorative frame around the code, by name (for example Flat border without text, Price Tag, Ticket Stub). Optional.

frame_color
string

Frame color, as hex. Optional.

frame_palette
string

Rich-frame color palette as a JSON object with primary and secondary keys. Optional.

frame_text
string

Primary caption / call-to-action text shown in the frame.

frame_text_color
string

Frame caption text color, as hex. Defaults to #ffffff.

frame_text_font_size_rem
string

Frame caption font size in rem. Clamped to 1.0–1.9; defaults to 1.3.

frame_text_secondary
string

Secondary (second-line) frame caption text.

Whether to show Dashlink branding on the code. Send true or false.

is_transparent_background
string

Whether the background is transparent. Send 1 or 0. Defaults to 0.

pattern_color
string

Color of the QR data modules, as hex. Defaults to #000000.

title
string

Human-readable name shown in the dashboard.

center_logo_image
file

Uploaded center-logo image (jpeg/jpg/png, up to 500 KB, 100×100 to 1000×1000 px).

file_path
file

The uploaded file itself (binary), sent as a multipart file part — not a server path.

jpeg_file_path
file

Uploaded JPEG export of the code (up to 5 MB).

svg_file_path
file

Uploaded SVG export of the code (up to 5 MB).

Response

Success.

data
object

The endpoint's payload.