Create a QR code
create_qr_codeCreate a QR code. kind is a catalog id (url, wifi, vcard, email, phone, sms, text, instagram, googlereview, whatsapp, pdf, ...); fields are that kind's fields, e.g. {url: 'https://...'} for url, {ssid, password, encryption} for wifi, {handle} for instagram. url/phone/email/sms/location codes are dynamic, meaning their destination can be changed later without reprinting: a free account gets one, a paid plan makes every code dynamic. Check dynamic in the result and say so if a code came back static. Returns the code with its printed short link and image URL.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| kind | No | Catalog id; call list_code_kinds for the full list | url |
| label | No | A name for the dashboard | |
| fields | Yes | The kind's fields as key/value strings | |
| bg_color | No | ||
| fg_color | No | ||
| domain_id | No | Which of the account's link domains this code prints with (list_domains); omit for the default | |
| frame_style | No | A frame id from the frames catalog; omit for none | |
| frame_caption | No |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| id | No | ||
| kind | No | ||
| type | No | ||
| label | No | ||
| scans | No | ||
| dynamic | No | ||
| bg_color | No | ||
| fg_color | No | ||
| has_logo | No | ||
| domain_id | No | ||
| image_url | No | Print-ready SVG; needs the Authorization header | |
| short_url | No | What to print for a dynamic code | |
| created_at | No | ||
| kind_label | No | ||
| manage_url | No | ||
| short_code | No | ||
| updated_at | No | ||
| destination | No | ||
| frame_style | No | ||
| frame_caption | No | ||
| dynamic_capable | No | ||
| destination_data | No | ||
| png_download_url | No | Plain PNG (no frame or logo) through a signed 24-hour link | |
| svg_download_url | No | Same SVG through a signed link that works for 24 hours with no header | |
| download_expires_at | No |