QR codes

Manage saved QR code images for genie conversation pages

Manage saved QR code images generated for genies. QR codes link directly to genie conversation pages.

Users can only view and manage their own QR codes. There is no admin mode for this resource.

---

List QR codes

Lists all saved QR codes for the authenticated user.

resource · string · required

Must be "qr-code".

action · string · required

Must be "all".

data · object

Show properties

agentId · string

Filter to QR codes for a specific genie.

success · boolean

data · object

Show properties

items · array

Array of QR code objects. Maximum 100 records, ordered by creation date (newest first).

cURL

curl -s -X POST https://api.helpgenie.ai/v1/qr-code \
  -H "Authorization: Bearer hg_live_YOUR_KEY" \
  -H "Content-Type: application/json" \
  -d '{ "action": "all" }'

---

Create QR code

Creates a new QR code record.

resource · string · required

Must be "qr-code".

action · string · required

Must be "create".

data · object · required

Show properties

agent_id · string · required

Genie this QR code links to.

storage_path · string · required

File path in the storage bucket.

storage_url · string · required

Public URL of the QR image.

format · string · required

Image format (for example "png", "svg").

file_size · number

File size in bytes.

display_config · object

Custom display configuration.

target_url · string

URL the QR code points to.

filename · string

Display filename.

---

Delete QR code

Soft-deletes a QR code record (sets is_deleted to true).

resource · string · required

Must be "qr-code".

action · string · required

Must be "delete".

id · string · required

The QR code record ID.

---

Increment download

Increments the download counter for a QR code.

resource · string · required

Must be "qr-code".

action · string · required

Must be "increment-download".

id · string · required

The QR code record ID.

data · object · required

Show properties

downloadCount · number · required

Current download count (will be incremented by 1).