QR codes

Dynamic QR codes per placement (hoarding, newspaper, site board, brochure, event stall, CP flyer) with attribution, validity windows, scan analytics (unique devices, leads, visits, won) and print-ready images and sheets.

GET/v1/qr-codes

QR codes

Newest first, with scan counts, the placement window and where each code leads now.

Access: Signed-in members only (web or Android session) — not for API keys. Permission marketing.view.

Parameters

source_idquery: Id
Opaque record id.
project_idquery: Id
Opaque record id.
placementquery: QrPlacement

Response · 200

datarequired: array of QrCode
metarequired: object

Request

curl -X GET 'https://api.propzolo.com/v1/qr-codes' \
  -H 'Authorization: Bearer pz_live_…'

Response example

{
  "data": [
    {
      "id": "cmusrceel0000q7kaafxqi1om",
      "name": "string",
      "short_code": "string",
      "short_url": "string",
      "scans": 0,
      "placement": "hoarding",
      "sub_source": "string",
      "source": {
        "id": "cmusrceel0000q7kaafxqi1om",
        "name": "string"
      },
      "campaign": {
        "id": "cmusrceel0000q7kaafxqi1om",
        "name": "string"
      },
      "project": {
        "id": "cmusrceel0000q7kaafxqi1om",
        "name": "string"
      },
      "utm_campaign": "string",
      "utm_content": "string",
      "valid_from": "2026-10-06T05:30:00.000Z",
      "valid_until": "2026-10-06T05:30:00.000Z",
      "is_active": true,
      "state": "live",
      "target": {
        "kind": "form",
        "id": "cmusrceel0000q7kaafxqi1om",
        "label": "string",
        "url": "string"
      },
      "last_scan_at": "2026-10-06T05:30:00.000Z",
      "created_at": "2026-10-06T05:30:00.000Z",
      "updated_at": "2026-10-06T05:30:00.000Z"
    }
  ],
  "meta": {}
}

Errors

401 No valid session or API key (missing, expired or revoked).
403 The caller lacks the permission, API-key scope or support grant this operation needs.
422 Invalid input; `error.fields` maps field paths to messages.
429 Too many requests; retry after the Retry-After header.
500 Unexpected error; quote `error.request_id` to support.

POST/v1/qr-codes

Create a QR code

Access: Signed-in members only (web or Android session) — not for API keys. Permission marketing.edit.

Parameters

Idempotency-Keyheader: string
Unique key (a UUID) per logical request. A retry with the same key and body replays the first response for 24 hours (marked Idempotent-Replayed: true); the same key with another body is a 409.

Request body

namerequired: string
targetrequired: QrTargetInput
short_code: string or null
A custom code ("orr-hoarding"); generated when absent. Fixed once created.
source_id: Id or null
Opaque record id.
placement: QrPlacement
sub_source: string or null
The exact spot ("ORR junction, facing the flyover") → leads.sub_source.
campaign_id: Id or null
Opaque record id.
project_id: Id or null
Opaque record id.
utm_campaign: string or null
utm_content: string or null
valid_from: string (date-time) or null
valid_until: string (date-time) or null
is_active: boolean

Response · 201

datarequired: QrCode
metarequired: object

Request

curl -X POST 'https://api.propzolo.com/v1/qr-codes' \
  -H 'Authorization: Bearer pz_live_…' \
  -H 'Idempotency-Key: 6c0f1d3e-…' \
  -H 'Content-Type: application/json' \
  -d '{"name":"string","target":{"kind":"form","id":"cmusrceel0000q7kaafxqi1om"},"short_code":"string","source_id":"cmusrceel0000q7kaafxqi1om","placement":"hoarding","sub_source":"string","campaign_id":"cmusrceel0000q7kaafxqi1om","project_id":"cmusrceel0000q7kaafxqi1om","utm_campaign":"string","utm_content":"string","valid_from":"2026-10-06T05:30:00.000Z","valid_until":"2026-10-06T05:30:00.000Z","is_active":true}'

Response example

{
  "data": {
    "id": "cmusrceel0000q7kaafxqi1om",
    "name": "string",
    "short_code": "string",
    "short_url": "string",
    "scans": 0,
    "placement": "hoarding",
    "sub_source": "string",
    "source": {
      "id": "cmusrceel0000q7kaafxqi1om",
      "name": "string"
    },
    "campaign": {
      "id": "cmusrceel0000q7kaafxqi1om",
      "name": "string"
    },
    "project": {
      "id": "cmusrceel0000q7kaafxqi1om",
      "name": "string"
    },
    "utm_campaign": "string",
    "utm_content": "string",
    "valid_from": "2026-10-06T05:30:00.000Z",
    "valid_until": "2026-10-06T05:30:00.000Z",
    "is_active": true,
    "state": "live",
    "target": {
      "kind": "form",
      "id": "cmusrceel0000q7kaafxqi1om",
      "label": "string",
      "url": "string"
    },
    "last_scan_at": "2026-10-06T05:30:00.000Z",
    "created_at": "2026-10-06T05:30:00.000Z",
    "updated_at": "2026-10-06T05:30:00.000Z"
  },
  "meta": {}
}

Errors

401 No valid session or API key (missing, expired or revoked).
403 The caller lacks the permission, API-key scope or support grant this operation needs.
409 A unique value already exists, a concurrent change won, or the Idempotency-Key is still in use or was sent with a different request.
422 Invalid input; `error.fields` maps field paths to messages.
429 Too many requests; retry after the Retry-After header.
500 Unexpected error; quote `error.request_id` to support.

GET/v1/qr-codes/stats

QR placement analytics

Per code for [from, to): people’s scans, unique devices, leads whose enquiries came through the code, and of those the leads with a site visit done and won. Aggregates only. Default: the last 30 days.

Access: Signed-in members only (web or Android session) — not for API keys. Permission marketing.view.

Parameters

fromquery: string (date-time)
toquery: string (date-time)

Response · 200

datarequired: QrStats
metarequired: object

Request

curl -X GET 'https://api.propzolo.com/v1/qr-codes/stats' \
  -H 'Authorization: Bearer pz_live_…'

Response example

{
  "data": {
    "from": "2026-10-06T05:30:00.000Z",
    "to": "2026-10-06T05:30:00.000Z",
    "codes": [
      {
        "scans": 0,
        "unique_devices": 0,
        "leads": 0,
        "visits": 0,
        "won": 0,
        "rates": {
          "scan_to_lead": 0,
          "lead_to_visit": 0,
          "visit_to_won": 0
        },
        "qr_id": "cmusrceel0000q7kaafxqi1om"
      }
    ],
    "totals": {
      "scans": 0,
      "unique_devices": 0,
      "leads": 0,
      "visits": 0,
      "won": 0,
      "rates": {
        "scan_to_lead": 0,
        "lead_to_visit": 0,
        "visit_to_won": 0
      }
    }
  },
  "meta": {}
}

Errors

401 No valid session or API key (missing, expired or revoked).
403 The caller lacks the permission, API-key scope or support grant this operation needs.
422 Invalid input; `error.fields` maps field paths to messages.
429 Too many requests; retry after the Retry-After header.
500 Unexpected error; quote `error.request_id` to support.

GET/v1/qr-codes/{id}

A QR code

Access: Signed-in members only (web or Android session) — not for API keys. Permission marketing.view.

Parameters

idpathrequired: Id
Opaque record id.

Response · 200

datarequired: QrCode
metarequired: object

Request

curl -X GET 'https://api.propzolo.com/v1/qr-codes/{id}' \
  -H 'Authorization: Bearer pz_live_…'

Response example

{
  "data": {
    "id": "cmusrceel0000q7kaafxqi1om",
    "name": "string",
    "short_code": "string",
    "short_url": "string",
    "scans": 0,
    "placement": "hoarding",
    "sub_source": "string",
    "source": {
      "id": "cmusrceel0000q7kaafxqi1om",
      "name": "string"
    },
    "campaign": {
      "id": "cmusrceel0000q7kaafxqi1om",
      "name": "string"
    },
    "project": {
      "id": "cmusrceel0000q7kaafxqi1om",
      "name": "string"
    },
    "utm_campaign": "string",
    "utm_content": "string",
    "valid_from": "2026-10-06T05:30:00.000Z",
    "valid_until": "2026-10-06T05:30:00.000Z",
    "is_active": true,
    "state": "live",
    "target": {
      "kind": "form",
      "id": "cmusrceel0000q7kaafxqi1om",
      "label": "string",
      "url": "string"
    },
    "last_scan_at": "2026-10-06T05:30:00.000Z",
    "created_at": "2026-10-06T05:30:00.000Z",
    "updated_at": "2026-10-06T05:30:00.000Z"
  },
  "meta": {}
}

Errors

401 No valid session or API key (missing, expired or revoked).
403 The caller lacks the permission, API-key scope or support grant this operation needs.
404 Not found — records of another company are reported the same way.
422 Invalid input; `error.fields` maps field paths to messages.
429 Too many requests; retry after the Retry-After header.
500 Unexpected error; quote `error.request_id` to support.

PATCH/v1/qr-codes/{id}

Update a QR code

Name, attribution, validity window and target — printed codes follow the new target at once.

Access: Signed-in members only (web or Android session) — not for API keys. Permission marketing.edit.

Parameters

idpathrequired: Id
Opaque record id.

Request body

name: string
target: QrTargetInput
source_id: Id or null
Opaque record id.
placement: QrPlacement
sub_source: string or null
The exact spot ("ORR junction, facing the flyover") → leads.sub_source.
campaign_id: Id or null
Opaque record id.
project_id: Id or null
Opaque record id.
utm_campaign: string or null
utm_content: string or null
valid_from: string (date-time) or null
valid_until: string (date-time) or null
is_active: boolean

Response · 200

datarequired: QrCode
metarequired: object

Request

curl -X PATCH 'https://api.propzolo.com/v1/qr-codes/{id}' \
  -H 'Authorization: Bearer pz_live_…' \
  -H 'Content-Type: application/json' \
  -d '{"name":"string","target":{"kind":"form","id":"cmusrceel0000q7kaafxqi1om"},"source_id":"cmusrceel0000q7kaafxqi1om","placement":"hoarding","sub_source":"string","campaign_id":"cmusrceel0000q7kaafxqi1om","project_id":"cmusrceel0000q7kaafxqi1om","utm_campaign":"string","utm_content":"string","valid_from":"2026-10-06T05:30:00.000Z","valid_until":"2026-10-06T05:30:00.000Z","is_active":true}'

Response example

{
  "data": {
    "id": "cmusrceel0000q7kaafxqi1om",
    "name": "string",
    "short_code": "string",
    "short_url": "string",
    "scans": 0,
    "placement": "hoarding",
    "sub_source": "string",
    "source": {
      "id": "cmusrceel0000q7kaafxqi1om",
      "name": "string"
    },
    "campaign": {
      "id": "cmusrceel0000q7kaafxqi1om",
      "name": "string"
    },
    "project": {
      "id": "cmusrceel0000q7kaafxqi1om",
      "name": "string"
    },
    "utm_campaign": "string",
    "utm_content": "string",
    "valid_from": "2026-10-06T05:30:00.000Z",
    "valid_until": "2026-10-06T05:30:00.000Z",
    "is_active": true,
    "state": "live",
    "target": {
      "kind": "form",
      "id": "cmusrceel0000q7kaafxqi1om",
      "label": "string",
      "url": "string"
    },
    "last_scan_at": "2026-10-06T05:30:00.000Z",
    "created_at": "2026-10-06T05:30:00.000Z",
    "updated_at": "2026-10-06T05:30:00.000Z"
  },
  "meta": {}
}

Errors

401 No valid session or API key (missing, expired or revoked).
403 The caller lacks the permission, API-key scope or support grant this operation needs.
404 Not found — records of another company are reported the same way.
409 A unique value already exists, a concurrent change won, or the Idempotency-Key is still in use or was sent with a different request.
422 Invalid input; `error.fields` maps field paths to messages.
429 Too many requests; retry after the Retry-After header.
500 Unexpected error; quote `error.request_id` to support.

DELETE/v1/qr-codes/{id}

Delete a QR code

Printed copies stop working.

Access: Signed-in members only (web or Android session) — not for API keys. Permission marketing.edit.

Parameters

idpathrequired: Id
Opaque record id.

Response · 200

datarequired: object
data.idrequired: Id
Opaque record id.
data.deletedrequired: true
metarequired: object

Request

curl -X DELETE 'https://api.propzolo.com/v1/qr-codes/{id}' \
  -H 'Authorization: Bearer pz_live_…'

Response example

{
  "data": {
    "id": "cmusrceel0000q7kaafxqi1om",
    "deleted": true
  },
  "meta": {}
}

Errors

401 No valid session or API key (missing, expired or revoked).
403 The caller lacks the permission, API-key scope or support grant this operation needs.
404 Not found — records of another company are reported the same way.
422 Invalid input; `error.fields` maps field paths to messages.
429 Too many requests; retry after the Retry-After header.
500 Unexpected error; quote `error.request_id` to support.

GET/v1/qr-codes/{id}/daily

Scans per day of a QR code

Local days in the company time zone, today included; days without scans as 0.

Access: Signed-in members only (web or Android session) — not for API keys. Permission marketing.view.

Parameters

idpathrequired: Id
Opaque record id.
daysquery: integer

Response · 200

datarequired: QrDailyScans
metarequired: object

Request

curl -X GET 'https://api.propzolo.com/v1/qr-codes/{id}/daily' \
  -H 'Authorization: Bearer pz_live_…'

Response example

{
  "data": {
    "qr_id": "cmusrceel0000q7kaafxqi1om",
    "days": [
      {
        "day": "2026-10-06",
        "scans": 0
      }
    ]
  },
  "meta": {}
}

Errors

401 No valid session or API key (missing, expired or revoked).
403 The caller lacks the permission, API-key scope or support grant this operation needs.
404 Not found — records of another company are reported the same way.
422 Invalid input; `error.fields` maps field paths to messages.
429 Too many requests; retry after the Retry-After header.
500 Unexpected error; quote `error.request_id` to support.

GET/v1/qr-codes/{id}/image

The QR code as SVG or PNG

Print-ready (quarter error correction, full quiet zone). `download=true` saves it as a file.

Access: Signed-in members only (web or Android session) — not for API keys. Permission marketing.view.

Parameters

idpathrequired: Id
Opaque record id.
formatquery: "svg" | "png"
sizequery: integer
PNG width in pixels.
downloadquery: string

Response · 200

Returned as is.

Request

curl -X GET 'https://api.propzolo.com/v1/qr-codes/{id}/image' \
  -H 'Authorization: Bearer pz_live_…'

Response example

"string"

Errors

401 No valid session or API key (missing, expired or revoked).
403 The caller lacks the permission, API-key scope or support grant this operation needs.
404 Not found — records of another company are reported the same way.
422 Invalid input; `error.fields` maps field paths to messages.
429 Too many requests; retry after the Retry-After header.
500 Unexpected error; quote `error.request_id` to support.

GET/v1/qr-codes/{id}/sheet

A printable sheet of the QR code (PDF)

One page — A4, A5, A6 or a 24 × 36 inch standee — with a headline, the code (vector), its short link and a call to action, ready for the printer.

Access: Signed-in members only (web or Android session) — not for API keys. Permission marketing.view.

Parameters

idpathrequired: Id
Opaque record id.
sizequery: "a4" | "a5" | "a6" | "standee"
headlinequery: string
Default: the code’s name.
ctaquery: string
Default: “Scan to know more”.
downloadquery: string

Response · 200

Returned as is.

Request

curl -X GET 'https://api.propzolo.com/v1/qr-codes/{id}/sheet' \
  -H 'Authorization: Bearer pz_live_…'

Response example

"string"

Errors

401 No valid session or API key (missing, expired or revoked).
403 The caller lacks the permission, API-key scope or support grant this operation needs.
404 Not found — records of another company are reported the same way.
422 Invalid input; `error.fields` maps field paths to messages.
429 Too many requests; retry after the Retry-After header.
500 Unexpected error; quote `error.request_id` to support.

{ "data": [ { "id": "cmusrceel0000q7kaafxqi1om", "name": "string", "short_code": "string", "short_url": "string", "scans": 0, "placement": "hoarding", "sub_source": "string", "source": { "id": "cmusrceel0000q7kaafxqi1om", "name": "string" }, "campaign": { "id": "cmusrceel0000q7kaafxqi1om", "name": "string" }, "project": { "id": "cmusrceel0000q7kaafxqi1om", "name": "string" }, "utm_campaign": "string", "utm_content": "string", "valid_from": "2026-10-06T05:30:00.000Z", "valid_until": "2026-10-06T05:30:00.000Z", "is_active": true, "state": "live", "target": { "kind": "form", "id": "cmusrceel0000q7kaafxqi1om", "label": "string", "url": "string" }, "last_scan_at": "2026-10-06T05:30:00.000Z", "created_at": "2026-10-06T05:30:00.000Z", "updated_at": "2026-10-06T05:30:00.000Z" } ], "meta": {} }

curl -X POST 'https://api.propzolo.com/v1/qr-codes' \ -H 'Authorization: Bearer pz_live_…' \ -H 'Idempotency-Key: 6c0f1d3e-…' \ -H 'Content-Type: application/json' \ -d '{"name":"string","target":{"kind":"form","id":"cmusrceel0000q7kaafxqi1om"},"short_code":"string","source_id":"cmusrceel0000q7kaafxqi1om","placement":"hoarding","sub_source":"string","campaign_id":"cmusrceel0000q7kaafxqi1om","project_id":"cmusrceel0000q7kaafxqi1om","utm_campaign":"string","utm_content":"string","valid_from":"2026-10-06T05:30:00.000Z","valid_until":"2026-10-06T05:30:00.000Z","is_active":true}'

{ "data": { "id": "cmusrceel0000q7kaafxqi1om", "name": "string", "short_code": "string", "short_url": "string", "scans": 0, "placement": "hoarding", "sub_source": "string", "source": { "id": "cmusrceel0000q7kaafxqi1om", "name": "string" }, "campaign": { "id": "cmusrceel0000q7kaafxqi1om", "name": "string" }, "project": { "id": "cmusrceel0000q7kaafxqi1om", "name": "string" }, "utm_campaign": "string", "utm_content": "string", "valid_from": "2026-10-06T05:30:00.000Z", "valid_until": "2026-10-06T05:30:00.000Z", "is_active": true, "state": "live", "target": { "kind": "form", "id": "cmusrceel0000q7kaafxqi1om", "label": "string", "url": "string" }, "last_scan_at": "2026-10-06T05:30:00.000Z", "created_at": "2026-10-06T05:30:00.000Z", "updated_at": "2026-10-06T05:30:00.000Z" }, "meta": {} }

{ "data": { "from": "2026-10-06T05:30:00.000Z", "to": "2026-10-06T05:30:00.000Z", "codes": [ { "scans": 0, "unique_devices": 0, "leads": 0, "visits": 0, "won": 0, "rates": { "scan_to_lead": 0, "lead_to_visit": 0, "visit_to_won": 0 }, "qr_id": "cmusrceel0000q7kaafxqi1om" } ], "totals": { "scans": 0, "unique_devices": 0, "leads": 0, "visits": 0, "won": 0, "rates": { "scan_to_lead": 0, "lead_to_visit": 0, "visit_to_won": 0 } } }, "meta": {} }

curl -X PATCH 'https://api.propzolo.com/v1/qr-codes/{id}' \ -H 'Authorization: Bearer pz_live_…' \ -H 'Content-Type: application/json' \ -d '{"name":"string","target":{"kind":"form","id":"cmusrceel0000q7kaafxqi1om"},"source_id":"cmusrceel0000q7kaafxqi1om","placement":"hoarding","sub_source":"string","campaign_id":"cmusrceel0000q7kaafxqi1om","project_id":"cmusrceel0000q7kaafxqi1om","utm_campaign":"string","utm_content":"string","valid_from":"2026-10-06T05:30:00.000Z","valid_until":"2026-10-06T05:30:00.000Z","is_active":true}'

GET/v1/qr-codes/{id}/sheet

A printable sheet of the QR code (PDF)

One page — A4, A5, A6 or a 24 × 36 inch standee — with a headline, the code (vector), its short link and a call to action, ready for the printer.

Access: Signed-in members only (web or Android session) — not for API keys. Permission marketing.view.

Parameters

idpathrequired: Id
Opaque record id.
sizequery: "a4" | "a5" | "a6" | "standee"
headlinequery: string
Default: the code’s name.
ctaquery: string
Default: “Scan to know more”.
downloadquery: string

Response · 200

Returned as is.

Request

curl -X GET 'https://api.propzolo.com/v1/qr-codes/{id}/sheet' \
  -H 'Authorization: Bearer pz_live_…'

Response example

"string"

Errors

401 No valid session or API key (missing, expired or revoked).
403 The caller lacks the permission, API-key scope or support grant this operation needs.
404 Not found — records of another company are reported the same way.
422 Invalid input; `error.fields` maps field paths to messages.
429 Too many requests; retry after the Retry-After header.
500 Unexpected error; quote `error.request_id` to support.