QR Codes
Update QR Code
Updates a QR code. Requires the qr:write scope.
Dynamic codes: name, target.destination, target.utm, design,
folder_id, tags, is_active. Changing the design re-renders the
stored image on the code’s own host (its custom domain, if it has one);
changing the destination does not require reprinting — the short
URL stays the same. domain_id cannot change after creation (422 for
a different value; the current one is accepted): the host is printed
in the QR.
Dynamic wifi/email/sms/event codes are updated with their
structured fields (target.ssid/password/encryption,
target.email/subject/message/cc/bcc,
target.phone/message,
target.title/location/start/end) rather than
target.destination; omitted fields keep their current value.
Dynamic text codes take target.text.
The link types (youtube … googleform) take target.destination
like url. whatsapp takes target.phone and/or target.message
(an omitted one keeps its value) or a WhatsApp link in
target.destination; telegram takes target.destination (a
@username, phone or t.me link). Either can also be re-pointed to any
other http(s) page. location takes target.lat + target.lng
and/or map_app, label, address (omitted ones keep their value);
a plain target.destination turns it into an ordinary redirect.
Static codes: only name, folder_id and design (the payload is
baked into the printed code).
Dynamic GS1 codes: destination (the default link), links,
overrides, plus name, design, folder_id, tags and
is_active — all at the TOP level, not under target. The identifier
(primary_key, qualifiers, attributes, domain, domain_id,
mode, gs1_key) is printed on packaging and immutable: naming any of
them returns 422 with gs1_code: GS1_IDENTIFIER_IMMUTABLE rather
than silently ignoring the field. A dynamic GS1 code therefore reports
target.editable: false, with target.destination set to its Digital
Link URI. A static GS1 code bakes its Digital Link into the image
and, like every static code, cannot be re-pointed.
Codes that hold a page rather than a link — link pages (including review
pages created through this API), forms, menus, app-store and smart-URL
codes, and uploaded file/audio/video codes — store a
document or an uploaded file rather than a destination. They are
reported with target.editable: false (and target.destination set to
their public hosted page URL). Sending target for one of those is
refused with 409 target_not_editable and nothing in the request is
applied; edit them in the dashboard. Their other fields (name,
folder_id, tags, design, is_active) update normally.
PATCH
/
qr-codes
/
{id}
Update QR Code
curl --request PATCH \
--url https://api.useqrkit.com/v1/qr-codes/{id} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "<string>",
"target": {
"destination": "<string>",
"text": "<string>",
"email": "[email protected]",
"subject": "<string>",
"message": "<string>",
"cc": "<string>",
"bcc": "<string>",
"phone": "<string>",
"ssid": "<string>",
"password": "<string>",
"title": "<string>",
"location": "<string>",
"start": "<string>",
"end": "<string>",
"lat": 0,
"lng": 0,
"label": "<string>",
"address": "<string>",
"utm": {
"source": "<string>",
"medium": "<string>",
"campaign": "<string>",
"term": "<string>",
"content": "<string>"
}
},
"design": {
"colors": {
"foreground": "#000000",
"background": "#ffffff"
},
"gradient": {
"start": "#005ae0",
"end": "#00c2ff",
"type": "linear-top-to-bottom"
},
"shapes": {
"body": "square",
"eye_frame": "square",
"eye_ball": "square"
},
"eye_colors": {
"frame": "#005ae0",
"ball": "#004bb8"
},
"logo": {
"url": "<string>",
"clear_background": false
},
"transparent_background": false
},
"folder_id": "<string>",
"tags": [
"<string>"
],
"is_active": true,
"destination": "<string>",
"links": [
{
"linkType": "gs1:pip",
"href": "<string>",
"title": "<string>",
"hreflang": [
"<string>"
],
"type": "<string>",
"context": [
"<string>"
]
}
],
"overrides": [
{
"path": "10/LOT1",
"href": "<string>",
"links": [
{
"linkType": "gs1:pip",
"href": "<string>",
"title": "<string>",
"hreflang": [
"<string>"
],
"type": "<string>",
"context": [
"<string>"
]
}
]
}
]
}
'import requests
url = "https://api.useqrkit.com/v1/qr-codes/{id}"
payload = {
"name": "<string>",
"target": {
"destination": "<string>",
"text": "<string>",
"email": "[email protected]",
"subject": "<string>",
"message": "<string>",
"cc": "<string>",
"bcc": "<string>",
"phone": "<string>",
"ssid": "<string>",
"password": "<string>",
"title": "<string>",
"location": "<string>",
"start": "<string>",
"end": "<string>",
"lat": 0,
"lng": 0,
"label": "<string>",
"address": "<string>",
"utm": {
"source": "<string>",
"medium": "<string>",
"campaign": "<string>",
"term": "<string>",
"content": "<string>"
}
},
"design": {
"colors": {
"foreground": "#000000",
"background": "#ffffff"
},
"gradient": {
"start": "#005ae0",
"end": "#00c2ff",
"type": "linear-top-to-bottom"
},
"shapes": {
"body": "square",
"eye_frame": "square",
"eye_ball": "square"
},
"eye_colors": {
"frame": "#005ae0",
"ball": "#004bb8"
},
"logo": {
"url": "<string>",
"clear_background": False
},
"transparent_background": False
},
"folder_id": "<string>",
"tags": ["<string>"],
"is_active": True,
"destination": "<string>",
"links": [
{
"linkType": "gs1:pip",
"href": "<string>",
"title": "<string>",
"hreflang": ["<string>"],
"type": "<string>",
"context": ["<string>"]
}
],
"overrides": [
{
"path": "10/LOT1",
"href": "<string>",
"links": [
{
"linkType": "gs1:pip",
"href": "<string>",
"title": "<string>",
"hreflang": ["<string>"],
"type": "<string>",
"context": ["<string>"]
}
]
}
]
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: '<string>',
target: {
destination: '<string>',
text: '<string>',
email: '[email protected]',
subject: '<string>',
message: '<string>',
cc: '<string>',
bcc: '<string>',
phone: '<string>',
ssid: '<string>',
password: '<string>',
title: '<string>',
location: '<string>',
start: '<string>',
end: '<string>',
lat: 0,
lng: 0,
label: '<string>',
address: '<string>',
utm: {
source: '<string>',
medium: '<string>',
campaign: '<string>',
term: '<string>',
content: '<string>'
}
},
design: {
colors: {foreground: '#000000', background: '#ffffff'},
gradient: {start: '#005ae0', end: '#00c2ff', type: 'linear-top-to-bottom'},
shapes: {body: JSON.stringify('square'), eye_frame: 'square', eye_ball: 'square'},
eye_colors: {frame: '#005ae0', ball: '#004bb8'},
logo: {url: '<string>', clear_background: false},
transparent_background: false
},
folder_id: '<string>',
tags: ['<string>'],
is_active: true,
destination: '<string>',
links: [
{
linkType: 'gs1:pip',
href: '<string>',
title: '<string>',
hreflang: ['<string>'],
type: '<string>',
context: ['<string>']
}
],
overrides: [
{
path: '10/LOT1',
href: '<string>',
links: [
{
linkType: 'gs1:pip',
href: '<string>',
title: '<string>',
hreflang: ['<string>'],
type: '<string>',
context: ['<string>']
}
]
}
]
})
};
fetch('https://api.useqrkit.com/v1/qr-codes/{id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.useqrkit.com/v1/qr-codes/{id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'name' => '<string>',
'target' => [
'destination' => '<string>',
'text' => '<string>',
'email' => '[email protected]',
'subject' => '<string>',
'message' => '<string>',
'cc' => '<string>',
'bcc' => '<string>',
'phone' => '<string>',
'ssid' => '<string>',
'password' => '<string>',
'title' => '<string>',
'location' => '<string>',
'start' => '<string>',
'end' => '<string>',
'lat' => 0,
'lng' => 0,
'label' => '<string>',
'address' => '<string>',
'utm' => [
'source' => '<string>',
'medium' => '<string>',
'campaign' => '<string>',
'term' => '<string>',
'content' => '<string>'
]
],
'design' => [
'colors' => [
'foreground' => '#000000',
'background' => '#ffffff'
],
'gradient' => [
'start' => '#005ae0',
'end' => '#00c2ff',
'type' => 'linear-top-to-bottom'
],
'shapes' => [
'body' => 'square',
'eye_frame' => 'square',
'eye_ball' => 'square'
],
'eye_colors' => [
'frame' => '#005ae0',
'ball' => '#004bb8'
],
'logo' => [
'url' => '<string>',
'clear_background' => false
],
'transparent_background' => false
],
'folder_id' => '<string>',
'tags' => [
'<string>'
],
'is_active' => true,
'destination' => '<string>',
'links' => [
[
'linkType' => 'gs1:pip',
'href' => '<string>',
'title' => '<string>',
'hreflang' => [
'<string>'
],
'type' => '<string>',
'context' => [
'<string>'
]
]
],
'overrides' => [
[
'path' => '10/LOT1',
'href' => '<string>',
'links' => [
[
'linkType' => 'gs1:pip',
'href' => '<string>',
'title' => '<string>',
'hreflang' => [
'<string>'
],
'type' => '<string>',
'context' => [
'<string>'
]
]
]
]
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.useqrkit.com/v1/qr-codes/{id}"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"target\": {\n \"destination\": \"<string>\",\n \"text\": \"<string>\",\n \"email\": \"[email protected]\",\n \"subject\": \"<string>\",\n \"message\": \"<string>\",\n \"cc\": \"<string>\",\n \"bcc\": \"<string>\",\n \"phone\": \"<string>\",\n \"ssid\": \"<string>\",\n \"password\": \"<string>\",\n \"title\": \"<string>\",\n \"location\": \"<string>\",\n \"start\": \"<string>\",\n \"end\": \"<string>\",\n \"lat\": 0,\n \"lng\": 0,\n \"label\": \"<string>\",\n \"address\": \"<string>\",\n \"utm\": {\n \"source\": \"<string>\",\n \"medium\": \"<string>\",\n \"campaign\": \"<string>\",\n \"term\": \"<string>\",\n \"content\": \"<string>\"\n }\n },\n \"design\": {\n \"colors\": {\n \"foreground\": \"#000000\",\n \"background\": \"#ffffff\"\n },\n \"gradient\": {\n \"start\": \"#005ae0\",\n \"end\": \"#00c2ff\",\n \"type\": \"linear-top-to-bottom\"\n },\n \"shapes\": {\n \"body\": \"square\",\n \"eye_frame\": \"square\",\n \"eye_ball\": \"square\"\n },\n \"eye_colors\": {\n \"frame\": \"#005ae0\",\n \"ball\": \"#004bb8\"\n },\n \"logo\": {\n \"url\": \"<string>\",\n \"clear_background\": false\n },\n \"transparent_background\": false\n },\n \"folder_id\": \"<string>\",\n \"tags\": [\n \"<string>\"\n ],\n \"is_active\": true,\n \"destination\": \"<string>\",\n \"links\": [\n {\n \"linkType\": \"gs1:pip\",\n \"href\": \"<string>\",\n \"title\": \"<string>\",\n \"hreflang\": [\n \"<string>\"\n ],\n \"type\": \"<string>\",\n \"context\": [\n \"<string>\"\n ]\n }\n ],\n \"overrides\": [\n {\n \"path\": \"10/LOT1\",\n \"href\": \"<string>\",\n \"links\": [\n {\n \"linkType\": \"gs1:pip\",\n \"href\": \"<string>\",\n \"title\": \"<string>\",\n \"hreflang\": [\n \"<string>\"\n ],\n \"type\": \"<string>\",\n \"context\": [\n \"<string>\"\n ]\n }\n ]\n }\n ]\n}")
req, _ := http.NewRequest("PATCH", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.patch("https://api.useqrkit.com/v1/qr-codes/{id}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"target\": {\n \"destination\": \"<string>\",\n \"text\": \"<string>\",\n \"email\": \"[email protected]\",\n \"subject\": \"<string>\",\n \"message\": \"<string>\",\n \"cc\": \"<string>\",\n \"bcc\": \"<string>\",\n \"phone\": \"<string>\",\n \"ssid\": \"<string>\",\n \"password\": \"<string>\",\n \"title\": \"<string>\",\n \"location\": \"<string>\",\n \"start\": \"<string>\",\n \"end\": \"<string>\",\n \"lat\": 0,\n \"lng\": 0,\n \"label\": \"<string>\",\n \"address\": \"<string>\",\n \"utm\": {\n \"source\": \"<string>\",\n \"medium\": \"<string>\",\n \"campaign\": \"<string>\",\n \"term\": \"<string>\",\n \"content\": \"<string>\"\n }\n },\n \"design\": {\n \"colors\": {\n \"foreground\": \"#000000\",\n \"background\": \"#ffffff\"\n },\n \"gradient\": {\n \"start\": \"#005ae0\",\n \"end\": \"#00c2ff\",\n \"type\": \"linear-top-to-bottom\"\n },\n \"shapes\": {\n \"body\": \"square\",\n \"eye_frame\": \"square\",\n \"eye_ball\": \"square\"\n },\n \"eye_colors\": {\n \"frame\": \"#005ae0\",\n \"ball\": \"#004bb8\"\n },\n \"logo\": {\n \"url\": \"<string>\",\n \"clear_background\": false\n },\n \"transparent_background\": false\n },\n \"folder_id\": \"<string>\",\n \"tags\": [\n \"<string>\"\n ],\n \"is_active\": true,\n \"destination\": \"<string>\",\n \"links\": [\n {\n \"linkType\": \"gs1:pip\",\n \"href\": \"<string>\",\n \"title\": \"<string>\",\n \"hreflang\": [\n \"<string>\"\n ],\n \"type\": \"<string>\",\n \"context\": [\n \"<string>\"\n ]\n }\n ],\n \"overrides\": [\n {\n \"path\": \"10/LOT1\",\n \"href\": \"<string>\",\n \"links\": [\n {\n \"linkType\": \"gs1:pip\",\n \"href\": \"<string>\",\n \"title\": \"<string>\",\n \"hreflang\": [\n \"<string>\"\n ],\n \"type\": \"<string>\",\n \"context\": [\n \"<string>\"\n ]\n }\n ]\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.useqrkit.com/v1/qr-codes/{id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"<string>\",\n \"target\": {\n \"destination\": \"<string>\",\n \"text\": \"<string>\",\n \"email\": \"[email protected]\",\n \"subject\": \"<string>\",\n \"message\": \"<string>\",\n \"cc\": \"<string>\",\n \"bcc\": \"<string>\",\n \"phone\": \"<string>\",\n \"ssid\": \"<string>\",\n \"password\": \"<string>\",\n \"title\": \"<string>\",\n \"location\": \"<string>\",\n \"start\": \"<string>\",\n \"end\": \"<string>\",\n \"lat\": 0,\n \"lng\": 0,\n \"label\": \"<string>\",\n \"address\": \"<string>\",\n \"utm\": {\n \"source\": \"<string>\",\n \"medium\": \"<string>\",\n \"campaign\": \"<string>\",\n \"term\": \"<string>\",\n \"content\": \"<string>\"\n }\n },\n \"design\": {\n \"colors\": {\n \"foreground\": \"#000000\",\n \"background\": \"#ffffff\"\n },\n \"gradient\": {\n \"start\": \"#005ae0\",\n \"end\": \"#00c2ff\",\n \"type\": \"linear-top-to-bottom\"\n },\n \"shapes\": {\n \"body\": \"square\",\n \"eye_frame\": \"square\",\n \"eye_ball\": \"square\"\n },\n \"eye_colors\": {\n \"frame\": \"#005ae0\",\n \"ball\": \"#004bb8\"\n },\n \"logo\": {\n \"url\": \"<string>\",\n \"clear_background\": false\n },\n \"transparent_background\": false\n },\n \"folder_id\": \"<string>\",\n \"tags\": [\n \"<string>\"\n ],\n \"is_active\": true,\n \"destination\": \"<string>\",\n \"links\": [\n {\n \"linkType\": \"gs1:pip\",\n \"href\": \"<string>\",\n \"title\": \"<string>\",\n \"hreflang\": [\n \"<string>\"\n ],\n \"type\": \"<string>\",\n \"context\": [\n \"<string>\"\n ]\n }\n ],\n \"overrides\": [\n {\n \"path\": \"10/LOT1\",\n \"href\": \"<string>\",\n \"links\": [\n {\n \"linkType\": \"gs1:pip\",\n \"href\": \"<string>\",\n \"title\": \"<string>\",\n \"hreflang\": [\n \"<string>\"\n ],\n \"type\": \"<string>\",\n \"context\": [\n \"<string>\"\n ]\n }\n ]\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"id": "qr_123",
"object": "qr_code",
"kind": "dynamic",
"name": "<string>",
"type": "url",
"short_code": "AB3D5",
"short_url": "https://qrkit.to/AB3D5",
"domain_id": "dom_3",
"gs1": {
"mode": "static",
"key": "01/09506000134352/10/LOT1",
"digital_link": "<string>",
"primary_key": {
"ai": "<string>",
"value": "<string>"
},
"qualifiers": [
{
"ai": "<string>",
"value": "<string>"
}
],
"attributes": {},
"links": [
{
"linkType": "gs1:pip",
"href": "<string>",
"title": "<string>",
"hreflang": [
"<string>"
],
"type": "<string>",
"context": [
"<string>"
]
}
],
"overrides": [
{
"path": "10/LOT1",
"href": "<string>",
"links": [
{
"linkType": "gs1:pip",
"href": "<string>",
"title": "<string>",
"hreflang": [
"<string>"
],
"type": "<string>",
"context": [
"<string>"
]
}
]
}
],
"linkset_url": "https://api.useqrkit.com/v1/qr-codes/qr_123/linkset"
},
"target": {
"type": "<string>",
"destination": "<string>",
"editable": true,
"summary": {
"title": "<string>",
"menus": 123,
"items": 123
}
},
"design": {
"colors": {
"foreground": "<string>",
"background": "<string>"
},
"gradient": {
"start": "<string>",
"end": "<string>",
"type": "<string>"
},
"shapes": {
"body": "<string>",
"eye_frame": "<string>",
"eye_ball": "<string>"
},
"eye_colors": {
"frame": "<string>",
"ball": "<string>"
},
"has_logo": true,
"transparent_background": true
},
"folder_id": "fld_12",
"tags": [
"<string>"
],
"image_url": "https://img.useqrkit.com/qr-AB3D5-1717000000000.svg",
"download_url": "/v1/qr-codes/qr_123/download",
"is_active": true,
"scan_count": 123,
"utm": {
"source": "<string>",
"medium": "<string>",
"campaign": "<string>",
"term": "<string>",
"content": "<string>"
},
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"deleted_at": "2023-11-07T05:31:56Z"
}{
"error": {
"code": "invalid_request",
"message": "<string>",
"reason": "NOT_IN_TRASH",
"gs1_code": "NOT_ENTITLED",
"field": "<string>",
"fields": [
"<string>"
],
"limit": 123,
"current_count": 123,
"requested": 123,
"plan_id": "<string>",
"doc_url": "<string>",
"request_id": "<string>"
}
}{
"error": {
"code": "invalid_request",
"message": "<string>",
"reason": "NOT_IN_TRASH",
"gs1_code": "NOT_ENTITLED",
"field": "<string>",
"fields": [
"<string>"
],
"limit": 123,
"current_count": 123,
"requested": 123,
"plan_id": "<string>",
"doc_url": "<string>",
"request_id": "<string>"
}
}{
"error": {
"code": "invalid_request",
"message": "<string>",
"reason": "NOT_IN_TRASH",
"gs1_code": "NOT_ENTITLED",
"field": "<string>",
"fields": [
"<string>"
],
"limit": 123,
"current_count": 123,
"requested": 123,
"plan_id": "<string>",
"doc_url": "<string>",
"request_id": "<string>"
}
}{
"error": {
"code": "invalid_request",
"message": "<string>",
"reason": "NOT_IN_TRASH",
"gs1_code": "NOT_ENTITLED",
"field": "<string>",
"fields": [
"<string>"
],
"limit": 123,
"current_count": 123,
"requested": 123,
"plan_id": "<string>",
"doc_url": "<string>",
"request_id": "<string>"
}
}{
"error": {
"code": "invalid_request",
"message": "<string>",
"reason": "NOT_IN_TRASH",
"gs1_code": "NOT_ENTITLED",
"field": "<string>",
"fields": [
"<string>"
],
"limit": 123,
"current_count": 123,
"requested": 123,
"plan_id": "<string>",
"doc_url": "<string>",
"request_id": "<string>"
}
}{
"error": {
"code": "invalid_request",
"message": "<string>",
"reason": "NOT_IN_TRASH",
"gs1_code": "NOT_ENTITLED",
"field": "<string>",
"fields": [
"<string>"
],
"limit": 123,
"current_count": 123,
"requested": 123,
"plan_id": "<string>",
"doc_url": "<string>",
"request_id": "<string>"
}
}Authorizations
API key in the Authorization header: Bearer qr_live_… or Bearer qr_test_…. Token endpoints take a Clerk session JWT instead.
Path Parameters
Body
application/json
Maximum string length:
255Show child attributes
Show child attributes
Visual customization. Stored with the code, so the dashboard shows exactly what the API created.
Show child attributes
Show child attributes
Folder id, or null to remove from its folder.
Maximum array length:
10Pause/resume scanning (dynamic codes only). Turning a
paused code back on (true on a code that is off) takes
one of the plan's QR code slots — one GS1 slot for a
dynamic GS1 code — so it is refused with 422 and
reason: PLAN_LIMIT when the plan is full, and nothing
else in the request is applied. A GS1 code whose custom
domain was removed cannot be turned back on (409,
reason: DOMAIN_RETIRED).
GS1 codes only — the new default link (gs1:defaultLink). Must be https.
GS1 codes only — replaces the whole link list.
Maximum array length:
16Show child attributes
Show child attributes
GS1 codes only — replaces the whole override list.
Maximum array length:
500Show child attributes
Show child attributes
Response
Updated QR code
qr_… for dynamic, sqr_… for static.
Example:
"qr_123"
Example:
"qr_code"
Available options:
dynamic, static The stored type: any target.type the API creates (a review is stored as linkpage), gs1, or a dashboard-only type such as file, menupage, form or smarturl. Treat unknown values as opaque.
Example:
"url"
Example:
"AB3D5"
null for static codes. On the workspace custom domain when the code was created on one. For a dynamic GS1 code this is the Digital Link URI itself, not <host>/<short_code>.
Example:
"https://qrkit.to/AB3D5"
The custom domain short_url is on, or null for the default host (and for static codes).
Example:
"dom_3"
Present on GS1 codes only. The identifier half is READ-ONLY (R4 — it is
printed); links and overrides are the editable half.
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Example:
"fld_12"
Example:
"https://img.useqrkit.com/qr-AB3D5-1717000000000.svg"
Example:
"/v1/qr-codes/qr_123/download"
Dynamic codes: whether the redirect is on. Static codes: false while the code is in the Trash (the printed payload itself keeps working).
null for static codes (no tracking).
UTM parameters (null unless set on a dynamic url code).
Show child attributes
Show child attributes
null for a live code. Set while the code is in the Trash (or paused by a plan downgrade); restore it with POST /v1/qr-codes/{id}/restore.
⌘I
Update QR Code
curl --request PATCH \
--url https://api.useqrkit.com/v1/qr-codes/{id} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "<string>",
"target": {
"destination": "<string>",
"text": "<string>",
"email": "[email protected]",
"subject": "<string>",
"message": "<string>",
"cc": "<string>",
"bcc": "<string>",
"phone": "<string>",
"ssid": "<string>",
"password": "<string>",
"title": "<string>",
"location": "<string>",
"start": "<string>",
"end": "<string>",
"lat": 0,
"lng": 0,
"label": "<string>",
"address": "<string>",
"utm": {
"source": "<string>",
"medium": "<string>",
"campaign": "<string>",
"term": "<string>",
"content": "<string>"
}
},
"design": {
"colors": {
"foreground": "#000000",
"background": "#ffffff"
},
"gradient": {
"start": "#005ae0",
"end": "#00c2ff",
"type": "linear-top-to-bottom"
},
"shapes": {
"body": "square",
"eye_frame": "square",
"eye_ball": "square"
},
"eye_colors": {
"frame": "#005ae0",
"ball": "#004bb8"
},
"logo": {
"url": "<string>",
"clear_background": false
},
"transparent_background": false
},
"folder_id": "<string>",
"tags": [
"<string>"
],
"is_active": true,
"destination": "<string>",
"links": [
{
"linkType": "gs1:pip",
"href": "<string>",
"title": "<string>",
"hreflang": [
"<string>"
],
"type": "<string>",
"context": [
"<string>"
]
}
],
"overrides": [
{
"path": "10/LOT1",
"href": "<string>",
"links": [
{
"linkType": "gs1:pip",
"href": "<string>",
"title": "<string>",
"hreflang": [
"<string>"
],
"type": "<string>",
"context": [
"<string>"
]
}
]
}
]
}
'import requests
url = "https://api.useqrkit.com/v1/qr-codes/{id}"
payload = {
"name": "<string>",
"target": {
"destination": "<string>",
"text": "<string>",
"email": "[email protected]",
"subject": "<string>",
"message": "<string>",
"cc": "<string>",
"bcc": "<string>",
"phone": "<string>",
"ssid": "<string>",
"password": "<string>",
"title": "<string>",
"location": "<string>",
"start": "<string>",
"end": "<string>",
"lat": 0,
"lng": 0,
"label": "<string>",
"address": "<string>",
"utm": {
"source": "<string>",
"medium": "<string>",
"campaign": "<string>",
"term": "<string>",
"content": "<string>"
}
},
"design": {
"colors": {
"foreground": "#000000",
"background": "#ffffff"
},
"gradient": {
"start": "#005ae0",
"end": "#00c2ff",
"type": "linear-top-to-bottom"
},
"shapes": {
"body": "square",
"eye_frame": "square",
"eye_ball": "square"
},
"eye_colors": {
"frame": "#005ae0",
"ball": "#004bb8"
},
"logo": {
"url": "<string>",
"clear_background": False
},
"transparent_background": False
},
"folder_id": "<string>",
"tags": ["<string>"],
"is_active": True,
"destination": "<string>",
"links": [
{
"linkType": "gs1:pip",
"href": "<string>",
"title": "<string>",
"hreflang": ["<string>"],
"type": "<string>",
"context": ["<string>"]
}
],
"overrides": [
{
"path": "10/LOT1",
"href": "<string>",
"links": [
{
"linkType": "gs1:pip",
"href": "<string>",
"title": "<string>",
"hreflang": ["<string>"],
"type": "<string>",
"context": ["<string>"]
}
]
}
]
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: '<string>',
target: {
destination: '<string>',
text: '<string>',
email: '[email protected]',
subject: '<string>',
message: '<string>',
cc: '<string>',
bcc: '<string>',
phone: '<string>',
ssid: '<string>',
password: '<string>',
title: '<string>',
location: '<string>',
start: '<string>',
end: '<string>',
lat: 0,
lng: 0,
label: '<string>',
address: '<string>',
utm: {
source: '<string>',
medium: '<string>',
campaign: '<string>',
term: '<string>',
content: '<string>'
}
},
design: {
colors: {foreground: '#000000', background: '#ffffff'},
gradient: {start: '#005ae0', end: '#00c2ff', type: 'linear-top-to-bottom'},
shapes: {body: JSON.stringify('square'), eye_frame: 'square', eye_ball: 'square'},
eye_colors: {frame: '#005ae0', ball: '#004bb8'},
logo: {url: '<string>', clear_background: false},
transparent_background: false
},
folder_id: '<string>',
tags: ['<string>'],
is_active: true,
destination: '<string>',
links: [
{
linkType: 'gs1:pip',
href: '<string>',
title: '<string>',
hreflang: ['<string>'],
type: '<string>',
context: ['<string>']
}
],
overrides: [
{
path: '10/LOT1',
href: '<string>',
links: [
{
linkType: 'gs1:pip',
href: '<string>',
title: '<string>',
hreflang: ['<string>'],
type: '<string>',
context: ['<string>']
}
]
}
]
})
};
fetch('https://api.useqrkit.com/v1/qr-codes/{id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.useqrkit.com/v1/qr-codes/{id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'name' => '<string>',
'target' => [
'destination' => '<string>',
'text' => '<string>',
'email' => '[email protected]',
'subject' => '<string>',
'message' => '<string>',
'cc' => '<string>',
'bcc' => '<string>',
'phone' => '<string>',
'ssid' => '<string>',
'password' => '<string>',
'title' => '<string>',
'location' => '<string>',
'start' => '<string>',
'end' => '<string>',
'lat' => 0,
'lng' => 0,
'label' => '<string>',
'address' => '<string>',
'utm' => [
'source' => '<string>',
'medium' => '<string>',
'campaign' => '<string>',
'term' => '<string>',
'content' => '<string>'
]
],
'design' => [
'colors' => [
'foreground' => '#000000',
'background' => '#ffffff'
],
'gradient' => [
'start' => '#005ae0',
'end' => '#00c2ff',
'type' => 'linear-top-to-bottom'
],
'shapes' => [
'body' => 'square',
'eye_frame' => 'square',
'eye_ball' => 'square'
],
'eye_colors' => [
'frame' => '#005ae0',
'ball' => '#004bb8'
],
'logo' => [
'url' => '<string>',
'clear_background' => false
],
'transparent_background' => false
],
'folder_id' => '<string>',
'tags' => [
'<string>'
],
'is_active' => true,
'destination' => '<string>',
'links' => [
[
'linkType' => 'gs1:pip',
'href' => '<string>',
'title' => '<string>',
'hreflang' => [
'<string>'
],
'type' => '<string>',
'context' => [
'<string>'
]
]
],
'overrides' => [
[
'path' => '10/LOT1',
'href' => '<string>',
'links' => [
[
'linkType' => 'gs1:pip',
'href' => '<string>',
'title' => '<string>',
'hreflang' => [
'<string>'
],
'type' => '<string>',
'context' => [
'<string>'
]
]
]
]
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.useqrkit.com/v1/qr-codes/{id}"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"target\": {\n \"destination\": \"<string>\",\n \"text\": \"<string>\",\n \"email\": \"[email protected]\",\n \"subject\": \"<string>\",\n \"message\": \"<string>\",\n \"cc\": \"<string>\",\n \"bcc\": \"<string>\",\n \"phone\": \"<string>\",\n \"ssid\": \"<string>\",\n \"password\": \"<string>\",\n \"title\": \"<string>\",\n \"location\": \"<string>\",\n \"start\": \"<string>\",\n \"end\": \"<string>\",\n \"lat\": 0,\n \"lng\": 0,\n \"label\": \"<string>\",\n \"address\": \"<string>\",\n \"utm\": {\n \"source\": \"<string>\",\n \"medium\": \"<string>\",\n \"campaign\": \"<string>\",\n \"term\": \"<string>\",\n \"content\": \"<string>\"\n }\n },\n \"design\": {\n \"colors\": {\n \"foreground\": \"#000000\",\n \"background\": \"#ffffff\"\n },\n \"gradient\": {\n \"start\": \"#005ae0\",\n \"end\": \"#00c2ff\",\n \"type\": \"linear-top-to-bottom\"\n },\n \"shapes\": {\n \"body\": \"square\",\n \"eye_frame\": \"square\",\n \"eye_ball\": \"square\"\n },\n \"eye_colors\": {\n \"frame\": \"#005ae0\",\n \"ball\": \"#004bb8\"\n },\n \"logo\": {\n \"url\": \"<string>\",\n \"clear_background\": false\n },\n \"transparent_background\": false\n },\n \"folder_id\": \"<string>\",\n \"tags\": [\n \"<string>\"\n ],\n \"is_active\": true,\n \"destination\": \"<string>\",\n \"links\": [\n {\n \"linkType\": \"gs1:pip\",\n \"href\": \"<string>\",\n \"title\": \"<string>\",\n \"hreflang\": [\n \"<string>\"\n ],\n \"type\": \"<string>\",\n \"context\": [\n \"<string>\"\n ]\n }\n ],\n \"overrides\": [\n {\n \"path\": \"10/LOT1\",\n \"href\": \"<string>\",\n \"links\": [\n {\n \"linkType\": \"gs1:pip\",\n \"href\": \"<string>\",\n \"title\": \"<string>\",\n \"hreflang\": [\n \"<string>\"\n ],\n \"type\": \"<string>\",\n \"context\": [\n \"<string>\"\n ]\n }\n ]\n }\n ]\n}")
req, _ := http.NewRequest("PATCH", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.patch("https://api.useqrkit.com/v1/qr-codes/{id}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"target\": {\n \"destination\": \"<string>\",\n \"text\": \"<string>\",\n \"email\": \"[email protected]\",\n \"subject\": \"<string>\",\n \"message\": \"<string>\",\n \"cc\": \"<string>\",\n \"bcc\": \"<string>\",\n \"phone\": \"<string>\",\n \"ssid\": \"<string>\",\n \"password\": \"<string>\",\n \"title\": \"<string>\",\n \"location\": \"<string>\",\n \"start\": \"<string>\",\n \"end\": \"<string>\",\n \"lat\": 0,\n \"lng\": 0,\n \"label\": \"<string>\",\n \"address\": \"<string>\",\n \"utm\": {\n \"source\": \"<string>\",\n \"medium\": \"<string>\",\n \"campaign\": \"<string>\",\n \"term\": \"<string>\",\n \"content\": \"<string>\"\n }\n },\n \"design\": {\n \"colors\": {\n \"foreground\": \"#000000\",\n \"background\": \"#ffffff\"\n },\n \"gradient\": {\n \"start\": \"#005ae0\",\n \"end\": \"#00c2ff\",\n \"type\": \"linear-top-to-bottom\"\n },\n \"shapes\": {\n \"body\": \"square\",\n \"eye_frame\": \"square\",\n \"eye_ball\": \"square\"\n },\n \"eye_colors\": {\n \"frame\": \"#005ae0\",\n \"ball\": \"#004bb8\"\n },\n \"logo\": {\n \"url\": \"<string>\",\n \"clear_background\": false\n },\n \"transparent_background\": false\n },\n \"folder_id\": \"<string>\",\n \"tags\": [\n \"<string>\"\n ],\n \"is_active\": true,\n \"destination\": \"<string>\",\n \"links\": [\n {\n \"linkType\": \"gs1:pip\",\n \"href\": \"<string>\",\n \"title\": \"<string>\",\n \"hreflang\": [\n \"<string>\"\n ],\n \"type\": \"<string>\",\n \"context\": [\n \"<string>\"\n ]\n }\n ],\n \"overrides\": [\n {\n \"path\": \"10/LOT1\",\n \"href\": \"<string>\",\n \"links\": [\n {\n \"linkType\": \"gs1:pip\",\n \"href\": \"<string>\",\n \"title\": \"<string>\",\n \"hreflang\": [\n \"<string>\"\n ],\n \"type\": \"<string>\",\n \"context\": [\n \"<string>\"\n ]\n }\n ]\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.useqrkit.com/v1/qr-codes/{id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"<string>\",\n \"target\": {\n \"destination\": \"<string>\",\n \"text\": \"<string>\",\n \"email\": \"[email protected]\",\n \"subject\": \"<string>\",\n \"message\": \"<string>\",\n \"cc\": \"<string>\",\n \"bcc\": \"<string>\",\n \"phone\": \"<string>\",\n \"ssid\": \"<string>\",\n \"password\": \"<string>\",\n \"title\": \"<string>\",\n \"location\": \"<string>\",\n \"start\": \"<string>\",\n \"end\": \"<string>\",\n \"lat\": 0,\n \"lng\": 0,\n \"label\": \"<string>\",\n \"address\": \"<string>\",\n \"utm\": {\n \"source\": \"<string>\",\n \"medium\": \"<string>\",\n \"campaign\": \"<string>\",\n \"term\": \"<string>\",\n \"content\": \"<string>\"\n }\n },\n \"design\": {\n \"colors\": {\n \"foreground\": \"#000000\",\n \"background\": \"#ffffff\"\n },\n \"gradient\": {\n \"start\": \"#005ae0\",\n \"end\": \"#00c2ff\",\n \"type\": \"linear-top-to-bottom\"\n },\n \"shapes\": {\n \"body\": \"square\",\n \"eye_frame\": \"square\",\n \"eye_ball\": \"square\"\n },\n \"eye_colors\": {\n \"frame\": \"#005ae0\",\n \"ball\": \"#004bb8\"\n },\n \"logo\": {\n \"url\": \"<string>\",\n \"clear_background\": false\n },\n \"transparent_background\": false\n },\n \"folder_id\": \"<string>\",\n \"tags\": [\n \"<string>\"\n ],\n \"is_active\": true,\n \"destination\": \"<string>\",\n \"links\": [\n {\n \"linkType\": \"gs1:pip\",\n \"href\": \"<string>\",\n \"title\": \"<string>\",\n \"hreflang\": [\n \"<string>\"\n ],\n \"type\": \"<string>\",\n \"context\": [\n \"<string>\"\n ]\n }\n ],\n \"overrides\": [\n {\n \"path\": \"10/LOT1\",\n \"href\": \"<string>\",\n \"links\": [\n {\n \"linkType\": \"gs1:pip\",\n \"href\": \"<string>\",\n \"title\": \"<string>\",\n \"hreflang\": [\n \"<string>\"\n ],\n \"type\": \"<string>\",\n \"context\": [\n \"<string>\"\n ]\n }\n ]\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"id": "qr_123",
"object": "qr_code",
"kind": "dynamic",
"name": "<string>",
"type": "url",
"short_code": "AB3D5",
"short_url": "https://qrkit.to/AB3D5",
"domain_id": "dom_3",
"gs1": {
"mode": "static",
"key": "01/09506000134352/10/LOT1",
"digital_link": "<string>",
"primary_key": {
"ai": "<string>",
"value": "<string>"
},
"qualifiers": [
{
"ai": "<string>",
"value": "<string>"
}
],
"attributes": {},
"links": [
{
"linkType": "gs1:pip",
"href": "<string>",
"title": "<string>",
"hreflang": [
"<string>"
],
"type": "<string>",
"context": [
"<string>"
]
}
],
"overrides": [
{
"path": "10/LOT1",
"href": "<string>",
"links": [
{
"linkType": "gs1:pip",
"href": "<string>",
"title": "<string>",
"hreflang": [
"<string>"
],
"type": "<string>",
"context": [
"<string>"
]
}
]
}
],
"linkset_url": "https://api.useqrkit.com/v1/qr-codes/qr_123/linkset"
},
"target": {
"type": "<string>",
"destination": "<string>",
"editable": true,
"summary": {
"title": "<string>",
"menus": 123,
"items": 123
}
},
"design": {
"colors": {
"foreground": "<string>",
"background": "<string>"
},
"gradient": {
"start": "<string>",
"end": "<string>",
"type": "<string>"
},
"shapes": {
"body": "<string>",
"eye_frame": "<string>",
"eye_ball": "<string>"
},
"eye_colors": {
"frame": "<string>",
"ball": "<string>"
},
"has_logo": true,
"transparent_background": true
},
"folder_id": "fld_12",
"tags": [
"<string>"
],
"image_url": "https://img.useqrkit.com/qr-AB3D5-1717000000000.svg",
"download_url": "/v1/qr-codes/qr_123/download",
"is_active": true,
"scan_count": 123,
"utm": {
"source": "<string>",
"medium": "<string>",
"campaign": "<string>",
"term": "<string>",
"content": "<string>"
},
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"deleted_at": "2023-11-07T05:31:56Z"
}{
"error": {
"code": "invalid_request",
"message": "<string>",
"reason": "NOT_IN_TRASH",
"gs1_code": "NOT_ENTITLED",
"field": "<string>",
"fields": [
"<string>"
],
"limit": 123,
"current_count": 123,
"requested": 123,
"plan_id": "<string>",
"doc_url": "<string>",
"request_id": "<string>"
}
}{
"error": {
"code": "invalid_request",
"message": "<string>",
"reason": "NOT_IN_TRASH",
"gs1_code": "NOT_ENTITLED",
"field": "<string>",
"fields": [
"<string>"
],
"limit": 123,
"current_count": 123,
"requested": 123,
"plan_id": "<string>",
"doc_url": "<string>",
"request_id": "<string>"
}
}{
"error": {
"code": "invalid_request",
"message": "<string>",
"reason": "NOT_IN_TRASH",
"gs1_code": "NOT_ENTITLED",
"field": "<string>",
"fields": [
"<string>"
],
"limit": 123,
"current_count": 123,
"requested": 123,
"plan_id": "<string>",
"doc_url": "<string>",
"request_id": "<string>"
}
}{
"error": {
"code": "invalid_request",
"message": "<string>",
"reason": "NOT_IN_TRASH",
"gs1_code": "NOT_ENTITLED",
"field": "<string>",
"fields": [
"<string>"
],
"limit": 123,
"current_count": 123,
"requested": 123,
"plan_id": "<string>",
"doc_url": "<string>",
"request_id": "<string>"
}
}{
"error": {
"code": "invalid_request",
"message": "<string>",
"reason": "NOT_IN_TRASH",
"gs1_code": "NOT_ENTITLED",
"field": "<string>",
"fields": [
"<string>"
],
"limit": 123,
"current_count": 123,
"requested": 123,
"plan_id": "<string>",
"doc_url": "<string>",
"request_id": "<string>"
}
}{
"error": {
"code": "invalid_request",
"message": "<string>",
"reason": "NOT_IN_TRASH",
"gs1_code": "NOT_ENTITLED",
"field": "<string>",
"fields": [
"<string>"
],
"limit": 123,
"current_count": 123,
"requested": 123,
"plan_id": "<string>",
"doc_url": "<string>",
"request_id": "<string>"
}
}