curl --request PATCH \
--url https://management.scanova.io/qr/{qrid}/ \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--data '{
"form": 301
}'
{}Form Management
Attach Form to QR Code
PATCH
/
qr
/
{qrid}
curl --request PATCH \
--url https://management.scanova.io/qr/{qrid}/ \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--data '{
"form": 301
}'
{}Documentation Index
Fetch the complete documentation index at: https://docs.scanova.io/llms.txt
Use this file to discover all available pages before exploring further.
Overview
Attaches a form to a QR code. When users scan the QR code, they will be prompted to fill out the form before accessing the content.Path Parameters
| Parameter | Type | Required | Description | Example |
|---|---|---|---|---|
qrid | string | Yes | QR code ID | Qc3ca09e1a5574caf |
Request Body
| Field | Type | Required | Description | Example |
|---|---|---|---|---|
form | integer | Yes | Form ID to attach to the QR code | 301 |
Examples
Attach Form to QR Code
curl -X PATCH "https://management.scanova.io/qr/Qc3ca09e1a5574caf/" \
-H "Authorization: YOUR_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"form": 301
}'
Response
Returns the updated QR code object with the form information included in thedynamic_url_object.
Form Behavior
When a form is attached to a QR code:- User scans QR code
- Form is displayed (based on form configuration)
- User fills out the form (or skips if allowed)
- User is redirected to the original QR code content
- Submission data is captured and stored
Important Notes
- One Form Per QR Code: Each QR code can only have one form attached
- Multiple QR Codes: One form can be attached to multiple QR codes
- Active Forms Only: Only active forms can be attached
- Immediate Effect: Changes take effect immediately
Use Cases
- Lead Generation: Capture leads from QR code scans
- Event Registration: Collect attendee information at events
- Customer Feedback: Gather feedback before accessing content
- Contact Collection: Build contact lists from QR code interactions
- Survey Data: Collect survey responses through QR codes
The form must be active (
is_active: true) to be attached to a QR code. If you try to attach an inactive form, the request will fail.Attaching a form to a QR code will immediately start capturing submissions. Make sure your form is properly configured before attaching.
Authorizations
API key authentication. Enter your API key directly in the Authorization header.
Path Parameters
QR code ID
Body
application/json
- Option 1
- Option 2
Form ID to attach to the QR code
Example:
301
Response
QR code updated successfully
Updated QR code object with form information
Was this page helpful?
⌘I