Create and manage QR codes, short links, landing pages, and forms in your Hovercode workspace.
Maintain this server? Claim it
Call this server's tools from your browser. Nothing to install.
Requests go through mcptry because browsers can't call most MCP servers directly. Header values are sent to the server for that request only and are never stored or logged.
Tool list from our last check. Connect live to refresh it.
Build a rich, on-brand landing page from an ordered list of typed blocks, publish it, and return its live URL + its own QR code (`qr_id`; style it with the QR design args here, restyle later with update_qr_code — don't create another). This is the 'make me a page for X' tool — e.g. an event, product, restaurant, link-in-bio, or a scan-to-enter sweepstakes. Each block is {type, content}; call list_block_types first to see every type and its content shape. Blocks render in order in a centered column; a 'header' block (name/bio/photo) is the profile.
The page title (browser tab + SEO).
Ordered page blocks. Each is {type, content}. See list_block_types.
Custom URL slug (else auto-generated).
For the QR code this mints: Caption text; a frame that can show it is chosen automatically.
For the QR code this mints: Frame slug, as in create_qr_code. Set `text` without a `frame` and one that can show it is chosen automatically.
Custom domain (else a default is used).
For the QR code this mints: Module pattern style.
Publish immediately (default true). false leaves it a draft.
Hex page background color.
For the QR code this mints: URL of a logo image to place in the center.
For the QR code this mints: Hex color for the corner eyes, only if different from `primary_color`.
For the QR code this mints: Corner eye shape.
Workspace id. Optional when the account has one workspace; use list_workspaces to resolve otherwise.
For the QR code this mints: Draw a border around the code.
Hex text color.
For the QR code this mints: 'whole' (default) or 'pattern_only', as in create_qr_code.
Optional SEO/description text.
For the QR code this mints: Hex color for the frame, only if different from `primary_color`.
For the QR code this mints: Hex color for the QR pattern, e.g. #111111. Eyes and frame follow it automatically (rules as in create_qr_code).
For the QR code this mints: Secondary caption line, where the frame supports it.
For the QR code this mints: Hex background color, or 'transparent'.
For the QR code this mints: QR error correction level (L, M, Q, H). Leave unset: it is chosen automatically (H with a logo, Q otherwise).
This tool isn't marked read-only, so it may change something on the server or in an account you connected.
Build a rich, on-brand landing page from an ordered list of typed blocks, publish it, and return its live URL + its own QR code (`qr_id`; style it with the QR design args here, restyle later with update_qr_code — don't create another). This is the 'make me a page for X' tool — e.g. an event, product, restaurant, link-in-bio, or a scan-to-enter sweepstakes. Each block is {type, content}; call list_block_types first to see every type and its content shape. Blocks render in order in a centered column; a 'header' block (name/bio/photo) is the profile.
| Argument | Type | Description |
|---|---|---|
| slug | string | Custom URL slug (else auto-generated). |
| text | string | For the QR code this mints: Caption text; a frame that can show it is chosen automatically. |
| frame | string | For the QR code this mints: Frame slug, as in create_qr_code. Set `text` without a `frame` and one that can show it is chosen automatically. |
| title* | string | The page title (browser tab + SEO). |
| blocks* | array | Ordered page blocks. Each is {type, content}. See list_block_types. |
| domain | string | Custom domain (else a default is used). |
| pattern | string | For the QR code this mints: Module pattern style. |
| publish | boolean | Publish immediately (default true). false leaves it a draft. |
| bg_color | string | Hex page background color. |
| logo_url | string | For the QR code this mints: URL of a logo image to place in the center. |
| eye_color | string | For the QR code this mints: Hex color for the corner eyes, only if different from `primary_color`. |
| eye_style | string | For the QR code this mints: Corner eye shape. |
| workspace | string | Workspace id. Optional when the account has one workspace; use list_workspaces to resolve otherwise. |
| has_border | boolean | For the QR code this mints: Draw a border around the code. |
| text_color | string | Hex text color. |
| color_scope | string | For the QR code this mints: 'whole' (default) or 'pattern_only', as in create_qr_code. |
| description | string | Optional SEO/description text. |
| frame_color | string | For the QR code this mints: Hex color for the frame, only if different from `primary_color`. |
| primary_color | string | For the QR code this mints: Hex color for the QR pattern, e.g. #111111. Eyes and frame follow it automatically (rules as in create_qr_code). |
| text_secondary | string | For the QR code this mints: Secondary caption line, where the frame supports it. |
| background_color | string | For the QR code this mints: Hex background color, or 'transparent'. |
| error_correction | string | For the QR code this mints: QR error correction level (L, M, Q, H). Leave unset: it is chosen automatically (H with a logo, Q otherwise). |
{
"type": "object",
"required": [
"title",
"blocks"
],
"properties": {
"slug": {
"type": "string",
"description": "Custom URL slug (else auto-generated)."
},
"text": {
"type": "string",
"description": "For the QR code this mints: Caption text; a frame that can show it is chosen automatically."
},
"frame": {
"type": "string",
"description": "For the QR code this mints: Frame slug, as in create_qr_code. Set `text` without a `frame` and one that can show it is chosen automatically."
},
"title": {
"type": "string",
"description": "The page title (browser tab + SEO)."
},
"blocks": {
"type": "array",
"items": {
"type": "object",
"required": [
"type"
],
"properties": {
"form": {
"type": "string",
"description": "For a 'form' block: the form id to embed."
},
"type": {
"type": "string",
"description": "Block type, e.g. header, link, text, video, faq, countdown."
},
"hidden": {
"type": "boolean",
"description": "Hide this block from the live page."
},
"content": {
"type": "object",
"description": "The block's content, matching that type's schema."
}
}
},
"description": "Ordered page blocks. Each is {type, content}. See list_block_types."
},
"domain": {
"type": "string",
"description": "Custom domain (else a default is used)."
},
"pattern": {
"enum": [
"Original",
"Squares",
"Circles",
"Lines",
"Triangles",
"Diamonds"
],
"type": "string",
"description": "For the QR code this mints: Module pattern style."
},
"publish": {
"type": "boolean",
"description": "Publish immediately (default true). false leaves it a draft."
},
"bg_color": {
"type": "string",
"description": "Hex page background color."
},
"logo_url": {
"type": "string",
"description": "For the QR code this mints: URL of a logo image to place in the center."
},
"eye_color": {
"type": "string",
"description": "For the QR code this mints: Hex color for the corner eyes, only if different from `primary_color`."
},
"eye_style": {
"enum": [
"Square",
"Rounded",
"Drop",
"Leaf"
],
"type": "string",
"description": "For the QR code this mints: Corner eye shape."
},
"workspace": {
"type": "string",
"description": "Workspace id. Optional when the account has one workspace; use list_workspaces to resolve otherwise."
},
"has_border": {
"type": "boolean",
"description": "For the QR code this mints: Draw a border around the code."
},
"text_color": {
"type": "string",
"description": "Hex text color."
},
"color_scope": {
"enum": [
"whole",
"pattern_only"
],
"type": "string",
"description": "For the QR code this mints: 'whole' (default) or 'pattern_only', as in create_qr_code."
},
"description": {
"type": "string",
"description": "Optional SEO/description text."
},
"frame_color": {
"type": "string",
"description": "For the QR code this mints: Hex color for the frame, only if different from `primary_color`."
},
"primary_color": {
"type": "string",
"description": "For the QR code this mints: Hex color for the QR pattern, e.g. #111111. Eyes and frame follow it automatically (rules as in create_qr_code)."
},
"text_secondary": {
"type": "string",
"description": "For the QR code this mints: Secondary caption line, where the frame supports it."
},
"background_color": {
"type": "string",
"description": "For the QR code this mints: Hex background color, or 'transparent'."
},
"error_correction": {
"type": "string",
"description": "For the QR code this mints: QR error correction level (L, M, Q, H). Leave unset: it is chosen automatically (H with a logo, Q otherwise)."
}
}
}Create a folder to organise QR codes, optionally nested under a parent. Creating a folder that already exists (same name, same parent) returns the existing one, so it's safe to call repeatedly.
| Argument | Type | Description |
|---|---|---|
| name* | string | Folder name. |
| parent | string | Parent folder id or slug to nest under (optional). |
| workspace | string | Workspace id. Optional when the account has one workspace; use list_workspaces to resolve otherwise. |
{
"type": "object",
"required": [
"name"
],
"properties": {
"name": {
"type": "string",
"description": "Folder name."
},
"parent": {
"type": "string",
"description": "Parent folder id or slug to nest under (optional)."
},
"workspace": {
"type": "string",
"description": "Workspace id. Optional when the account has one workspace; use list_workspaces to resolve otherwise."
}
}
}Create a form, define its fields, brand it, publish it, and return a shareable short link + QR in one step. Use for 'make me a form to collect X, give me a link and QR to share it'. The result's `share_url` is the public link and `qr_id` is the form's own dynamic QR code (image included) — never call create_qr_code or create_short_link for a form's link; pass QR design args (primary_color, eye_style, frame, logo_url, …) here to style that code in the same call. Supports on-brand styling (theme/colors/logo), a `redirect_url` after submit, conditional logic (`show_when` on a field) and branching endings (`outcomes`), and a custom domain/slug. Publishing mints a dynamic short link and QR — always dynamic, no static option, since a form has to resolve somewhere live. Notifications are a separate, paid, verified-member setting. To change a form later, use update_form.
| Argument | Type | Description |
|---|---|---|
| slug | string | Custom short-link slug (else auto-generated). |
| text | string | For the QR code this mints: Caption text; a frame that can show it is chosen automatically. |
| frame | string | For the QR code this mints: Frame slug, as in create_qr_code. Set `text` without a `frame` and one that can show it is chosen automatically. |
| theme | string | Named color preset. Explicit colors below override it. |
| title* | string | The form's title. |
| domain | string | Custom domain to publish on (else a default is used). |
Create a published micro landing page (link-in-bio style) with a title and a list of links, and return its live URL (`share_url`) + its own QR code (`qr_id`; style it with the QR design args here; don't create another). Use this for 'make me a page with these links and a QR to share it'. The page is a dynamic destination you can keep; it counts toward the workspace's page limit.
| Argument | Type | Description |
|---|---|---|
| slug | string | Custom URL slug (else auto-generated). |
| text | string | For the QR code this mints: Caption text; a frame that can show it is chosen automatically. |
| frame | string | For the QR code this mints: Frame slug, as in create_qr_code. Set `text` without a `frame` and one that can show it is chosen automatically. |
| links | array | The link buttons on the page, in order. |
| title* | string | The page's heading. |
| domain | string | Custom page domain (else a default is used). |
| pattern | string | For the QR code this mints: Module pattern style. |
| bg_color | string | Hex background color. |
| logo_url |
Create a dynamic QR code and short link for a PDF (menus, flyers, tickets). Host the PDF by passing `pdf_url` (a link Hovercode fetches) or `pdf_base64` (the file's base64 bytes). Returns a shareable short link plus a rendered QR. Because it's dynamic you can later swap the PDF without reprinting the code — always dynamic, no static option here. Counts toward the same workspace dynamic-code limit as create_qr_code (list_workspaces' `dynamic_qr_limit`); past that limit this call returns an error.
| Argument | Type | Description |
|---|---|---|
| tags | array | Labels to attach (created if new) so you can find these later — list_qr_codes and list_short_links search by tag. |
| domain | string | Custom short-link domain (list_workspaces shows the plan). |
| pdf_url | string | URL of a PDF to fetch and host. Use this or pdf_base64. |
| filename | string | Name for the stored file, e.g. 'menu.pdf'. |
| workspace | string | Workspace id. Optional when the account has one workspace; use list_workspaces to resolve otherwise. |
| pdf_base64 | string | Base64-encoded PDF bytes (data-URI prefix allowed), max 20 MB. Or use pdf_url. |
| display_name | string | Internal name to find this code later. |
Create a Hovercode QR code and return its details plus a rendered PNG. `dynamic: true` makes the destination changeable later and tracks scans; `dynamic: false` (the default, 'static') encodes the destination directly into the code image — it can never be retargeted or tracked, and this choice can't be changed after creation. If the request doesn't make the choice clear, ask the user whether it should be trackable and editable later, or fixed permanently once printed. Dynamic codes count toward the workspace's dynamic-code limit (list_workspaces' `dynamic_qr_used`/`dynamic_qr_limit`); past that limit this call returns an error. Supports full design control (colors, pattern, eye style, frames with captions, logo). Not for Hovercode forms, pages, or short links: those already have their own QR code (returned as `qr_id` / `id`) — use download_qr or update_qr_code with that id instead.
| Argument | Type | Description |
|---|---|---|
| tags | array | Labels to attach (created if new) so you can find these later — list_qr_codes and list_short_links search by tag. |
| text | string | Caption text. Renders on any frame that supports one; if `frame` isn't also given (or the one given can't show text), a frame that can is chosen automatically. |
| frame | string | Frame slug. A caption (`text`) works on any frame — set `text` without a `frame` and one that can show it is chosen automatically. Frames that show a caption: card, card-above, speech-bubble, speech-bubble-above. |
| vcard | object | Contact details for qr_type 'vCard' (use instead of qr_data). Scanning saves the contact to the phone. `dynamic: true` makes the card editable later. |
| folder | string |
Create many QR codes at once from a list — e.g. 'make codes for these 20 product URLs in our brand colors'. All codes share the design/options you pass (colors, pattern, frame, dynamic, template). Returns the created codes and any per-item errors. Max 100 per call.
| Argument | Type | Description |
|---|---|---|
| tags | array | Labels to attach (created if new) so you can find these later — list_qr_codes and list_short_links search by tag. |
| text | string | Caption text; a frame that can show it is chosen automatically. |
| frame | string | Frame slug, as in create_qr_code. Set `text` without a `frame` and one that can show it is chosen automatically. |
| items* | array | URLs to encode. Each item is a URL string, or an object {url, display_name}. |
| dynamic | boolean | Make all of them editable + tracked; can't be switched after creation. Free up to a per-plan limit, not paid-only — a large batch can exceed it partway through, which shows up as per-item errors, not a whole-batch failure. |
| pattern | string | Module pattern style. |
| logo_url | string | URL of a logo image to place in the center. |
| template | string |
Create a tracked short link for a URL. It comes with its own QR code (same id; use download_qr). Supports a custom slug and a custom domain. The destination can be changed later with update_short_link, and clicks are tracked. Never shorten a link that is already a Hovercode short link, form link, or page link — those are already tracked and already have a QR code.
| Argument | Type | Description |
|---|---|---|
| gps | boolean | Prompt visitors to share their location. |
| link* | string | The destination URL to shorten. |
| slug | string | Custom slug (letters/numbers/hyphens) or auto-generated. |
| tags | array | Labels to attach (created if new) so you can find these later — list_qr_codes and list_short_links search by tag. |
| domain | string | Custom short-link domain; else a default is used. |
| workspace | string | Workspace id. Optional when the account has one workspace; use list_workspaces to resolve otherwise. |
| display_name | string | Internal name to find this link later. |
{
"type": "object",
"required": [
"link"
],
"properties": {
"gps": {
"type": "boolean",
"description": "Prompt visitors to share their location."
},
"link": {
"type": "string",
"description": "The destination URL to shorten."
},
"slug": {
"type": "string",
"description": "Custom slug (letters/numbers/hyphens) or auto-generated."
},
"tags": {
"type": "array",
"items": {
"type": "string"
},
"description": "Labels to attach (created if new) so you can find these later — list_qr_codes and list_short_links search by tag."
},
"domain": {
"type": "string",
"description": "Custom short-link domain; else a default is used."
},
"workspace": {
"type": "string",
"description": "Workspace id. Optional when the account has one workspace; use list_workspaces to resolve otherwise."
},
"display_name": {
"type": "string",
"description": "Internal name to find this link later."
}
}
}Delete a folder. The codes in it (and in its subfolders) are NOT deleted — they become unfiled — and its subfolders move up to its parent.
| Argument | Type | Description |
|---|---|---|
| id* | string | Folder id (from list_folders). |
{
"type": "object",
"required": [
"id"
],
"properties": {
"id": {
"type": "string",
"description": "Folder id (from list_folders)."
}
}
}Delete a landing page. Its live URL stops serving and it leaves the workspace's page list. Use for 'delete that page' / 'remove the landing page'.
| Argument | Type | Description |
|---|---|---|
| id* | string | Page id. |
{
"type": "object",
"required": [
"id"
],
"properties": {
"id": {
"type": "string",
"description": "Page id."
}
}
}Delete a QR code. Dynamic codes stop redirecting after deletion.
| Argument | Type | Description |
|---|---|---|
| id* | string | QR code id. |
{
"type": "object",
"required": [
"id"
],
"properties": {
"id": {
"type": "string",
"description": "QR code id."
}
}
}Delete a short link. It stops redirecting after deletion.
| Argument | Type | Description |
|---|---|---|
| id* | string | Short link id. |
{
"type": "object",
"required": [
"id"
],
"properties": {
"id": {
"type": "string",
"description": "Short link id."
}
}
}Get downloadable, print-ready image links for a QR code — a high-resolution PNG and a vector SVG (best for print/large sizes). Returns URLs you can share or save.
| Argument | Type | Description |
|---|---|---|
| id* | string | QR code id. |
{
"type": "object",
"required": [
"id"
],
"properties": {
"id": {
"type": "string",
"description": "QR code id."
}
}
}Scan analytics over a period: totals, unique scanners, scans-by-day, and top countries/cities/OS/browsers. Pass a QR code `id` for one code, or omit it for the whole workspace (which also returns the top codes). Use this to answer 'how did my codes do this month and where were people scanning?'.
| Argument | Type | Description |
|---|---|---|
| id | string | QR code id for per-code analytics; omit for workspace-wide. |
| end | string | Range end, ISO date/datetime. Defaults to now when only `start` is given. |
| days | integer | Look-back window in days (default 30, max 365). |
| start | string | Range start, ISO date or datetime (e.g. 2026-08-03 or 2026-08-03T14:00:00Z). Use start/end together for a fixed window instead of the rolling `days` look-back. |
| workspace | string | Workspace id. Optional when the account has one workspace; use list_workspaces to resolve otherwise. |
{
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "QR code id for per-code analytics; omit for workspace-wide."
},
"end": {
"type": "string",
"description": "Range end, ISO date/datetime. Defaults to now when only `start` is given."
},
"days": {
"type": "integer",
"description": "Look-back window in days (default 30, max 365)."
},
"start": {
"type": "string",
"description": "Range start, ISO date or datetime (e.g. 2026-08-03 or 2026-08-03T14:00:00Z). Use start/end together for a fixed window instead of the rolling `days` look-back."
},
"workspace": {
"type": "string",
"description": "Workspace id. Optional when the account has one workspace; use list_workspaces to resolve otherwise."
}
}
}Get one form's details: status, response count, share link, and QR.
| Argument | Type | Description |
|---|---|---|
| id* | string | Form id. |
{
"type": "object",
"required": [
"id"
],
"properties": {
"id": {
"type": "string",
"description": "Form id."
}
}
}List a form's submissions (newest first) so you can read or summarize them — e.g. 'summarize this week's feedback' or 'any complaints in the responses?'.
| Argument | Type | Description |
|---|---|---|
| id* | string | Form id. |
| page | integer | 1-based page number. |
| page_size | integer | Responses per page (max 100, default 25). |
{
"type": "object",
"required": [
"id"
],
"properties": {
"id": {
"type": "string",
"description": "Form id."
},
"page": {
"type": "integer",
"description": "1-based page number."
},
"page_size": {
"type": "integer",
"description": "Responses per page (max 100, default 25)."
}
}
}Get one landing page's details: status, live URL, QR, and its blocks (each block's id + type) so you can edit it with update_page.
| Argument | Type | Description |
|---|---|---|
| id* | string | Page id. |
{
"type": "object",
"required": [
"id"
],
"properties": {
"id": {
"type": "string",
"description": "Page id."
}
}
}List recent scan events for a dynamic QR code (time, location, device). Use this to answer questions like where or when a code was scanned.
| Argument | Type | Description |
|---|---|---|
| id* | string | QR code id. |
| end | string | Range end, ISO date/datetime. Defaults to now when only `start` is given. |
| page | integer | 1-based page number. |
| start | string | Range start, ISO date or datetime (e.g. 2026-08-03 or 2026-08-03T14:00:00Z). Use start/end together for a fixed window instead of the rolling `days` look-back. |
| page_size | integer | Events per page (max 200, default 25). |
{
"type": "object",
"required": [
"id"
],
"properties": {
"id": {
"type": "string",
"description": "QR code id."
},
"end": {
"type": "string",
"description": "Range end, ISO date/datetime. Defaults to now when only `start` is given."
},
"page": {
"type": "integer",
"description": "1-based page number."
},
"start": {
"type": "string",
"description": "Range start, ISO date or datetime (e.g. 2026-08-03 or 2026-08-03T14:00:00Z). Use start/end together for a fixed window instead of the rolling `days` look-back."
},
"page_size": {
"type": "integer",
"description": "Events per page (max 200, default 25)."
}
}
}Get one QR code's details and scan analytics (total and unique scans), plus a rendered PNG.
| Argument | Type | Description |
|---|---|---|
| id* | string | QR code id. |
{
"type": "object",
"required": [
"id"
],
"properties": {
"id": {
"type": "string",
"description": "QR code id."
}
}
}Get one short link's details, destination, click counts, and QR.
| Argument | Type | Description |
|---|---|---|
| id* | string | Short link id. |
{
"type": "object",
"required": [
"id"
],
"properties": {
"id": {
"type": "string",
"description": "Short link id."
}
}
}List recent click events for a short link (time, location, device).
| Argument | Type | Description |
|---|---|---|
| id* | string | Short link id. |
| end | string | Range end, ISO date/datetime. Defaults to now when only `start` is given. |
| page | integer | 1-based page number. |
| start | string | Range start, ISO date or datetime (e.g. 2026-08-03 or 2026-08-03T14:00:00Z). Use start/end together for a fixed window instead of the rolling `days` look-back. |
| page_size | integer | Events per page (max 200, default 25). |
{
"type": "object",
"required": [
"id"
],
"properties": {
"id": {
"type": "string",
"description": "Short link id."
},
"end": {
"type": "string",
"description": "Range end, ISO date/datetime. Defaults to now when only `start` is given."
},
"page": {
"type": "integer",
"description": "1-based page number."
},
"start": {
"type": "string",
"description": "Range start, ISO date or datetime (e.g. 2026-08-03 or 2026-08-03T14:00:00Z). Use start/end together for a fixed window instead of the rolling `days` look-back."
},
"page_size": {
"type": "integer",
"description": "Events per page (max 200, default 25)."
}
}
}List the page BLOCK TYPES available to build_page, each with its content JSON Schema. Call this first when composing a rich page so you know the vocabulary (header, link, text, image, button, video, gallery, faq, countdown, socials, divider, form, …).
No arguments.
{
"type": "object",
"properties": {}
}List the workspace's folders with their full path, code count, id and slug. Use a folder's id or slug with create_qr_code / update_qr_code (`folder`) to file codes, or with list_qr_codes to filter.
| Argument | Type | Description |
|---|---|---|
| workspace | string | Workspace id. Optional when the account has one workspace; use list_workspaces to resolve otherwise. |
{
"type": "object",
"properties": {
"workspace": {
"type": "string",
"description": "Workspace id. Optional when the account has one workspace; use list_workspaces to resolve otherwise."
}
}
}List the forms in a workspace, newest first. Optional `query` searches by title.
| Argument | Type | Description |
|---|---|---|
| page | integer | 1-based page number. |
| query | string | Search term (matches the form title). |
| page_size | integer | Results per page (max 100, default 25). |
| workspace | string | Workspace id. Optional when the account has one workspace; use list_workspaces to resolve otherwise. |
{
"type": "object",
"properties": {
"page": {
"type": "integer",
"description": "1-based page number."
},
"query": {
"type": "string",
"description": "Search term (matches the form title)."
},
"page_size": {
"type": "integer",
"description": "Results per page (max 100, default 25)."
},
"workspace": {
"type": "string",
"description": "Workspace id. Optional when the account has one workspace; use list_workspaces to resolve otherwise."
}
}
}List the landing pages in a workspace, newest first.
| Argument | Type | Description |
|---|---|---|
| workspace | string | Workspace id. Optional when the account has one workspace; use list_workspaces to resolve otherwise. |
{
"type": "object",
"properties": {
"workspace": {
"type": "string",
"description": "Workspace id. Optional when the account has one workspace; use list_workspaces to resolve otherwise."
}
}
}List QR codes in a workspace, newest first. Optional `query` searches destination, name, and tags. `folder` narrows to one folder, `include_tags` adds each code's tags (its folder is always shown), and `include_scans` adds scan counts — use it instead of calling get_analytics once per code.
| Argument | Type | Description |
|---|---|---|
| page | integer | 1-based page number. |
| query | string | Search term (destination, display name, or tag). |
| folder | string | Folder id or slug to filter by, or 'none' for codes in no folder. |
| page_size | integer | Results per page (max 200, default 25). |
| workspace | string | Workspace id. Optional when the account has one workspace; use list_workspaces to resolve otherwise. |
| subfolders | boolean | With `folder`, also include codes in its subfolders. |
| include_tags | boolean | Add each code's tags. (Each code's folder is always included.) |
| include_scans | boolean | Add total_scans and unique_scans (lifetime) to each code. |
List short links in a workspace, newest first. Optional `query` searches URL, name, and slug.
| Argument | Type | Description |
|---|---|---|
| page | integer | 1-based page number. |
| query | string | Search term (destination, name, or slug). |
| page_size | integer | Results per page (max 200, default 25). |
| workspace | string | Workspace id. Optional when the account has one workspace; use list_workspaces to resolve otherwise. |
{
"type": "object",
"properties": {
"page": {
"type": "integer",
"description": "1-based page number."
},
"query": {
"type": "string",
"description": "Search term (destination, name, or slug)."
},
"page_size": {
"type": "integer",
"description": "Results per page (max 200, default 25)."
},
"workspace": {
"type": "string",
"description": "Workspace id. Optional when the account has one workspace; use list_workspaces to resolve otherwise."
}
}
}List the workspace's tags (title + id). Tags are attached with create_qr_code (`tags`) or update_qr_code (`add_tags` / `remove_tags`), and list_qr_codes searches by tag.
| Argument | Type | Description |
|---|---|---|
| workspace | string | Workspace id. Optional when the account has one workspace; use list_workspaces to resolve otherwise. |
{
"type": "object",
"properties": {
"workspace": {
"type": "string",
"description": "Workspace id. Optional when the account has one workspace; use list_workspaces to resolve otherwise."
}
}
}List the workspace's saved QR design templates. Pass a template id to create_qr_code to reuse its branding.
| Argument | Type | Description |
|---|---|---|
| workspace | string | Workspace id. Optional when the account has one workspace; use list_workspaces to resolve otherwise. |
{
"type": "object",
"properties": {
"workspace": {
"type": "string",
"description": "Workspace id. Optional when the account has one workspace; use list_workspaces to resolve otherwise."
}
}
}List the workspaces this account can access, with their ids; the current (default) one is marked. Tools default to the current workspace, so you only need `workspace` to target a different one.
No arguments.
{
"type": "object",
"properties": {}
}Switch the current (default) workspace by id or name. New codes, forms, and pages are created in the current workspace unless a tool is given an explicit `workspace`.
| Argument | Type | Description |
|---|---|---|
| workspace* | string | Workspace id or name to switch to. |
{
"type": "object",
"required": [
"workspace"
],
"properties": {
"workspace": {
"type": "string",
"description": "Workspace id or name to switch to."
}
}
}Rename a folder and/or move it under another folder. `parent` 'none' moves it to the top level. Codes inside keep their filing.
| Argument | Type | Description |
|---|---|---|
| id* | string | Folder id (from list_folders). |
| name | string | New folder name. |
| parent | string | New parent folder id or slug, or 'none' for top level. |
{
"type": "object",
"required": [
"id"
],
"properties": {
"id": {
"type": "string",
"description": "Folder id (from list_folders)."
},
"name": {
"type": "string",
"description": "New folder name."
},
"parent": {
"type": "string",
"description": "New parent folder id or slug, or 'none' for top level."
}
}
}Change an existing form without recreating it: edit its fields, settings (redirect, thank-you, title), or branding (theme/colors/logo), or close/reopen it. If you pass `fields`, provide the COMPLETE desired list — include each existing field's `id` (from get_form) to keep it; omit a field to remove it; leave `id` off a new field. If the form is already published, edits are re-published so they go live.
| Argument | Type | Description |
|---|---|---|
| id* | string | Form id. |
| theme | string | Named color preset. Explicit colors below override it. |
| title | string | New title. |
| fields | array | Complete desired field list (see note); create_form shape plus an optional `id`. |
| status | string | Close (stop responses) or reopen. When set, other edits are ignored. |
| bg_color | string | Hex background color. |
| logo_url | string | URL of a logo image (JPEG/PNG/GIF/WebP) to show on the form. |
| outcomes | array | Pathways / branching endings. After submit the first outcome whose rules match decides the ending: its own thank-you title/message and/or a redirect_url (e.g. send people to a different product page per answer). If none match, the default thank-you page is shown. |
Change an existing landing page without recreating it: edit its blocks, title, description, or colors, and publish/unpublish it. Use for 'fix the typo on my page', 'add a section', or 'take the page down'. If you pass `blocks`, provide the COMPLETE desired list (same {type, content} shape as build_page; include each block's `id` from get_page to keep it, omit to remove) — leaving `blocks` off keeps the existing blocks untouched. If the page is already published, edits are re-published so they go live; pass publish:false to take it offline.
| Argument | Type | Description |
|---|---|---|
| id* | string | Page id. |
| title | string | New page title. |
| blocks | array | Complete desired block list (see note); each is {type, content} + optional id. |
| publish | boolean | true = publish/re-publish so edits go live; false = take offline (draft). |
| bg_color | string | Hex page background color. |
| text_color | string | Hex text color. |
| description | string | New SEO/description text. |
Update a QR code in place — the same code keeps working, so it's safe for already-printed codes. Changing `qr_data` retargets a DYNAMIC code's destination. Design fields (colors, pattern, eye style, frame, logo) restyle the code WITHOUT replacing it. Also supports renaming, toggling location tracking, moving it into a folder (`folder`, or 'none' to unfile), and adding/removing tags. Returns the re-rendered QR so you can preview the result. Any combination works in one call. Only include a design field when you actually intend to change it: every one you pass is applied exactly as given, even a color identical to what you set at creation — there's no way to tell 'leave this as-is' from 'set this back to what it already was'. In particular, someone may have since edited the design directly (a widget's own Edit panel can change eye/frame color, pattern, or frame without that edit ever appearing in this conversation) — resending a color or style you remember from an earlier turn will silently overwrite it. If you're not sure the design still matches what you last set, call get_qr_code first rather than restoring from memory.
| Argument | Type | Description |
|---|---|---|
| id* | string | QR code id. |
| text | string | Caption text. Renders on any frame that supports one; if `frame` isn't also given (or the one given can't show text), a frame that can is chosen automatically. |
| frame | string | Frame slug. A caption (`text`) works on any frame — set `text` without a `frame` and one that can show it is chosen automatically. Frames that show a caption: card, card-above, speech-bubble, speech-bubble-above. |
| folder | string |
Update a short link. Changing `link` retargets it — the short URL keeps working, it just points somewhere new. Also supports renaming and toggling location tracking.
| Argument | Type | Description |
|---|---|---|
| id* | string | Short link id. |
| gps | boolean | Enable/disable the location prompt. |
| link | string | New destination URL. |
| display_name | string | New internal name. |
{
"type": "object",
"required": [
"id"
],
"properties": {
"id": {
"type": "string",
"description": "Short link id."
},
"gps": {
"type": "boolean",
"description": "Enable/disable the location prompt."
},
"link": {
"type": "string",
"description": "New destination URL."
},
"display_name": {
"type": "string",
"description": "New internal name."
}
}
}| fields* | array | The fields to collect, in order. |
| pattern | string | For the QR code this mints: Module pattern style. |
| bg_color | string | Hex background color. |
| logo_url | string | URL of a logo image (JPEG/PNG/GIF/WebP) to show on the form. |
| outcomes | array | Pathways / branching endings. After submit the first outcome whose rules match decides the ending: its own thank-you title/message and/or a redirect_url (e.g. send people to a different product page per answer). If none match, the default thank-you page is shown. |
| eye_color | string | For the QR code this mints: Hex color for the corner eyes, only if different from `primary_color`. |
| eye_style | string | For the QR code this mints: Corner eye shape. |
| workspace | string | Workspace id. Optional when the account has one workspace; use list_workspaces to resolve otherwise. |
| has_border | boolean | For the QR code this mints: Draw a border around the code. |
| text_color | string | Hex text color. |
| color_scope | string | For the QR code this mints: 'whole' (default) or 'pattern_only', as in create_qr_code. |
| description | string | Optional description shown above the fields. |
| frame_color | string | For the QR code this mints: Hex color for the frame, only if different from `primary_color`. |
| button_color | string | Hex submit-button color. |
| redirect_url | string | URL to send respondents to after they submit. |
| primary_color | string | For the QR code this mints: Hex color for the QR pattern, e.g. #111111. Eyes and frame follow it automatically (rules as in create_qr_code). |
| text_secondary | string | For the QR code this mints: Secondary caption line, where the frame supports it. |
| background_color | string | For the QR code this mints: Hex background color, or 'transparent'. |
| error_correction | string | For the QR code this mints: QR error correction level (L, M, Q, H). Leave unset: it is chosen automatically (H with a logo, Q otherwise). |
| button_text_color | string | Hex button-text color. |
| thank_you_message | string | Shown after submitting (if no redirect). |
{
"type": "object",
"required": [
"title",
"fields"
],
"properties": {
"slug": {
"type": "string",
"description": "Custom short-link slug (else auto-generated)."
},
"text": {
"type": "string",
"description": "For the QR code this mints: Caption text; a frame that can show it is chosen automatically."
},
"frame": {
"type": "string",
"description": "For the QR code this mints: Frame slug, as in create_qr_code. Set `text` without a `frame` and one that can show it is chosen automatically."
},
"theme": {
"enum": [
"light",
"dark",
"minimal",
"bold"
],
"type": "string",
"description": "Named color preset. Explicit colors below override it."
},
"title": {
"type": "string",
"description": "The form's title."
},
"domain": {
"type": "string",
"description": "Custom domain to publish on (else a default is used)."
},
"fields": {
"type": "array",
"items": {
"type": "object",
"required": [
"label"
],
"properties": {
"nps": {
"type": "boolean",
"description": "Make this a Net Promoter Score question (0–10, standard labels)."
},
"type": {
"enum": [
"text",
"email",
"phone",
"number",
"textarea",
"select",
"radio",
"checkbox",
"date",
"time",
"url",
"rating",
"scale",
"yes_no",
"image_choice",
"ranking",
"statement",
"hidden",
"page_break",
"image"
],
"type": "string",
"description": "Field type. Default 'text'. Use select/radio/checkbox/ranking with `options`; image_choice with options carrying an `image` URL; scale with min_value/max_value and min_label/max_label (or nps: true)."
},
"label": {
"type": "string",
"description": "The field's question/label."
},
"options": {
"type": "array",
"items": {
"type": [
"string",
"object"
]
},
"description": "Choices for select/radio/checkbox/ranking (strings or {value,label}); for image_choice pass {label, image} objects."
},
"required": {
"type": "boolean",
"description": "Whether an answer is required."
},
"max_label": {
"type": "string",
"description": "scale only: label under the top value"
},
"min_label": {
"type": "string",
"description": "scale only: label under the lowest value"
},
"show_when": {
"type": "object",
"required": [
"rules"
],
"properties": {
"match": {
"enum": [
"all",
"any"
],
"type": "string",
"description": "Default 'all'."
},
"rules": {
"type": "array",
"items": {
"type": "object",
"required": [
"field",
"op"
],
"properties": {
"op": {
"enum": [
"eq",
"neq",
"contains",
"not_contains",
"gt",
"lt",
"is_empty",
"not_empty"
],
"type": "string",
"description": "eq / neq (is, is not), contains / not_contains (text or checkbox), gt / lt (numbers, ratings, dates), is_empty / not_empty (no value needed)."
},
"field": {
"type": "string",
"description": "The question this condition looks at: its label, its id, or its 0-based position."
},
"value": {
"type": "string",
"description": "Value to compare with (an option's value for choice questions)."
}
}
}
},
"action": {
"enum": [
"show",
"require"
],
"type": "string",
"description": "'show' (default): shown only while the rules match. 'require': always shown, required only while they match. On a page_break field the rules skip the whole page."
}
},
"description": "Conditional logic: show this field only while its conditions match EARLIER answers (e.g. a follow-up question, or a statement recommending a product). Omit to always show."
},
"placeholder": {
"type": "string",
"description": "Optional placeholder text."
}
}
},
"description": "The fields to collect, in order."
},
"pattern": {
"enum": [
"Original",
"Squares",
"Circles",
"Lines",
"Triangles",
"Diamonds"
],
"type": "string",
"description": "For the QR code this mints: Module pattern style."
},
"bg_color": {
"type": "string",
"description": "Hex background color."
},
"logo_url": {
"type": "string",
"description": "URL of a logo image (JPEG/PNG/GIF/WebP) to show on the form."
},
"outcomes": {
"type": "array",
"items": {
"type": "object",
"required": [
"name",
"rules"
],
"properties": {
"name": {
"type": "string",
"description": "Short name, recorded on each response (e.g. 'Recommend Zero Sugar')."
},
"match": {
"enum": [
"all",
"any"
],
"type": "string",
"description": "Default 'all'."
},
"rules": {
"type": "array",
"items": {
"type": "object",
"required": [
"field",
"op"
],
"properties": {
"op": {
"enum": [
"eq",
"neq",
"contains",
"not_contains",
"gt",
"lt",
"is_empty",
"not_empty"
],
"type": "string",
"description": "eq / neq (is, is not), contains / not_contains (text or checkbox), gt / lt (numbers, ratings, dates), is_empty / not_empty (no value needed)."
},
"field": {
"type": "string",
"description": "The question this condition looks at: its label, its id, or its 0-based position."
},
"value": {
"type": "string",
"description": "Value to compare with (an option's value for choice questions)."
}
}
}
},
"end_early": {
"type": "boolean",
"description": "Screening: end the form as soon as this matches (checked on every page change), not just at submit."
},
"redirect_url": {
"type": "string",
"description": "Optional page to send the respondent to."
},
"thank_you_title": {
"type": "string"
},
"thank_you_message": {
"type": "string"
}
}
},
"description": "Pathways / branching endings. After submit the first outcome whose rules match decides the ending: its own thank-you title/message and/or a redirect_url (e.g. send people to a different product page per answer). If none match, the default thank-you page is shown."
},
"eye_color": {
"type": "string",
"description": "For the QR code this mints: Hex color for the corner eyes, only if different from `primary_color`."
},
"eye_style": {
"enum": [
"Square",
"Rounded",
"Drop",
"Leaf"
],
"type": "string",
"description": "For the QR code this mints: Corner eye shape."
},
"workspace": {
"type": "string",
"description": "Workspace id. Optional when the account has one workspace; use list_workspaces to resolve otherwise."
},
"has_border": {
"type": "boolean",
"description": "For the QR code this mints: Draw a border around the code."
},
"text_color": {
"type": "string",
"description": "Hex text color."
},
"color_scope": {
"enum": [
"whole",
"pattern_only"
],
"type": "string",
"description": "For the QR code this mints: 'whole' (default) or 'pattern_only', as in create_qr_code."
},
"description": {
"type": "string",
"description": "Optional description shown above the fields."
},
"frame_color": {
"type": "string",
"description": "For the QR code this mints: Hex color for the frame, only if different from `primary_color`."
},
"button_color": {
"type": "string",
"description": "Hex submit-button color."
},
"redirect_url": {
"type": "string",
"description": "URL to send respondents to after they submit."
},
"primary_color": {
"type": "string",
"description": "For the QR code this mints: Hex color for the QR pattern, e.g. #111111. Eyes and frame follow it automatically (rules as in create_qr_code)."
},
"text_secondary": {
"type": "string",
"description": "For the QR code this mints: Secondary caption line, where the frame supports it."
},
"background_color": {
"type": "string",
"description": "For the QR code this mints: Hex background color, or 'transparent'."
},
"error_correction": {
"type": "string",
"description": "For the QR code this mints: QR error correction level (L, M, Q, H). Leave unset: it is chosen automatically (H with a logo, Q otherwise)."
},
"button_text_color": {
"type": "string",
"description": "Hex button-text color."
},
"thank_you_message": {
"type": "string",
"description": "Shown after submitting (if no redirect)."
}
}
}| string |
| For the QR code this mints: URL of a logo image to place in the center. |
| eye_color | string | For the QR code this mints: Hex color for the corner eyes, only if different from `primary_color`. |
| eye_style | string | For the QR code this mints: Corner eye shape. |
| workspace | string | Workspace id. Optional when the account has one workspace; use list_workspaces to resolve otherwise. |
| has_border | boolean | For the QR code this mints: Draw a border around the code. |
| text_color | string | Hex text color. |
| color_scope | string | For the QR code this mints: 'whole' (default) or 'pattern_only', as in create_qr_code. |
| description | string | Optional text shown under the title. |
| frame_color | string | For the QR code this mints: Hex color for the frame, only if different from `primary_color`. |
| primary_color | string | For the QR code this mints: Hex color for the QR pattern, e.g. #111111. Eyes and frame follow it automatically (rules as in create_qr_code). |
| text_secondary | string | For the QR code this mints: Secondary caption line, where the frame supports it. |
| background_color | string | For the QR code this mints: Hex background color, or 'transparent'. |
| error_correction | string | For the QR code this mints: QR error correction level (L, M, Q, H). Leave unset: it is chosen automatically (H with a logo, Q otherwise). |
{
"type": "object",
"required": [
"title"
],
"properties": {
"slug": {
"type": "string",
"description": "Custom URL slug (else auto-generated)."
},
"text": {
"type": "string",
"description": "For the QR code this mints: Caption text; a frame that can show it is chosen automatically."
},
"frame": {
"type": "string",
"description": "For the QR code this mints: Frame slug, as in create_qr_code. Set `text` without a `frame` and one that can show it is chosen automatically."
},
"links": {
"type": "array",
"items": {
"type": "object",
"required": [
"url"
],
"properties": {
"url": {
"type": "string",
"description": "Destination URL."
},
"type": {
"type": "string",
"description": "Optional link type, e.g. Website, Instagram, YouTube."
},
"title": {
"type": "string",
"description": "Button label (defaults to the URL)."
}
}
},
"description": "The link buttons on the page, in order."
},
"title": {
"type": "string",
"description": "The page's heading."
},
"domain": {
"type": "string",
"description": "Custom page domain (else a default is used)."
},
"pattern": {
"enum": [
"Original",
"Squares",
"Circles",
"Lines",
"Triangles",
"Diamonds"
],
"type": "string",
"description": "For the QR code this mints: Module pattern style."
},
"bg_color": {
"type": "string",
"description": "Hex background color."
},
"logo_url": {
"type": "string",
"description": "For the QR code this mints: URL of a logo image to place in the center."
},
"eye_color": {
"type": "string",
"description": "For the QR code this mints: Hex color for the corner eyes, only if different from `primary_color`."
},
"eye_style": {
"enum": [
"Square",
"Rounded",
"Drop",
"Leaf"
],
"type": "string",
"description": "For the QR code this mints: Corner eye shape."
},
"workspace": {
"type": "string",
"description": "Workspace id. Optional when the account has one workspace; use list_workspaces to resolve otherwise."
},
"has_border": {
"type": "boolean",
"description": "For the QR code this mints: Draw a border around the code."
},
"text_color": {
"type": "string",
"description": "Hex text color."
},
"color_scope": {
"enum": [
"whole",
"pattern_only"
],
"type": "string",
"description": "For the QR code this mints: 'whole' (default) or 'pattern_only', as in create_qr_code."
},
"description": {
"type": "string",
"description": "Optional text shown under the title."
},
"frame_color": {
"type": "string",
"description": "For the QR code this mints: Hex color for the frame, only if different from `primary_color`."
},
"primary_color": {
"type": "string",
"description": "For the QR code this mints: Hex color for the QR pattern, e.g. #111111. Eyes and frame follow it automatically (rules as in create_qr_code)."
},
"text_secondary": {
"type": "string",
"description": "For the QR code this mints: Secondary caption line, where the frame supports it."
},
"background_color": {
"type": "string",
"description": "For the QR code this mints: Hex background color, or 'transparent'."
},
"error_correction": {
"type": "string",
"description": "For the QR code this mints: QR error correction level (L, M, Q, H). Leave unset: it is chosen automatically (H with a logo, Q otherwise)."
}
}
}{
"type": "object",
"properties": {
"tags": {
"type": "array",
"items": {
"type": "string"
},
"description": "Labels to attach (created if new) so you can find these later — list_qr_codes and list_short_links search by tag."
},
"domain": {
"type": "string",
"description": "Custom short-link domain (list_workspaces shows the plan)."
},
"pdf_url": {
"type": "string",
"description": "URL of a PDF to fetch and host. Use this or pdf_base64."
},
"filename": {
"type": "string",
"description": "Name for the stored file, e.g. 'menu.pdf'."
},
"workspace": {
"type": "string",
"description": "Workspace id. Optional when the account has one workspace; use list_workspaces to resolve otherwise."
},
"pdf_base64": {
"type": "string",
"description": "Base64-encoded PDF bytes (data-URI prefix allowed), max 20 MB. Or use pdf_url."
},
"display_name": {
"type": "string",
"description": "Internal name to find this code later."
}
}
}| Folder id or slug to file the new code into (list_qr_codes shows each code's folder). |
| dynamic | boolean | Editable destination + scan tracking; can't be switched after creation. Counts toward the workspace's dynamic-code limit. Default false (static: fixed forever, no tracking). Ask the user if their wording doesn't make the choice clear. |
| pattern | string | Module pattern style. |
| qr_data* | string | What the code encodes: a URL for qr_type 'Link', or the text for qr_type 'Text'. For 'vCard' send `vcard` instead. |
| qr_type | string | QR content type. Default 'Link'. 'vCard' encodes a contact card from `vcard`. |
| logo_url | string | URL of a logo image to place in the center. |
| template | string | Workspace template id to apply as design defaults (list_templates). |
| eye_color | string | Hex color for the corner eyes, if different from `primary_color` (which they follow by default). |
| eye_style | string | Corner eye shape. |
| workspace | string | Workspace id. Optional when the account has one workspace; use list_workspaces to resolve otherwise. |
| has_border | boolean | Draw a border around the code. |
| color_scope | string | How far a `primary_color` change should reach; only relevant alongside `primary_color`. Default 'whole' matches whole-code language — 'make it red', 'make the QR code dark green' — so pattern, eyes, and frame all follow `primary_color` together. Set 'pattern_only' for language that names one part specifically — 'change the pattern color to red', 'just recolor the dots' — so eyes and frame are left exactly as they are. |
| frame_color | string | Hex color for the frame, if different from `primary_color` (which it follows by default). |
| display_name | string | Internal name to find this code later. |
| gps_tracking | boolean | Prompt scanners to share location (dynamic codes). |
| primary_color | string | Hex color for the QR pattern, e.g. #111111. Eyes and frame follow this automatically — one color request styles the whole code; only set `eye_color`/`frame_color` for a code that should use a *different* color for those, e.g. 'dark green with gold eyes'. See `color_scope` for language that names just the pattern. |
| text_secondary | string | Secondary caption line, where the frame supports it. |
| background_color | string | Hex background color, or 'transparent'. |
| error_correction | string | QR error correction level: L, M, Q, or H (higher tolerates more damage but is denser). Already handled automatically — the renderer uses H whenever the code has a logo, Q otherwise — so leave this unset by default, including when adding or changing a logo in this same call; only set it to deliberately override that automatic choice. |
{
"type": "object",
"required": [
"qr_data"
],
"properties": {
"tags": {
"type": "array",
"items": {
"type": "string"
},
"description": "Labels to attach (created if new) so you can find these later — list_qr_codes and list_short_links search by tag."
},
"text": {
"type": "string",
"description": "Caption text. Renders on any frame that supports one; if `frame` isn't also given (or the one given can't show text), a frame that can is chosen automatically."
},
"frame": {
"type": "string",
"description": "Frame slug. A caption (`text`) works on any frame — set `text` without a `frame` and one that can show it is chosen automatically. Frames that show a caption: card, card-above, speech-bubble, speech-bubble-above."
},
"vcard": {
"type": "object",
"required": [
"first_name"
],
"properties": {
"city": {
"type": "string"
},
"email": {
"type": "string"
},
"state": {
"type": "string"
},
"street": {
"type": "string"
},
"country": {
"type": "string"
},
"website": {
"type": "string"
},
"position": {
"type": "string"
},
"last_name": {
"type": "string"
},
"post_code": {
"type": "string"
},
"first_name": {
"type": "string"
},
"description": {
"type": "string"
},
"company_name": {
"type": "string"
},
"phone_number": {
"type": "string"
},
"mobile_number": {
"type": "string"
}
},
"description": "Contact details for qr_type 'vCard' (use instead of qr_data). Scanning saves the contact to the phone. `dynamic: true` makes the card editable later."
},
"folder": {
"type": "string",
"description": "Folder id or slug to file the new code into (list_qr_codes shows each code's folder)."
},
"dynamic": {
"type": "boolean",
"description": "Editable destination + scan tracking; can't be switched after creation. Counts toward the workspace's dynamic-code limit. Default false (static: fixed forever, no tracking). Ask the user if their wording doesn't make the choice clear."
},
"pattern": {
"enum": [
"Original",
"Squares",
"Circles",
"Lines",
"Triangles",
"Diamonds"
],
"type": "string",
"description": "Module pattern style."
},
"qr_data": {
"type": "string",
"description": "What the code encodes: a URL for qr_type 'Link', or the text for qr_type 'Text'. For 'vCard' send `vcard` instead."
},
"qr_type": {
"enum": [
"Link",
"Text",
"vCard"
],
"type": "string",
"description": "QR content type. Default 'Link'. 'vCard' encodes a contact card from `vcard`."
},
"logo_url": {
"type": "string",
"description": "URL of a logo image to place in the center."
},
"template": {
"type": "string",
"description": "Workspace template id to apply as design defaults (list_templates)."
},
"eye_color": {
"type": "string",
"description": "Hex color for the corner eyes, if different from `primary_color` (which they follow by default)."
},
"eye_style": {
"enum": [
"Square",
"Rounded",
"Drop",
"Leaf"
],
"type": "string",
"description": "Corner eye shape."
},
"workspace": {
"type": "string",
"description": "Workspace id. Optional when the account has one workspace; use list_workspaces to resolve otherwise."
},
"has_border": {
"type": "boolean",
"description": "Draw a border around the code."
},
"color_scope": {
"enum": [
"whole",
"pattern_only"
],
"type": "string",
"description": "How far a `primary_color` change should reach; only relevant alongside `primary_color`. Default 'whole' matches whole-code language — 'make it red', 'make the QR code dark green' — so pattern, eyes, and frame all follow `primary_color` together. Set 'pattern_only' for language that names one part specifically — 'change the pattern color to red', 'just recolor the dots' — so eyes and frame are left exactly as they are."
},
"frame_color": {
"type": "string",
"description": "Hex color for the frame, if different from `primary_color` (which it follows by default)."
},
"display_name": {
"type": "string",
"description": "Internal name to find this code later."
},
"gps_tracking": {
"type": "boolean",
"description": "Prompt scanners to share location (dynamic codes)."
},
"primary_color": {
"type": "string",
"description": "Hex color for the QR pattern, e.g. #111111. Eyes and frame follow this automatically — one color request styles the whole code; only set `eye_color`/`frame_color` for a code that should use a *different* color for those, e.g. 'dark green with gold eyes'. See `color_scope` for language that names just the pattern."
},
"text_secondary": {
"type": "string",
"description": "Secondary caption line, where the frame supports it."
},
"background_color": {
"type": "string",
"description": "Hex background color, or 'transparent'."
},
"error_correction": {
"type": "string",
"description": "QR error correction level: L, M, Q, or H (higher tolerates more damage but is denser). Already handled automatically — the renderer uses H whenever the code has a logo, Q otherwise — so leave this unset by default, including when adding or changing a logo in this same call; only set it to deliberately override that automatic choice."
}
}
}| Workspace template id to apply to all. |
| eye_color | string | Hex color for the corner eyes, only if different from `primary_color`. |
| eye_style | string | Corner eye shape. |
| workspace | string | Workspace id. Optional when the account has one workspace; use list_workspaces to resolve otherwise. |
| has_border | boolean | Draw a border around the code. |
| color_scope | string | 'whole' (default) or 'pattern_only', as in create_qr_code. |
| frame_color | string | Hex color for the frame, only if different from `primary_color`. |
| primary_color | string | Hex color for the QR pattern, e.g. #111111. Eyes and frame follow it automatically (rules as in create_qr_code). |
| text_secondary | string | Secondary caption line, where the frame supports it. |
| idempotency_key | string | Optional client key to make retries safe: if a previous call used the same key (same workspace), the earlier result is replayed instead of creating duplicate codes. Use a fresh key per distinct batch. |
| background_color | string | Hex background color, or 'transparent'. |
| error_correction | string | QR error correction level (L, M, Q, H). Leave unset: it is chosen automatically (H with a logo, Q otherwise). |
{
"type": "object",
"required": [
"items"
],
"properties": {
"tags": {
"type": "array",
"items": {
"type": "string"
},
"description": "Labels to attach (created if new) so you can find these later — list_qr_codes and list_short_links search by tag."
},
"text": {
"type": "string",
"description": "Caption text; a frame that can show it is chosen automatically."
},
"frame": {
"type": "string",
"description": "Frame slug, as in create_qr_code. Set `text` without a `frame` and one that can show it is chosen automatically."
},
"items": {
"type": "array",
"items": {
"type": [
"string",
"object"
]
},
"description": "URLs to encode. Each item is a URL string, or an object {url, display_name}."
},
"dynamic": {
"type": "boolean",
"description": "Make all of them editable + tracked; can't be switched after creation. Free up to a per-plan limit, not paid-only — a large batch can exceed it partway through, which shows up as per-item errors, not a whole-batch failure."
},
"pattern": {
"enum": [
"Original",
"Squares",
"Circles",
"Lines",
"Triangles",
"Diamonds"
],
"type": "string",
"description": "Module pattern style."
},
"logo_url": {
"type": "string",
"description": "URL of a logo image to place in the center."
},
"template": {
"type": "string",
"description": "Workspace template id to apply to all."
},
"eye_color": {
"type": "string",
"description": "Hex color for the corner eyes, only if different from `primary_color`."
},
"eye_style": {
"enum": [
"Square",
"Rounded",
"Drop",
"Leaf"
],
"type": "string",
"description": "Corner eye shape."
},
"workspace": {
"type": "string",
"description": "Workspace id. Optional when the account has one workspace; use list_workspaces to resolve otherwise."
},
"has_border": {
"type": "boolean",
"description": "Draw a border around the code."
},
"color_scope": {
"enum": [
"whole",
"pattern_only"
],
"type": "string",
"description": "'whole' (default) or 'pattern_only', as in create_qr_code."
},
"frame_color": {
"type": "string",
"description": "Hex color for the frame, only if different from `primary_color`."
},
"primary_color": {
"type": "string",
"description": "Hex color for the QR pattern, e.g. #111111. Eyes and frame follow it automatically (rules as in create_qr_code)."
},
"text_secondary": {
"type": "string",
"description": "Secondary caption line, where the frame supports it."
},
"idempotency_key": {
"type": "string",
"description": "Optional client key to make retries safe: if a previous call used the same key (same workspace), the earlier result is replayed instead of creating duplicate codes. Use a fresh key per distinct batch."
},
"background_color": {
"type": "string",
"description": "Hex background color, or 'transparent'."
},
"error_correction": {
"type": "string",
"description": "QR error correction level (L, M, Q, H). Leave unset: it is chosen automatically (H with a logo, Q otherwise)."
}
}
}{
"type": "object",
"properties": {
"page": {
"type": "integer",
"description": "1-based page number."
},
"query": {
"type": "string",
"description": "Search term (destination, display name, or tag)."
},
"folder": {
"type": "string",
"description": "Folder id or slug to filter by, or 'none' for codes in no folder."
},
"page_size": {
"type": "integer",
"description": "Results per page (max 200, default 25)."
},
"workspace": {
"type": "string",
"description": "Workspace id. Optional when the account has one workspace; use list_workspaces to resolve otherwise."
},
"subfolders": {
"type": "boolean",
"description": "With `folder`, also include codes in its subfolders."
},
"include_tags": {
"type": "boolean",
"description": "Add each code's tags. (Each code's folder is always included.)"
},
"include_scans": {
"type": "boolean",
"description": "Add total_scans and unique_scans (lifetime) to each code."
}
}
}| text_color | string | Hex text color. |
| description | string | New description. |
| button_color | string | Hex submit-button color. |
| redirect_url | string | URL to send respondents to after they submit. |
| button_text_color | string | Hex button-text color. |
| thank_you_message | string | Shown after submitting (if no redirect). |
{
"type": "object",
"required": [
"id"
],
"properties": {
"id": {
"type": "string",
"description": "Form id."
},
"theme": {
"enum": [
"light",
"dark",
"minimal",
"bold"
],
"type": "string",
"description": "Named color preset. Explicit colors below override it."
},
"title": {
"type": "string",
"description": "New title."
},
"fields": {
"type": "array",
"items": {
"type": "object",
"required": [
"label"
],
"properties": {
"id": {
"type": "string",
"description": "Existing field id to keep/update; omit if new."
},
"nps": {
"type": "boolean",
"description": "Net Promoter Score preset (0–10, standard labels)."
},
"type": {
"enum": [
"text",
"email",
"phone",
"number",
"textarea",
"select",
"radio",
"checkbox",
"date",
"time",
"url",
"rating",
"scale",
"yes_no",
"image_choice",
"ranking",
"statement",
"hidden",
"page_break",
"image"
],
"type": "string",
"description": "Field type."
},
"label": {
"type": "string",
"description": "The field's question/label."
},
"options": {
"type": "array",
"items": {
"type": [
"string",
"object"
]
},
"description": "Choices for select/radio/checkbox/ranking; {label, image} objects for image_choice."
},
"required": {
"type": "boolean",
"description": "Whether an answer is required."
},
"max_label": {
"type": "string",
"description": "scale only: label under the top value"
},
"min_label": {
"type": "string",
"description": "scale only: label under the lowest value"
},
"show_when": {
"type": "object",
"required": [
"rules"
],
"properties": {
"match": {
"enum": [
"all",
"any"
],
"type": "string",
"description": "Default 'all'."
},
"rules": {
"type": "array",
"items": {
"type": "object",
"required": [
"field",
"op"
],
"properties": {
"op": {
"enum": [
"eq",
"neq",
"contains",
"not_contains",
"gt",
"lt",
"is_empty",
"not_empty"
],
"type": "string",
"description": "eq / neq (is, is not), contains / not_contains (text or checkbox), gt / lt (numbers, ratings, dates), is_empty / not_empty (no value needed)."
},
"field": {
"type": "string",
"description": "The question this condition looks at: its label, its id, or its 0-based position."
},
"value": {
"type": "string",
"description": "Value to compare with (an option's value for choice questions)."
}
}
}
},
"action": {
"enum": [
"show",
"require"
],
"type": "string",
"description": "'show' (default): shown only while the rules match. 'require': always shown, required only while they match. On a page_break field the rules skip the whole page."
}
},
"description": "Conditional logic: show this field only while its conditions match EARLIER answers (e.g. a follow-up question, or a statement recommending a product). Omit to always show."
}
}
},
"description": "Complete desired field list (see note); create_form shape plus an optional `id`."
},
"status": {
"enum": [
"close",
"reopen"
],
"type": "string",
"description": "Close (stop responses) or reopen. When set, other edits are ignored."
},
"bg_color": {
"type": "string",
"description": "Hex background color."
},
"logo_url": {
"type": "string",
"description": "URL of a logo image (JPEG/PNG/GIF/WebP) to show on the form."
},
"outcomes": {
"type": "array",
"items": {
"type": "object",
"required": [
"name",
"rules"
],
"properties": {
"name": {
"type": "string",
"description": "Short name, recorded on each response (e.g. 'Recommend Zero Sugar')."
},
"match": {
"enum": [
"all",
"any"
],
"type": "string",
"description": "Default 'all'."
},
"rules": {
"type": "array",
"items": {
"type": "object",
"required": [
"field",
"op"
],
"properties": {
"op": {
"enum": [
"eq",
"neq",
"contains",
"not_contains",
"gt",
"lt",
"is_empty",
"not_empty"
],
"type": "string",
"description": "eq / neq (is, is not), contains / not_contains (text or checkbox), gt / lt (numbers, ratings, dates), is_empty / not_empty (no value needed)."
},
"field": {
"type": "string",
"description": "The question this condition looks at: its label, its id, or its 0-based position."
},
"value": {
"type": "string",
"description": "Value to compare with (an option's value for choice questions)."
}
}
}
},
"end_early": {
"type": "boolean",
"description": "Screening: end the form as soon as this matches (checked on every page change), not just at submit."
},
"redirect_url": {
"type": "string",
"description": "Optional page to send the respondent to."
},
"thank_you_title": {
"type": "string"
},
"thank_you_message": {
"type": "string"
}
}
},
"description": "Pathways / branching endings. After submit the first outcome whose rules match decides the ending: its own thank-you title/message and/or a redirect_url (e.g. send people to a different product page per answer). If none match, the default thank-you page is shown."
},
"text_color": {
"type": "string",
"description": "Hex text color."
},
"description": {
"type": "string",
"description": "New description."
},
"button_color": {
"type": "string",
"description": "Hex submit-button color."
},
"redirect_url": {
"type": "string",
"description": "URL to send respondents to after they submit."
},
"button_text_color": {
"type": "string",
"description": "Hex button-text color."
},
"thank_you_message": {
"type": "string",
"description": "Shown after submitting (if no redirect)."
}
}
}{
"type": "object",
"required": [
"id"
],
"properties": {
"id": {
"type": "string",
"description": "Page id."
},
"title": {
"type": "string",
"description": "New page title."
},
"blocks": {
"type": "array",
"items": {
"type": "object",
"required": [
"type"
],
"properties": {
"id": {
"type": "string",
"description": "Existing block id to keep/update; omit if new."
},
"form": {
"type": "string",
"description": "For a 'form' block: the form id to embed."
},
"type": {
"type": "string",
"description": "Block type (see list_block_types)."
},
"hidden": {
"type": "boolean",
"description": "Hide this block from the live page."
},
"content": {
"type": "object",
"description": "The block's content for that type."
}
}
},
"description": "Complete desired block list (see note); each is {type, content} + optional id."
},
"publish": {
"type": "boolean",
"description": "true = publish/re-publish so edits go live; false = take offline (draft)."
},
"bg_color": {
"type": "string",
"description": "Hex page background color."
},
"text_color": {
"type": "string",
"description": "Hex text color."
},
"description": {
"type": "string",
"description": "New SEO/description text."
}
}
}| Move the code into this folder (id or slug from list_folders); 'none' unfiles it. |
| pattern | string | Module pattern style. |
| qr_data | string | New destination URL/text (dynamic codes only). |
| add_tags | array | Tag titles to add (created in the workspace if new). |
| logo_url | string | URL of a logo image to place in the center. |
| eye_color | string | Hex color for the corner eyes, if different from `primary_color` (which they follow by default). |
| eye_style | string | Corner eye shape. |
| has_border | boolean | Draw a border around the code. |
| logo_round | boolean | Force the logo into a circle. |
| color_scope | string | How far a `primary_color` change should reach; only relevant alongside `primary_color`. Default 'whole' matches whole-code language — 'make it red', 'make the QR code dark green' — so pattern, eyes, and frame all follow `primary_color` together. Set 'pattern_only' for language that names one part specifically — 'change the pattern color to red', 'just recolor the dots' — so eyes and frame are left exactly as they are. |
| frame_color | string | Hex color for the frame, if different from `primary_color` (which it follows by default). |
| logo_base64 | string | A logo image as base64 (JPEG/PNG/GIF/WebP, under 2 MB; a data: URI prefix is fine) to place in the center — use `logo_url` instead whenever the image is reachable at a URL. Producing this string means generating it yourself as text, and a single dropped or altered character anywhere in a long base64 string corrupts everything after it — the code then renders with a blank space where the logo should be, discovered only after the fact. If a call with this fails validation (e.g. 'corrupted or incomplete'), that's very likely this happening — retry by generating the string again rather than assuming the source image is bad. |
| remove_logo | boolean | Remove the code's logo. |
| remove_tags | array | Tags to remove from this code, by title, slug, or id. |
| display_name | string | New internal name. |
| gps_tracking | boolean | Enable/disable location prompt. |
| primary_color | string | Hex color for the QR pattern, e.g. #111111. Eyes and frame follow this automatically — one color request styles the whole code; only set `eye_color`/`frame_color` for a code that should use a *different* color for those, e.g. 'dark green with gold eyes'. See `color_scope` for language that names just the pattern. |
| text_secondary | string | Secondary caption line, where the frame supports it. |
| background_color | string | Hex background color, or 'transparent'. |
| error_correction | string | QR error correction level: L, M, Q, or H (higher tolerates more damage but is denser). Already handled automatically — the renderer uses H whenever the code has a logo, Q otherwise — so leave this unset by default, including when adding or changing a logo in this same call; only set it to deliberately override that automatic choice. |
{
"type": "object",
"required": [
"id"
],
"properties": {
"id": {
"type": "string",
"description": "QR code id."
},
"text": {
"type": "string",
"description": "Caption text. Renders on any frame that supports one; if `frame` isn't also given (or the one given can't show text), a frame that can is chosen automatically."
},
"frame": {
"type": "string",
"description": "Frame slug. A caption (`text`) works on any frame — set `text` without a `frame` and one that can show it is chosen automatically. Frames that show a caption: card, card-above, speech-bubble, speech-bubble-above."
},
"folder": {
"type": "string",
"description": "Move the code into this folder (id or slug from list_folders); 'none' unfiles it."
},
"pattern": {
"enum": [
"Original",
"Squares",
"Circles",
"Lines",
"Triangles",
"Diamonds"
],
"type": "string",
"description": "Module pattern style."
},
"qr_data": {
"type": "string",
"description": "New destination URL/text (dynamic codes only)."
},
"add_tags": {
"type": "array",
"items": {
"type": "string"
},
"description": "Tag titles to add (created in the workspace if new)."
},
"logo_url": {
"type": "string",
"description": "URL of a logo image to place in the center."
},
"eye_color": {
"type": "string",
"description": "Hex color for the corner eyes, if different from `primary_color` (which they follow by default)."
},
"eye_style": {
"enum": [
"Square",
"Rounded",
"Drop",
"Leaf"
],
"type": "string",
"description": "Corner eye shape."
},
"has_border": {
"type": "boolean",
"description": "Draw a border around the code."
},
"logo_round": {
"type": "boolean",
"description": "Force the logo into a circle."
},
"color_scope": {
"enum": [
"whole",
"pattern_only"
],
"type": "string",
"description": "How far a `primary_color` change should reach; only relevant alongside `primary_color`. Default 'whole' matches whole-code language — 'make it red', 'make the QR code dark green' — so pattern, eyes, and frame all follow `primary_color` together. Set 'pattern_only' for language that names one part specifically — 'change the pattern color to red', 'just recolor the dots' — so eyes and frame are left exactly as they are."
},
"frame_color": {
"type": "string",
"description": "Hex color for the frame, if different from `primary_color` (which it follows by default)."
},
"logo_base64": {
"type": "string",
"description": "A logo image as base64 (JPEG/PNG/GIF/WebP, under 2 MB; a data: URI prefix is fine) to place in the center — use `logo_url` instead whenever the image is reachable at a URL. Producing this string means generating it yourself as text, and a single dropped or altered character anywhere in a long base64 string corrupts everything after it — the code then renders with a blank space where the logo should be, discovered only after the fact. If a call with this fails validation (e.g. 'corrupted or incomplete'), that's very likely this happening — retry by generating the string again rather than assuming the source image is bad."
},
"remove_logo": {
"type": "boolean",
"description": "Remove the code's logo."
},
"remove_tags": {
"type": "array",
"items": {
"type": "string"
},
"description": "Tags to remove from this code, by title, slug, or id."
},
"display_name": {
"type": "string",
"description": "New internal name."
},
"gps_tracking": {
"type": "boolean",
"description": "Enable/disable location prompt."
},
"primary_color": {
"type": "string",
"description": "Hex color for the QR pattern, e.g. #111111. Eyes and frame follow this automatically — one color request styles the whole code; only set `eye_color`/`frame_color` for a code that should use a *different* color for those, e.g. 'dark green with gold eyes'. See `color_scope` for language that names just the pattern."
},
"text_secondary": {
"type": "string",
"description": "Secondary caption line, where the frame supports it."
},
"background_color": {
"type": "string",
"description": "Hex background color, or 'transparent'."
},
"error_correction": {
"type": "string",
"description": "QR error correction level: L, M, Q, or H (higher tolerates more damage but is denser). Already handled automatically — the renderer uses H whenever the code has a logo, Q otherwise — so leave this unset by default, including when adding or changing a logo in this same call; only set it to deliberately override that automatic choice."
}
}
}