Delete a QR design
Overview
Remove a saved design. Codes already created keep their look.
Use this to clean up unused designs.
You'll need the template id (id in List QR designs), sent in the query string.
The design is removed.
Prerequisites
- An account bearer token. Send an OAuth 2.0 Bearer token as
Authorization: Bearer <bearer-token>; see Authentication. It must be an account-level token (issued to a user of an account or location), not a partner-only token. - The design's id (
id), from List QR designs.
Base URL
| Environment | URL |
|---|---|
| Production | https://production-api.shoutaboutus.com |
| Development | https://development-api.shoutaboutus.com |
Endpoint
DELETE /api/v1/qr-codes/template/delete
Authentication
Account token
- The design must have been created under your token's account; otherwise
404.
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 |
|---|---|---|---|---|
id | query | integer | Yes | The design to delete (id in List QR designs). |
Request body
None.
Request payload
None.
Response body
The payload is inside data.
| Field | Type | Description |
|---|---|---|
status | string | success. |
message | string | QR code template deleted successfully |
Response payload
{
"data": {
"status": "success",
"message": "QR code template deleted successfully"
}
}Examples
Success payload
See Response payload.
Error payload
404 Not found
{
"message": "QR code template not found",
"status": "error",
"errors": []
}422 id missing
{
"message": "The id field is required.",
"errors": {
"id": [
"The id field is required."
]
}
}422 Design doesn't exist
{
"message": "The selected id is invalid.",
"errors": {
"id": [
"The selected id is invalid."
]
}
}| Status | Meaning |
|---|---|
200 | The design was deleted. |
401 | The token is missing, expired or invalid. |
404 | QR code template not found: the design wasn't created under your token's account, or has already been deleted. |
422 | id is missing, or no design has this id. |
500 | Unexpected server error. |
Example request
curl --request DELETE \
--url "https://production-api.shoutaboutus.com/api/v1/qr-codes/template/delete?id=2964" \
--header 'Authorization: Bearer <bearer-token>' \
--header 'Accept: application/json'Updated 17 days ago