Tools

Delete Qr Code

Permanently delete a QR code from your Uniqode account. This action cannot be undone. Deleting a dynamic code affects its managed destination; content encoded directly in a static code is unaffected.

Get Qr Code

Retrieve detailed information about a specific QR code by its ID, including its campaign configuration, visual attributes, associated place, and metadata.

List Beacons

List and search BLE beacons in your Uniqode account. Returns beacon details including hardware status (battery, temperature), iBeacon identifiers, associated campaigns, and last heartbeat timestamps.

List Digital Business Cards

List digital business cards with organization, state, owner, and page filters.

Get Analytics

Retrieve analytics data for QR codes, beacons, NFC tags, or geofences. Supports three report types: - **overview**: Aggregate counts (notifications, impressions, conversions, unique visitors) for a product type. - **performance**: Time-series data with configurable intervals for tracking trends. - **impressions**: Individual impression records with timestamps and user agent details. Requires an organization ID and a time range specified as epoch milliseconds.

List Places

List places (physical locations) in your Uniqode account. Places serve as organizational containers for beacons, NFC tags, QR codes, and geofences. Each place can be associated with a Google Place ID and geographic coordinates.

List Qr Codes

List and search QR codes in your Uniqode account. Supports searching by name, filtering by organization, and sorting by various fields. Returns paginated results with QR code details including their campaign type, URL, and metadata.

Set Digital Business Card State

Activate or deactivate a digital business card. Uniqode rejects requests for a card already in the requested state.

Create Digital Business Card

Create a digital business card with contact information and required design settings.

Get Digital Business Card

Retrieve a digital business card, including its contact fields, design, owner, and state.

Update Digital Business Card

Update a digital business card. Uniqode requires first name and customizations in every update; retrieve the existing card first to retain its settings.

Get Qr Code Analytics

Query the current QR Code Analytics API for scan counts, unique scanners, per-code scans, countries, devices, or a period overview. Returns the actual report including provider pagination when present.

Update Beacon

Update an existing BLE beacon's name, campaign, place association, or other properties. Beacons are provisioned through hardware and cannot be created via the API, but their configuration can be modified.

Update Nfc Tag

Update an existing NFC tag's name, campaign, or place association. NFC tags are provisioned through hardware and cannot be created via the API, but their configuration can be modified.

List Geofences

List and search geofences in your Uniqode account. Returns geofence details including geographic coordinates, radius, associated campaigns, and places.

Create Qr Code

Create a new static or dynamic QR code. Dynamic QR codes support campaigns (URL redirect, landing page, form, etc.) and allow changing the destination after deployment. Static QR codes encode content directly and cannot be tracked or modified after creation. Use **qrType 1** for static and **qrType 2** for dynamic. Customize the design with attributes like colors, patterns, and logos.

Manage Landing Page

Create, update, or list landing pages (Markdown Cards) used in campaigns. Landing pages are mobile-friendly pages that can be linked to QR codes, beacons, NFC tags, or geofences. Use **action "list"** to browse existing pages, **"create"** to make a new one, or **"update"** to modify content.

Get Form Responses

Retrieve form responses submitted through feedback forms linked to campaigns. Can also list available forms. Use this to access lead capture data and survey responses collected via QR code, beacon, or NFC interactions.

Update Qr Code

Update an existing dynamic QR code's name, campaign, visual attributes, or place association. Dynamic QR codes can have their destination or campaign changed after deployment without regenerating the code.

Delete Digital Business Card

Permanently delete a digital business card.

Manage Geofence

Create, update, or delete a geofence. Geofences define circular geographic areas that trigger campaigns when users enter the zone. Use **action "create"** to define a new geofence with coordinates and radius, **"update"** to modify an existing one, or **"delete"** to remove it.

Set Qr Code State

Activate or deactivate a dynamic QR code without deleting it. Applies only to dynamic QR codes.

List Organizations

Discover the organizations accessible with the current API key and their IDs for QR codes, cards, and analytics.

List Nfc Tags

List and search NFC tags in your Uniqode account. Returns tag details including their UID, scan counter, associated campaigns, and state. NFC tags are provisioned through hardware and managed via this API.