QR Codes

Update a QR code

Updates the mutable fields of a QR code. Only supplied fields are changed.

patch/qrcodes/{id}

Request

  • Base URL: https://getdynamicqr.com/api/v1
  • URL: https://getdynamicqr.com/api/v1/qrcodes/{id}
  • Auth: API key in header X-Client-ID and HTTP bearer

Path parameters

idinteger required

The QR code ID.

Request body

namestring

A new label.

destination_urlstring

A new destination URL.

is_activeboolean

Enable or disable the QR code.

expires_atstring

ISO-8601 datetime or null to clear.

slugstring

A new short link. Needs the custom_slug plan feature; without it the field is ignored and the existing slug is preserved.

color_foregroundstring

Hex colour for the modules.

color_backgroundstring

Hex background colour.

dot_stylestring

square, rounded, dots, classy, classy_rounded, extra_rounded.

frame_stylestring

none, simple, rounded, bold, banner, label_top.

frame_textstring

Label under the code. Max 50 chars.

show_type_iconboolean

Draw the type's icon in the middle.

expired_urlstring

Where to send scans once the code has expired.

Example request

{
  "color_foreground": "#1d4ed8",
  "color_background": "#ffffff"
}

Response

OK

Changes

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