POST
/
qrcodes
/
{url}

Authorizations

​
Authorization
string
headerrequired

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

​
url
string
required

The URL of the workspace where the QR code will be created

Query Parameters

​
subscriptionId
string
required

The subscription ID of the user

Body

multipart/form-data
​
file
file

Optional logo file to include in the QR code

Boolean indicating if the QR code should include a logo

​
logoSrc
string | null

URL of the logo image to include in the QR code

​
domain
string
default: rqk.sh

The domain associated with the QR code

​
key
string

The unique key for the QR code

​
url
string

The URL that the QR code will point to

​
bg
string

Background color of the QR code in hexadecimal format

​
fg
string

Foreground color of the QR code in hexadecimal format

​
expiresAt
string | null

Expiration date and time for the QR code

​
password
string

Password required to access the QR code link

​
ios
string

iOS-specific information for deep linking

​
android
string

Android-specific information for deep linking

​
utm_source
string

UTM source parameter for tracking

​
utm_medium
string

UTM medium parameter for tracking

​
utm_campaign
string

UTM campaign parameter for tracking

​
utm_term
string

UTM term parameter for tracking

​
utm_content
string

UTM content parameter for tracking

​
ref
string

Referral information

​
description
string

SEO description for the share link card

​
title
string

SEO title for the share link card

​
image
string

URL of the image associated with the share link

Response

200 - application/json
​
qrcode_id
string

The ID of the created QR code

​
link_id
string

The ID of the created link

​
link_url
string

The URL of the created QR code

Delete a linkRetrieve a document