Link queries

Create a new folder

post/links/folders

Request

  • Base URL: https://api.short.io
  • URL: https://api.short.io/links/folders
  • Auth: API key in header Authorization

Request body

domainIdinteger required

Domain ID the folder belongs to

namestring required

Folder display name

colorstring

Folder display hex color

backgroundColorstring

QR code background hex color

logoUrlstring

URL of the QR code center logo

logoHeightinteger

QR code logo height in pixels

logoWidthinteger

QR code logo width in pixels

ecLevelstring

QR code error correction level

borderRadiusinteger

QR code border radius in pixels

noExcavateboolean

Disable logo excavation (cutout)

finderOuterShapestring

Shape of the outer finder pattern

finderInnerShapestring

Shape of the inner finder pattern

finderColorstring

Hex color for finder patterns

cornerModestring

Corner rendering mode

labelTextstring

QR code label text

labelStylestring

Label placement style

labelColorstring

Label text hex color

labelBgColorstring

Label background hex color

labelFontSizeinteger

Label font size in pixels

labelFontFamilystring

Label font family

integrationFBstring

Facebook Pixel ID

integrationTTstring

TikTok Pixel ID

integrationGAstring

Google Analytics ID

integrationGTMstring

Google Tag Manager ID

integrationAdrollstring

Adroll pixel ID

utmCampaignstring

Default utm_campaign for folder links

utmMediumstring

Default utm_medium for folder links

utmSourcestring

Default utm_source for folder links

utmTermstring

Default utm_term for folder links

utmContentstring

Default utm_content for folder links

redirectTypeinteger

Default HTTP redirect code for folder links

expiresAtDaysinteger

Default link lifetime in days

iconstring

Folder icon identifier

prefixstring

Slug prefix applied to folder links

Example request

{
  "domainId": 12345,
  "name": "Marketing",
  "color": "000000",
  "backgroundColor": "FFFFFF",
  "logoUrl": "https://shortiougc.com/logo.png",
  "logoHeight": 60,
  "logoWidth": 60,
  "ecLevel": "M",
  "borderRadius": 8,
  "finderOuterShape": "square",
  "finderInnerShape": "circle",
  "finderColor": "000000",
  "cornerMode": "rounded",
  "labelText": "Scan me",
  "labelStyle": "bottom",
  "labelColor": "000000",
  "labelBgColor": "FFFFFF",
  "labelFontSize": 14,
  "labelFontFamily": "Inter",
  "integrationFB": "123456789012345",
  "integrationTT": "C123456789",
  "integrationGA": "G-XXXXXXX",
  "integrationGTM": "GTM-XXXXXX",
  "integrationAdroll": "ABCDE12345",
  "utmCampaign": "summer_sale",
  "utmMedium": "email",
  "utmSource": "newsletter",
  "utmTerm": "running_shoes",
  "utmContent": "cta_button",
  "redirectType": 302,
  "expiresAtDays": 30,
  "icon": "folder",
  "prefix": "promo-"
}

Response

Default Response

Changes

No recorded changes to this operation across all 1 revision of this API.