QR Codes

Update a QR: label, status, content (payload, validated for its type), targetUrl (url type), design or folder. The printed code does not change.

patch/api/v1/qrs/{id}

Request

  • Base URL: https://qrlia.dev.castlesoft.eu
  • URL: https://qrlia.dev.castlesoft.eu/api/v1/qrs/{id}
  • Auth: one of:
    • HTTP bearer
    • API key in cookie qrc_session

Path parameters

idstring uuid required

Request body

labelstring
status'active' | 'paused' | 'archived'

paused/archived QRs stop redirecting; active resumes.

targetUrlstring uri

URL QRs only: shorthand for changing payload.targetUrl.

payloadobject

Replace the QR's content. Same shape as the type's create field (e.g. profile, menu, wifi payload); validated against the QR's type. The printed code does not change.

designIdstring uuid nullable

Saved design (designs_list) to render this QR with.

folderIdstring uuid nullable

Folder to file the QR in; null = company root. Plan feature qr_folders.

Response

Updated

idstring uuid required
tenantIdstring uuid required
companyIdstring uuid required
type'url' | 'vcard' | 'profile_card' | 'text' | 'email' | 'phone' | 'sms' | 'whatsapp' | 'wifi' | 'pdf' | 'image' | 'audio' | 'video' | 'app' | 'multilink' | 'menu' | 'feedback' | 'event' | 'dpp' | 'coupon' | 'sepa' | 'paypal' | 'crypto' | 'lead_form' required

Discriminator for QR payload shape.

slugstring nullable required
labelstring required
payloadobject required
designIdstring uuid nullable required
folderIdstring uuid nullable required
status'active' | 'paused' | 'archived' required
createdAtstring date-time required
updatedAtstring date-time required
shortLinkstring uri nullable

The link the printed code encodes (https://<host>/r/<slug>).

totalScansinteger

All-time scans; included by list and get.

Changes

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