Delete a QR code
Overview
Remove a QR code. Scans of the printed image stop working.
Use this when a code is retired.
You'll need the qr_code_id (id in List QR codes).
The code is removed.
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
DELETE /api/v1/qr-codes/{qrCodeId}
Authentication
Account token
- The QR code 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 |
|---|---|---|---|---|
qrCodeId | path | integer | Yes | The QR code's id (id in List QR codes). Digits only. |
Request body
None.
Request payload
None.
Response body
The payload is inside data.
| Field | Type | Description |
|---|---|---|
status | string | success. |
message | string | QR code deleted successfully |
Response payload
{
"data": {
"status": "success",
"message": "QR code deleted successfully"
}
}Examples
Success payload
See Response payload.
Error payload
404 Not found
{
"message": "QR code not found",
"status": "error",
"errors": []
}422 QR code doesn't exist
{
"message": "The selected id is invalid.",
"errors": {
"id": [
"The selected id is invalid."
]
}
}| Status | Meaning |
|---|---|
200 | The QR code was deleted. |
401 | The token is missing, expired or invalid. |
404 | QR code not found: the code wasn't created under your token's account, or has already been deleted. |
422 | No QR code has this id. |
500 | Unexpected server error. |
Example request
curl --request DELETE \
--url "https://production-api.shoutaboutus.com/api/v1/qr-codes/2963" \
--header 'Authorization: Bearer <bearer-token>' \
--header 'Accept: application/json'Updated 17 days ago