Delete QR template

Overview

Soft-delete a QR code template identified by the id query parameter. A soft-delete marks the template as deleted so it stops appearing in listings; the underlying record is retained rather than physically removed. Returns 404 if the template does not belong to the authenticated user's company. On success it writes a QR_CODE_TEMPLATE_DELETED audit-log entry.

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.
  • Values for the required query parameter id — see the table below.

Base URL

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

Endpoint

DELETE /api/v1/qr-codes/template/delete

Authentication

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

  • Who can call it: account-level tokens.

  • The endpoint loads the template scoped to your own company.

  • It requires a valid id, read from the query string. A missing or non-existent id returns 422.

Rate limit

  • No rate limit.

Query parameters

  • Query: id (integer, required) — template ID; must be an existing QR template.

Response

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

200 OK · 200

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

Errors

StatusMeaning
401The bearer token is missing, expired or invalid
404Returned if it does not belong to the authenticated user's 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/template/delete?id=123" \
  --header 'Authorization: Bearer <bearer-token>' \
  --header 'Accept: application/json'

Did this page help you?