QR Codes

Create a QR. Either supply `templateId` or `type` + per-type fields.

post/api/v1/qrs

Request

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

Request body

OR

Response

Created

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.