Update QR code

Partially updates a QR code belonging to the authenticated account-user. All fields are optional (only sent fields are applied via fill(validated)); when any destination-related field changes the QR image is regenerated. Requires the store's active plan to still have a review-solicitation feature enabled.

Auth: Account — authentication; (404 if outside the account company). Also enforces an active StorePlan whose plan has review_solicitation_email or review_solicitation_sms feature enabled = 1, else HTTP 400.

Rate limit: No rate limit.

Request

  • Body:
FieldTypeRequiredNotes
namestringsometimesmax 255; unique on the QR code's name ignoring the current id
destination_typestringsometimesone of landing_page, review_site, custom_url
landing_page_idintegerconditionalrequired_if:destination_type,landing_page; must Must be an existing landing-page template; else nullable
review_site_idintegerconditionalrequired_if:destination_type,review_site; must Must be an existing review site; else nullable
destination_urlstringconditionalrequired_if:destination_type,custom_url; else nullable
customizationarrayoptionalnullable JSON object

Response{ data. } envelope wrapping an array (so status/message sit beside the model inside data).

  • data.status (string) — "success".
  • data.data (object) — updated QrCode with company:id,name, store:id,name, landingPage:id, reviewSite:id loaded and qr_code_image_url appended.
  • data.message (string) — "QR code updated successfully".

Path params

ParameterTypeRequiredNotes
qrCodeIdintegerRequiredDigits only.

Errors: 422 on validation failure.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required
Body Params
string
string
string
Response

Language
Credentials
Bearer
JWT
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json