post
https://production-api.shoutaboutus.com/api/v1/qr-codes
Create a QR code for the authenticated account. Requires the store's active plan to have the review-solicitation feature enabled (review_solicitation_email or review_solicitation_sms, enabled = 1), else 400. Generates and stores the QR image on save. Optionally fan-out the same QR to every sibling store that also has the feature (generate_for_sibling_stores). Writes a QR_CODE_CREATED audit event.
Auth
- Bearer — account (account) role.
store_idmust sit inside your own account tree; the QR records the caller'scompany_id.
Rate limit
- No rate limit.
Body
| Field | Type | Required | Notes |
|---|---|---|---|
name | string | Required | Max 255. Unique per store_id. |
store_id | integer | Required | Must be an existing location + must belong to the auth company. |
destination_type | string | Required | landing_page, review_site or custom_url. |
landing_page_id | integer | Optional | Required when destination_type = landing_page; Must be an existing landing-page template. |
review_site_id | integer | Optional | Required when destination_type = review_site; Must be an existing review site. |
destination_url | string | Optional | Required when destination_type = custom_url. |
customization | object | Optional | QR styling payload. |
generate_for_sibling_stores | boolean | Optional | Also create for sibling stores with the feature enabled. |
Behaviour
- 201 (
createdResponse). Body is double-nested:{ "data": { "data": {.QrCode }, "message": "QR code created successfully" } }. The model appendsunique_code(hashid) andqr_code_image_url. - 400 solicitation feature not enabled · 422 validation.
Recent Requests
Log in to see full request history
| Time | Status | User Agent | |
|---|---|---|---|
Retrieving recent requests… | |||
Loading…