QR Codes

Create a QR code

Supports all 14 QR types. URL-based types (url, video, social, app, pdf, coupon, menu) use destination_url. Content types (wifi, vcard, email, sms, phone, text, whatsapp) pass their fields inside qr_meta as a key-value object.

qr_meta fields per type: whatsapp: { phone, message } wifi: { ssid, password, encryption (WPA|WEP|nopass) } vcard: { name, phone, email, organization, title, website, address } email: { to, subject, body } sms: { phone, message } phone: { phone } text: { content }

post/qrcodes

Request

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

Request body

namestring required

Label for the QR code.

qr_typestring

One of: url, whatsapp, wifi, vcard, email, sms, phone, text, video, social, app, pdf, coupon, menu. Default: url.

destination_urlstring

Required for url/video/social/app/pdf/coupon/menu types.

qr_metaobject

Type-specific fields (see below).

color_foregroundstring

Hex colour for QR dots.

color_backgroundstring

Hex background colour.

frame_textstring

Label text below QR frame.

expires_atstring

ISO-8601 expiry datetime.

expired_urlstring

Fallback URL after expiry.

design_presetstring

A QR Studio look to create the code already wearing. Requires the qr_studio plan flag.

designobject

QR Studio fields, applied over design_preset (or over the studio defaults on their own). Requires the qr_studio plan flag.

slugstring

A memorable short link, e.g. summer-menu, in place of the uuid. Needs the custom_slug plan feature; sent without it, it is ignored rather than refused.

dot_stylestring

Module shape: square, rounded (default), dots, classy, classy_rounded, extra_rounded.

frame_stylestring

Frame around the code: none, simple (default), rounded, bold, banner, label_top.

show_type_iconboolean

Draw the type's icon in the middle. Default: true. Ignored when the code carries a logo.

Example request

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

Response

Created

Changes

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