API Reference

Edit a QR code

put
https://production-api.shoutaboutus.com/api/v1/qr-codes/

Change a code's name, design, or destination, without reprinting: the scan destination changes, the printed image doesn't. Only the fields you send change. The location's plan must include review solicitation (email or text); otherwise 400. Returns the updated code.

Prerequisites: a bearer token for the account, and the QR code's id (id in GET /api/v1/qr-codes).

Authentication: Account token. The code must have been created under your token's account; otherwise 404.

Rate limit: none.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
integer
required
Defaults to 2963

Required. The QR code's id (id in List QR codes). Digits only.

Body Params
string
Defaults to Front desk

A new name, up to 255 characters. Must be unique for the location.

string
enum
Defaults to landing_page

Where a scan goes: landing_page (a landing page template), review_site (the location's landing page URL on a review site) or custom_url (any URL).

Allowed:
integer
Defaults to 4548

Required when destination_type is landing_page. The landing page template (value in List landing page templates); must be one of your account's templates or a shared one.

integer
Defaults to 44

Required when destination_type is review_site. The review site (value in List supported review sites).

string
Defaults to https://example.com/promo

Required when destination_type is custom_url. The URL a scan opens.

customization
object

How the image looks: color (a hex colour such as #000000, a colour name, or [r, g, b]) and width (pixels, 64 to 2048; 300 when left out).

Responses

Updated 18 days ago

Did this page help you?
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

Updated 18 days ago

Did this page help you?