Duplicate a QR code
Overview
Copy a code's settings to a new code.
Use this to create a similar code for another location.
You'll need the qr_code_id. Send any field to change it on the copy; the rest is copied from the source. The copy gets its own id, image and unique code, and is named <source> (Copy) unless you send name.
Returns the new code.
Prerequisites
- A bearer token for the account. See Authentication.
- The QR code's id (
qrCodeId), from List QR codes.
Base URL
| Environment | URL |
|---|---|
| Production | https://production-api.shoutaboutus.com |
| Development | https://development-api.shoutaboutus.com |
Endpoint
POST /api/v1/qr-codes/{qrCodeId}/duplicate
Authentication
Account token
- The source code must have been created under your token's account; otherwise
404. The copy belongs to the same account. store_id, when sent, must be a location inside your own account tree; otherwise422.
QR codes belong to the account that created them, and every QR endpoint matches on that account exactly; it doesn't walk the partner tree. A Partner token sees nothing, even for a location inside the partner's own tree: list endpoints return an empty result, and single-record endpoints return
404 QR code not found. The 404 means "not visible to this token", not "this QR code doesn't exist". Use an Account token for every endpoint in this section.
Rate limit
This endpoint has no rate limit.
Request parameters
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
qrCodeId | path | integer | Yes | The id of the QR code to copy (id in List QR codes). Digits only. |
Request body
| Field | Type | Required | Description |
|---|---|---|---|
name | string | No | Name for the copy, up to 255 characters. Defaults to <source> (Copy). |
store_id | integer | No | A location for the copy. Must be inside your account tree. Defaults to the source's location. |
destination_type | string | No | Where a scan goes: landing_page (a landing page template), review_site (the location's landing page URL on a review site) or custom_url (any URL). |
landing_page_id | integer | Conditional | Required when destination_type is landing_page. The landing page template (value in List landing page templates); must be one of your account's templates or a shared one. |
review_site_id | integer | Conditional | Required when destination_type is review_site. The review site (value in List supported review sites). |
destination_url | string | Conditional | Required when destination_type is custom_url. The URL a scan opens. |
customization | object | No | How the image looks: color (a hex colour such as #000000, a colour name, or [r, g, b]) and width (pixels, 64 to 2048; 300 when left out). |
Request payload
{
"name": "Front desk (Copy)",
"store_id": 3008
}Response body
The payload is inside data.
| Field | Type | Description |
|---|---|---|
status | string | success. |
data | object | The new QR code. |
data.id | integer | The QR code's id. Use it as qrCodeId. |
data.name | string | The code's name. |
data.company_id | integer | The account that owns the code. |
data.store_id | integer | The location the code is for. |
data.qr_code_image_path | string | Where the image is stored. |
data.destination_type | string | Where a scan goes: landing_page (a landing page template), review_site (the location's landing page URL on a review site) or custom_url (any URL). |
data.landing_page_id | integer or null | The landing page template, for landing_page. |
data.review_site_id | integer or null | The review site, for review_site. |
data.destination_url | string or null | The URL a scan opens. |
data.customization | object or null | How the image looks: color (a hex colour such as #000000, a colour name, or [r, g, b]) and width (pixels, 64 to 2048; 300 when left out). |
data.created_at | string | When the code was created (ISO 8601). |
data.updated_at | string | When the code was last changed (ISO 8601). |
data.unique_code | string | The code's public id, used in the link the image encodes. |
data.qr_code_image_url | string or null | URL of the QR code image (PNG). |
data.company | object | The owning account. |
data.company.id | integer | The account's id. |
data.company.name | string | The account's name. |
data.store | object or null | The location. |
data.store.id | integer | The location's id. |
data.store.name | string | The location's name. |
data.landing_page | object or null | The landing page template, or null. |
data.landing_page.id | integer | The template's id. |
data.landing_page.unique_code | string | The template's encoded id. |
data.review_site | object or null | The review site ({"id": …}), or null. |
message | string | QR code duplicated successfully |
Response payload
{
"data": {
"status": "success",
"data": {
"name": "Front desk (Copy)",
"company_id": 5994,
"store_id": 3008,
"destination_type": "landing_page",
"landing_page_id": 1,
"review_site_id": null,
"destination_url": "https://production.shoutaboutus.com/lp/1?store_id=3008",
"customization": {
"color": "#000000",
"width": 240
},
"updated_at": "2026-10-01T10:10:01.000000Z",
"created_at": "2026-10-01T10:10:00.000000Z",
"id": 3120,
"qr_code_image_path": "qr_codes/qr_3120_1790935801.png",
"unique_code": "p8rwyk",
"qr_code_image_url": "https://d2ny6zb7otrnhl.cloudfront.net/qr_codes/qr_3120_1790935801.png",
"company": {
"id": 5994,
"name": "Acme Coffee"
},
"store": {
"id": 3008,
"name": "Acme Coffee - Circular Quay"
},
"landing_page": {
"id": 1,
"unique_code": "9ocy"
},
"review_site": null
},
"message": "QR code duplicated successfully"
}
}Examples
Success payload
See Response payload.
Error payload
404 Not found
{
"message": "QR code not found",
"status": "error",
"errors": []
}422 Location outside your tree
{
"message": "The selected store id does not belong to your company hierarchy.",
"errors": {
"store_id": [
"The selected store id does not belong to your company hierarchy."
]
}
}422 Invalid destination type
{
"message": "The selected destination type is invalid.",
"errors": {
"destination_type": [
"The selected destination type is invalid."
]
}
}| Status | Meaning |
|---|---|
201 | The copy was created. |
401 | The token is missing, expired or invalid. |
404 | QR code not found: the source wasn't created under your token's account, or has been deleted. |
422 | A field is invalid, or store_id is outside your tree. |
500 | Unexpected server error. |
Example request
curl --request POST \
--url "https://production-api.shoutaboutus.com/api/v1/qr-codes/2963/duplicate" \
--header 'Authorization: Bearer <bearer-token>' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--data '{"name": "Front desk (Copy)", "store_id": 3008}'Updated 17 days ago
