Delete QR code

Overview

Soft-delete a QR code belonging to the authenticated account-user and removes its stored image from S3.

Prerequisites

  • A bearer token. Callable with Account tokens.
  • The qrCodeId of the record you are targeting.

Base URL

EnvironmentURL
Productionhttps://production-api.shoutaboutus.com
Developmenthttps://development-api.shoutaboutus.com

Endpoint

DELETE /api/v1/qr-codes/{qrCodeId}

Authentication

  • Requires a bearer token in the Authorization: Bearer <bearer-token> header.

  • Who can call it: Account tokens.

  • Authentication. The QR code must belong to the caller's own company (404 if not found).

  • The request injects the route id into validation data and asserts it is an existing QR code.

Rate limit

  • No rate limit.

Path parameters

ParameterTypeRequiredDescription
qrCodeIdintegerRequiredDigits only.

Response

  • data.status (string) — "success".
  • data.message (string) — "QR code deleted successfully".

200 OK · 200

{
  "data": {
    "status": "success",
    "message": "QR code deleted successfully"
  }
}

Errors

StatusMeaning
401The bearer token is missing, expired or invalid
404Returned if not found in the account company
422The request failed validation — the response names the fields
500Unexpected server error

Example request

curl --request DELETE \
  --url "https://production-api.shoutaboutus.com/api/v1/qr-codes/123" \
  --header 'Authorization: Bearer <bearer-token>' \
  --header 'Accept: application/json'

Did this page help you?