Skip to main content
POST
/
domains
Create a domain
curl --request POST \
  --url https://api.supaqr.com/domains \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "domain": "iqr.im",
  "notFoundUrl": "https://example.com",
  "expiredUrl": "https://example.com",
  "assetLinks": "<string>",
  "appleAppSiteAssociation": "<string>"
}'
{
  "slug": "<string>",
  "destination": "<string>",
  "clicks": 123,
  "expiredUrl": "<string>",
  "notFoundUrl": "<string>",
  "assetLinks": "<string>",
  "appleAppSiteAssociation": "<string>",
  "cnameStatus": "<string>",
  "sslStatus": "<string>"
}

Authorizations

Authorization
string
header
required

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

Body

application/json
domain
string
required

Name of the domain.

Required string length: 1 - 190
Example:

"iqr.im"

notFoundUrl
string<uri>

Redirect users to a specific URL when a link(QR code) under this domain doesn't exist.

Required string length: 1 - 2000
Example:

"https://example.com"

expiredUrl
string<uri>

Redirect users to a specific URL when any link(QR code) under this domain has expired.

Required string length: 1 - 2000
Example:

"https://example.com"

assetLinks.json configuration file (for deep link support on Android).

Required string length: 1 - 2000
appleAppSiteAssociation
string

apple-app-site-association configuration file (for deep link support on iOS).

Required string length: 1 - 2000

Response

slug
string
required
destination
string
required
clicks
integer
required
cnameStatus
string
required
sslStatus
string
required
expiredUrl
string
notFoundUrl
string
appleAppSiteAssociation
string
I