post
https://production-api.shoutaboutus.com/api/v1/qr-codes/template/create
Create a QR code template for the authenticated account. Template names must be unique within the store. Enforces the store's review_qr_code plan allocation before saving — a hard-stop / disabled feature raises FeatureLimitException (HTTP 402) via the global handler. The endpoint records on success the usage. Writes a QR_CODE_TEMPLATE_CREATED audit event.
Auth
- Bearer — account (account) role.
store_idvalidated by an ownership check; the template records the caller'scompany_id.
Rate limit
- No rate limit.
Body
| Field | Type | Required | Notes |
|---|---|---|---|
name | string | Required | Max 255. Unique per store_id (soft-deleted rows excluded). |
store_id | integer | Required | Must be an existing location + must belong to the auth company. |
template_type | string | Required | standard, hangtag or custom. |
design_html | string | Optional | Front design markup. |
design_settings | object | Optional | Front design settings (JSON; string is decoded). |
design_html_back | string | Optional | Back design markup. |
design_settings_back | object | Optional | Back design settings (JSON; string is decoded). |
qr_code_id | integer | Optional | Must be an existing QR code — link the template to an existing QR code. |
Behaviour
- 201 (
createdResponse). Body is double-nested:{ "data": { "data": {.QrCodeTemplate }, "message": "QR code template created successfully" } }. The model appendsunique_code. - 402 QR-template feature hard-stop / disabled (
FeatureLimitException) · 422 validation.
Recent Requests
Log in to see full request history
| Time | Status | User Agent | |
|---|---|---|---|
Retrieving recent requests… | |||
Loading…