Create a QR code

Create a QR code for a location, for in-person review requests. You'll need the store_id, a name and where the code points (destination_type); optionally customization for the image's colour and size. The location's plan must include review solicitation (email or text); otherwise 400. With generate_for_sibling_stores, the same code is also created for your account's other locations whose plan includes it. Returns the code, its image, and its unique id.

Prerequisites: a bearer token for the account, and a location id (store_id) whose plan includes review solicitation.

Authentication: Account token. store_id must be inside your own account tree (otherwise 422). QR codes belong to the account that created them and every QR endpoint matches on that account exactly, so a Partner token sees nothing; a code created with a Partner token is saved under the partner.

Rate limit: none.

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

The code's name, up to 255 characters. Must be unique for the location.

integer
required
Defaults to 3007

The location the code is for. Must be inside your account tree.

string
enum
required
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).

boolean
Defaults to false

Also create the same code for your account's other locations whose plan includes review solicitation.

Responses

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