Upsert a link(QR code)

Authorizations

Authorization

string

header

required

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

Path Parameters

type

string

required

Body

application/json

data

link · object

The content/link destination of the short URL or QR code.

link
app-stores
email
audio
google-form
wi-fi
whatsapp
text
sms
map
file
document
image
svg
menu
video

Show child attributes

data.url

string<uri>

required

The destination URL of the short link or QR code.

Required string length: 1 - 2000

Example:

"https://example.com"

linkOptions

object

Show child attributes

linkOptions.domain

string | null

default:iqr.im

Specifies the domain to use for generating short links or QR codes.

Default domains: iqr.im or spqr.co

You may also use your own custom domain (must be properly configured)

Required string length: 3 - 253

linkOptions.key

string | null

The short link slug. If not provided, a random 7-character slug will be generated

Required string length: 1 - 190

linkOptions.tags

string[] | null

The unique IDs of the tags assigned to the short link or QR code.

Required array length: 1 - 30 elements

linkOptions.comment

string | null

The comments for the short link or QR code.

Required string length: 1 - 2000

linkOptions.password

string | null

Password required to access the short link or QR code's destination content

Required string length: 6 - 64

linkOptions.expiration

object

Defines when the link expires. After expiration, users will be redirected to a specified fallback URL.

Show child attributes

linkOptions.expiration.time

string<date-time>

required

The date and time (ISO 8601 timestamp) when the short link or QR code will expire at.

Example:

"2025-12-31T23:59:59Z"

linkOptions.expiration.url

string<uri>

required

The URL to redirect to when the short link or QR code has expired.

Required string length: 3 - 2000

Example:

"https://example.com"

linkOptions.utm

object

Used to track marketing campaign metrics (e.g., source, medium, campaign name) in analytics tools

Show child attributes

linkOptions.utm.source

string

The UTM source of the short link or QR code. If set, this will populate or override the UTM source in the destination URL.

Required string length: 1 - 190

Example:

"google"

linkOptions.utm.medium

string

The UTM medium of the short link or QR code. If set, this will populate or override the UTM medium in the destination URL.

Required string length: 1 - 190

Example:

"cpc"

linkOptions.utm.campaign

string

The UTM campaign of the short link or QR code. If set, this will populate or override the UTM campaign in the destination URL.

Required string length: 1 - 190

Example:

"menu"

linkOptions.utm.term

string

The UTM term of the short link or QR code. If set, this will populate or override the UTM term in the destination URL.

Required string length: 1 - 190

Example:

"pizza"

linkOptions.utm.content

string

The UTM content of the short link or QR code. If set, this will populate or override the UTM content in the destination URL.

Required string length: 1 - 190

Example:

"menu QR code"

linkOptions.utm.ref

string

The referral tag of the short link or QR code. If set, this will populate or override the ref query parameter in the destination URL.

Required string length: 1 - 190

Example:

"yoursite.com"

linkOptions.option

object

Content Protection Options

Show child attributes

linkOptions.option.isWaterMark

boolean

default:false

Determines whether a watermark should be applied to the content.

linkOptions.option.watermarkText

string

Specifies the custom text to be displayed as a watermark on the content.

Required string length: 1 - 64

Example:

"supaqr"

linkOptions.option.isScreenshotProtected

boolean

default:false

When true, prevents screenshots or screen captures

linkOptions.previewData

object

Will be used for Custom Social Media Cards

Show child attributes

linkOptions.previewData.title

string

The custom link preview title (og:title).

Required string length: 1 - 256

Example:

"SupaQR"

linkOptions.previewData.desc

string

The custom link preview description (og:description).

Required string length: 1 - 256

Example:

"Create Your Free Custom Dynamic QR Codes for link, images or PDF files"

linkOptions.previewData.image

string<uri>

The custom link preview image (og:image).

Required string length: 1 - 2000

Example:

"https://example.com/abc.png"

linkOptions.Targeting

object

Defines conditional routing rules for different target URLs based on visitor attributes (device, location, etc.)

Show child attributes

linkOptions.Targeting.targetType

enum<string>

required

The type of targeting

Available options:

device,

location,

number,

time,

language

Example:

"device"

linkOptions.Targeting.targetDatas

When targetType = 'device' · object

required

When targetType = 'device' · object
When targetType = 'location' · object[]
When targetType = 'number' · object[]
When targetType = 'time' · object[]
When targetType = 'language' · object[]

Show child attributes

linkOptions.Targeting.targetDatas.ios

string<uri>

required

The URL to redirect to when the device is iOS

Required string length: 1 - 2000

Example:

"https://example.com"

linkOptions.Targeting.targetDatas.android

string<uri>

required

The URL to redirect to when the device is android

Required string length: 1 - 2000

Example:

"https://example.com"

qrOptions

object

Show child attributes

qrOptions.correctLevel

integer<int32> | null

default:2

Specifies the error correction capability of the QR code. Higher levels allow the QR code to remain scannable even if it's partially damaged.

Required range: 0 <= x <= 3

qrOptions.space

integer<int32> | null

default:2

Defines the blank space (margin) around the QR code, ensuring scanners can detect it properly. Too small margins may cause scanning issues.

Required range: 1 <= x <= 4

qrOptions.version

integer<int32> | null

default:-1

Determines the size and data capacity of the QR code. Higher versions support more data but require more space.

Required range: -1 <= x <= 40

qrOptions.frame

object

Adds a custom surrounding image or decorative border around the QR code (e.g., a branded frame, ornamental design, or scan-guiding graphics).

Show child attributes

qrOptions.frame.type

enum<string>

required

The type of frame

Available options:

preset,

image

qrOptions.frame.value

required

The url of frame's image. Retrieve the image URL from https://supaqr.com/dash-board/images. For cases requiring type='image'

Example:

"https://file.supaqr.com/example.png"

qrOptions.frame.options

When type='image' · object

required

When type='image'
When type='preset'

Show child attributes

qrOptions.frame.options.code_rect

integer<int32>[]

required

Specifies the bounding box of the QR code within the image. Please provide the coordinates and dimensions in the following format: (e.g., "[10,20,100,100]"). "x,y,width,height"

Where:

x = X-coordinate of the top-left corner (in pixels)

y = Y-coordinate of the top-left corner (in pixels)

width = Width of the QR code (in pixels)

height = Height of the QR code (in pixels)

Required array length: 4 elements

Required range: x >= 0

qrOptions.frame.add_texts

object[]

Show child attributes

qrOptions.frame.add_texts.pos

integer<int32>[]

required

The position of the text.e.g.,[x,y]

Required array length: 2 elements

Required range: x >= 1

qrOptions.frame.add_texts.color

string

required

The color of the text in hex format.

Example:

"#FFFFFF"

qrOptions.frame.add_texts.size

integer<int32>

required

The font size of the text.

Required range: 1 <= x <= 200

qrOptions.frame.add_texts.align

enum<string>

required

The align of the text.

Available options:

start,

middle,

end

qrOptions.frame.add_texts.font

enum<string>

required

The font of the text.

Available options:

Roboto,

Roboto-Bold,

Lato,

Montserrat,

Merriweather,

PT Serif,

Patrick Hand,

Oswald,

Nunito,

Open Sans,

Courier Prime,

VT323,

Caveat,

Anton,

Abril Fatface

qrOptions.frame.add_texts.content

string

required

The text string

Required string length: 1 - 200

qrOptions.frame.add_texts.prefix

string

The prefix of the text

Required string length: 1 - 200

qrOptions.patterns

object

Allows customization of the QR code's appearance by modifying its finder patterns (the three corner squares) or alignment patterns (smaller squares inside the code).

Show child attributes

qrOptions.patterns.background

object

Sets the background color or image behind the QR code (not the quiet zone/margin).

Show child attributes

qrOptions.patterns.background.type

enum<string>

default:single

required

The type of the background

Available options:

single,

image,

transparent

qrOptions.patterns.background.value

The color of the background in hex format.

Example:

"#000000"

qrOptions.patterns.body

object

Defines the appearance of the QR code’s central data modules (the black dots).

Show child attributes

qrOptions.patterns.body.style_id

enum<string>

default:Simple

required

Specifies the visual style of the QR code's data modules (the individual dots/patterns that encode information)

Style ID



Simple	Liquid	Grid	H Line	V Line	Dot	Dot Lt



Star	Star Lt	Rhombus	Square	Liquid Lt	Line	Square Lt

Available options:

Simple ,

Liquid ,

Grid ,

H Line ,

V Line ,

Dot ,

Dot Lt ,

Star ,

Star Lt ,

Rhombus ,

Square ,

Liquid Lt ,

Line ,

Square Lt

qrOptions.patterns.body.type

enum<string>

default:single

required

Defines the color and style of the QR code's dots

Available options:

single,

image,

gradient

qrOptions.patterns.body.value

required

Hex color code

Example:

"#000000"

qrOptions.patterns.body.direction

enum<string>

default:Horizontal

When type='gradient' Specifies the angle or orientation of color gradients

Available options:

Horizontal,

Vertical,

Diagonal,

Diagonal inverted,

Radial

qrOptions.patterns.eye

object

Customizes the three corner marker squares.

Show child attributes

qrOptions.patterns.eye.style_id

enum<string>

default:1

required

Defines the visual design of the three corner finder patterns (eyes) in the QR code.

Style ID



1	2	3	4	5	6	7



8	16	18	19	20	22	none

Available options:

1,

2,

3,

4,

5,

6,

7,

8,

16,

18,

19,

20,

22

qrOptions.patterns.eye.value

required

Hex color code

Example:

"#000000"

qrOptions.patterns.eye.type

enum<string>

default:same

Defines the color and style of the QR code's eyes, with options including same (uniform color), diff (different inner and outer colors), image (image-based styling), and gradient (smooth color transitions).

Available options:

same,

diff,

image,

gradient,

none

qrOptions.patterns.eye.direction

enum<string>

default:Horizontal

Gradient direction For cases requiring type='gradient'

Available options:

Horizontal,

Vertical,

Diagonal,

Diagonal inverted,

Radial

qrOptions.logo

object

Embeds a small logo/image in the QR code.

Show child attributes

qrOptions.logo.type

enum<string>

required

Specifies whether the logo is a predefined system-built image or a user-uploaded

Available options:

image,

preset

qrOptions.logo.value

required

The Url of the logo. Retrieve the image URL from https://supaqr.com/dash-board/images. When type='image'

Required string length: 1 - 2000

qrOptions.logo.location

enum<string> | null

default:Center

Sets where the logo is placed within the QR code.

Available options:

Center,

Bottom Right

qrOptions.logo.shape

enum<string> | null

default:Squared

Defines the logo’s display shape

Available options:

Squared,

Circle

qrOptions.logo.size

integer | null

default:2

Controls the logo’s width/height relative to the QR code.

Required range: 1 <= x <= 4

qrOptions.logo.hasBackground

boolean | null

default:true

Adds a solid background behind the logo for better visibility.

qrOptions.logo.shadow

boolean | null

default:false

Applies a shadow effect to the logo for depth.

Response

The response is of type object.

API Documentation

Links

Statistics

Tags

Domains

Files

QR Code

Authorizations

Path Parameters

Body

Style ID

Style ID

Response