Create a new QR Code

Create a new QR Code for the authenticated workspace.

POST /qrcodes

JavaScript

JavaScript

import Codeqr from '@codeqr/ts';

const client = new Codeqr({
  apiKey: process.env['CODEQR_API_KEY'], // This is the default and can be omitted
});

const qrCode = await client.qrcodes.create({ type: 'url' });

console.log(qrCode.id);

curl --request POST \
  --url https://api.codeqr.io/qrcodes \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "domain": "<string>",
  "key": "<string>",
  "externalId": "123456",
  "trackConversion": false,
  "archived": false,
  "expiresAt": "2023-11-07T05:31:56Z",
  "expiredUrl": "<string>",
  "password": "<string>",
  "proxy": false,
  "title": "<string>",
  "description": "<string>",
  "image": "<string>",
  "rewrite": false,
  "ios": "<string>",
  "android": "<string>",
  "geo": {
    "AF": "<string>",
    "AL": "<string>",
    "DZ": "<string>",
    "AS": "<string>",
    "AD": "<string>",
    "AO": "<string>",
    "AI": "<string>",
    "AQ": "<string>",
    "AG": "<string>",
    "AR": "<string>",
    "AM": "<string>",
    "AW": "<string>",
    "AU": "<string>",
    "AT": "<string>",
    "AZ": "<string>",
    "BS": "<string>",
    "BH": "<string>",
    "BD": "<string>",
    "BB": "<string>",
    "BY": "<string>",
    "BE": "<string>",
    "BZ": "<string>",
    "BJ": "<string>",
    "BM": "<string>",
    "BT": "<string>",
    "BO": "<string>",
    "BA": "<string>",
    "BW": "<string>",
    "BV": "<string>",
    "BR": "<string>",
    "IO": "<string>",
    "BN": "<string>",
    "BG": "<string>",
    "BF": "<string>",
    "BI": "<string>",
    "KH": "<string>",
    "CM": "<string>",
    "CA": "<string>",
    "CV": "<string>",
    "KY": "<string>",
    "CF": "<string>",
    "TD": "<string>",
    "CL": "<string>",
    "CN": "<string>",
    "CX": "<string>",
    "CC": "<string>",
    "CO": "<string>",
    "KM": "<string>",
    "CG": "<string>",
    "CD": "<string>",
    "CK": "<string>",
    "CR": "<string>",
    "CI": "<string>",
    "HR": "<string>",
    "CU": "<string>",
    "CY": "<string>",
    "CZ": "<string>",
    "DK": "<string>",
    "DJ": "<string>",
    "DM": "<string>",
    "DO": "<string>",
    "EC": "<string>",
    "EG": "<string>",
    "SV": "<string>",
    "GQ": "<string>",
    "ER": "<string>",
    "EE": "<string>",
    "ET": "<string>",
    "FK": "<string>",
    "FO": "<string>",
    "FJ": "<string>",
    "FI": "<string>",
    "FR": "<string>",
    "GF": "<string>",
    "PF": "<string>",
    "TF": "<string>",
    "GA": "<string>",
    "GM": "<string>",
    "GE": "<string>",
    "DE": "<string>",
    "GH": "<string>",
    "GI": "<string>",
    "GR": "<string>",
    "GL": "<string>",
    "GD": "<string>",
    "GP": "<string>",
    "GU": "<string>",
    "GT": "<string>",
    "GN": "<string>",
    "GW": "<string>",
    "GY": "<string>",
    "HT": "<string>",
    "HM": "<string>",
    "VA": "<string>",
    "HN": "<string>",
    "HK": "<string>",
    "HU": "<string>",
    "IS": "<string>",
    "IN": "<string>",
    "ID": "<string>",
    "IR": "<string>",
    "IQ": "<string>",
    "IE": "<string>",
    "IL": "<string>",
    "IT": "<string>",
    "JM": "<string>",
    "JP": "<string>",
    "JO": "<string>",
    "KZ": "<string>",
    "KE": "<string>",
    "KI": "<string>",
    "KP": "<string>",
    "KR": "<string>",
    "KW": "<string>",
    "KG": "<string>",
    "LA": "<string>",
    "LV": "<string>",
    "LB": "<string>",
    "LS": "<string>",
    "LR": "<string>",
    "LY": "<string>",
    "LI": "<string>",
    "LT": "<string>",
    "LU": "<string>",
    "MO": "<string>",
    "MG": "<string>",
    "MW": "<string>",
    "MY": "<string>",
    "MV": "<string>",
    "ML": "<string>",
    "MT": "<string>",
    "MH": "<string>",
    "MQ": "<string>",
    "MR": "<string>",
    "MU": "<string>",
    "YT": "<string>",
    "MX": "<string>",
    "FM": "<string>",
    "MD": "<string>",
    "MC": "<string>",
    "MN": "<string>",
    "MS": "<string>",
    "MA": "<string>",
    "MZ": "<string>",
    "MM": "<string>",
    "NA": "<string>",
    "NR": "<string>",
    "NP": "<string>",
    "NL": "<string>",
    "NC": "<string>",
    "NZ": "<string>",
    "NI": "<string>",
    "NE": "<string>",
    "NG": "<string>",
    "NU": "<string>",
    "NF": "<string>",
    "MK": "<string>",
    "MP": "<string>",
    "NO": "<string>",
    "OM": "<string>",
    "PK": "<string>",
    "PW": "<string>",
    "PS": "<string>",
    "PA": "<string>",
    "PG": "<string>",
    "PY": "<string>",
    "PE": "<string>",
    "PH": "<string>",
    "PN": "<string>",
    "PL": "<string>",
    "PT": "<string>",
    "PR": "<string>",
    "QA": "<string>",
    "RE": "<string>",
    "RO": "<string>",
    "RU": "<string>",
    "RW": "<string>",
    "SH": "<string>",
    "KN": "<string>",
    "LC": "<string>",
    "PM": "<string>",
    "VC": "<string>",
    "WS": "<string>",
    "SM": "<string>",
    "ST": "<string>",
    "SA": "<string>",
    "SN": "<string>",
    "SC": "<string>",
    "SL": "<string>",
    "SG": "<string>",
    "SK": "<string>",
    "SI": "<string>",
    "SB": "<string>",
    "SO": "<string>",
    "ZA": "<string>",
    "GS": "<string>",
    "ES": "<string>",
    "LK": "<string>",
    "SD": "<string>",
    "SR": "<string>",
    "SJ": "<string>",
    "SZ": "<string>",
    "SE": "<string>",
    "CH": "<string>",
    "SY": "<string>",
    "TW": "<string>",
    "TJ": "<string>",
    "TZ": "<string>",
    "TH": "<string>",
    "TL": "<string>",
    "TG": "<string>",
    "TK": "<string>",
    "TO": "<string>",
    "TT": "<string>",
    "TN": "<string>",
    "TR": "<string>",
    "TM": "<string>",
    "TC": "<string>",
    "TV": "<string>",
    "UG": "<string>",
    "UA": "<string>",
    "AE": "<string>",
    "GB": "<string>",
    "US": "<string>",
    "UM": "<string>",
    "UY": "<string>",
    "UZ": "<string>",
    "VU": "<string>",
    "VE": "<string>",
    "VN": "<string>",
    "VG": "<string>",
    "VI": "<string>",
    "WF": "<string>",
    "EH": "<string>",
    "YE": "<string>",
    "ZM": "<string>",
    "ZW": "<string>",
    "AX": "<string>",
    "BQ": "<string>",
    "CW": "<string>",
    "GG": "<string>",
    "IM": "<string>",
    "JE": "<string>",
    "ME": "<string>",
    "BL": "<string>",
    "MF": "<string>",
    "RS": "<string>",
    "SX": "<string>",
    "SS": "<string>",
    "XK": "<string>"
  },
  "doIndex": false,
  "webhookIds": [
    "<string>"
  ],
  "publicStats": false,
  "tagId": "<string>",
  "tagIds": [
    "clux0rgak00011..."
  ],
  "tagNames": "<string>",
  "folderId": "<string>",
  "comments": "<string>",
  "flexible": false,
  "filled": false,
  "static": false,
  "useDisplayPage": true,
  "contentStatic": "<string>",
  "text": "<string>",
  "email": {},
  "wifi": {},
  "url": "<string>",
  "phone": "<string>",
  "vcard": {},
  "crypto": {},
  "sms": {},
  "facetime": {},
  "latlog": {},
  "logo": "<string>",
  "bgColor": "#ffffff",
  "fgColor": "#000000",
  "size": 1024,
  "level": "M",
  "showLogo": true,
  "src": "<string>",
  "height": 256,
  "width": 256,
  "excavate": true,
  "pattern": "default",
  "shape": "none",
  "frame": "none",
  "frameColor": "#000000",
  "frameText": "<string>",
  "frameTextColor": "<string>",
  "preRedirection": false,
  "pageId": "<string>",
  "pageUrl": "<string>",
  "isFormMandatory": false
}
'

import requests

url = "https://api.codeqr.io/qrcodes"

payload = {
    "domain": "<string>",
    "key": "<string>",
    "externalId": "123456",
    "trackConversion": False,
    "archived": False,
    "expiresAt": "2023-11-07T05:31:56Z",
    "expiredUrl": "<string>",
    "password": "<string>",
    "proxy": False,
    "title": "<string>",
    "description": "<string>",
    "image": "<string>",
    "rewrite": False,
    "ios": "<string>",
    "android": "<string>",
    "geo": {
        "AF": "<string>",
        "AL": "<string>",
        "DZ": "<string>",
        "AS": "<string>",
        "AD": "<string>",
        "AO": "<string>",
        "AI": "<string>",
        "AQ": "<string>",
        "AG": "<string>",
        "AR": "<string>",
        "AM": "<string>",
        "AW": "<string>",
        "AU": "<string>",
        "AT": "<string>",
        "AZ": "<string>",
        "BS": "<string>",
        "BH": "<string>",
        "BD": "<string>",
        "BB": "<string>",
        "BY": "<string>",
        "BE": "<string>",
        "BZ": "<string>",
        "BJ": "<string>",
        "BM": "<string>",
        "BT": "<string>",
        "BO": "<string>",
        "BA": "<string>",
        "BW": "<string>",
        "BV": "<string>",
        "BR": "<string>",
        "IO": "<string>",
        "BN": "<string>",
        "BG": "<string>",
        "BF": "<string>",
        "BI": "<string>",
        "KH": "<string>",
        "CM": "<string>",
        "CA": "<string>",
        "CV": "<string>",
        "KY": "<string>",
        "CF": "<string>",
        "TD": "<string>",
        "CL": "<string>",
        "CN": "<string>",
        "CX": "<string>",
        "CC": "<string>",
        "CO": "<string>",
        "KM": "<string>",
        "CG": "<string>",
        "CD": "<string>",
        "CK": "<string>",
        "CR": "<string>",
        "CI": "<string>",
        "HR": "<string>",
        "CU": "<string>",
        "CY": "<string>",
        "CZ": "<string>",
        "DK": "<string>",
        "DJ": "<string>",
        "DM": "<string>",
        "DO": "<string>",
        "EC": "<string>",
        "EG": "<string>",
        "SV": "<string>",
        "GQ": "<string>",
        "ER": "<string>",
        "EE": "<string>",
        "ET": "<string>",
        "FK": "<string>",
        "FO": "<string>",
        "FJ": "<string>",
        "FI": "<string>",
        "FR": "<string>",
        "GF": "<string>",
        "PF": "<string>",
        "TF": "<string>",
        "GA": "<string>",
        "GM": "<string>",
        "GE": "<string>",
        "DE": "<string>",
        "GH": "<string>",
        "GI": "<string>",
        "GR": "<string>",
        "GL": "<string>",
        "GD": "<string>",
        "GP": "<string>",
        "GU": "<string>",
        "GT": "<string>",
        "GN": "<string>",
        "GW": "<string>",
        "GY": "<string>",
        "HT": "<string>",
        "HM": "<string>",
        "VA": "<string>",
        "HN": "<string>",
        "HK": "<string>",
        "HU": "<string>",
        "IS": "<string>",
        "IN": "<string>",
        "ID": "<string>",
        "IR": "<string>",
        "IQ": "<string>",
        "IE": "<string>",
        "IL": "<string>",
        "IT": "<string>",
        "JM": "<string>",
        "JP": "<string>",
        "JO": "<string>",
        "KZ": "<string>",
        "KE": "<string>",
        "KI": "<string>",
        "KP": "<string>",
        "KR": "<string>",
        "KW": "<string>",
        "KG": "<string>",
        "LA": "<string>",
        "LV": "<string>",
        "LB": "<string>",
        "LS": "<string>",
        "LR": "<string>",
        "LY": "<string>",
        "LI": "<string>",
        "LT": "<string>",
        "LU": "<string>",
        "MO": "<string>",
        "MG": "<string>",
        "MW": "<string>",
        "MY": "<string>",
        "MV": "<string>",
        "ML": "<string>",
        "MT": "<string>",
        "MH": "<string>",
        "MQ": "<string>",
        "MR": "<string>",
        "MU": "<string>",
        "YT": "<string>",
        "MX": "<string>",
        "FM": "<string>",
        "MD": "<string>",
        "MC": "<string>",
        "MN": "<string>",
        "MS": "<string>",
        "MA": "<string>",
        "MZ": "<string>",
        "MM": "<string>",
        "NA": "<string>",
        "NR": "<string>",
        "NP": "<string>",
        "NL": "<string>",
        "NC": "<string>",
        "NZ": "<string>",
        "NI": "<string>",
        "NE": "<string>",
        "NG": "<string>",
        "NU": "<string>",
        "NF": "<string>",
        "MK": "<string>",
        "MP": "<string>",
        "NO": "<string>",
        "OM": "<string>",
        "PK": "<string>",
        "PW": "<string>",
        "PS": "<string>",
        "PA": "<string>",
        "PG": "<string>",
        "PY": "<string>",
        "PE": "<string>",
        "PH": "<string>",
        "PN": "<string>",
        "PL": "<string>",
        "PT": "<string>",
        "PR": "<string>",
        "QA": "<string>",
        "RE": "<string>",
        "RO": "<string>",
        "RU": "<string>",
        "RW": "<string>",
        "SH": "<string>",
        "KN": "<string>",
        "LC": "<string>",
        "PM": "<string>",
        "VC": "<string>",
        "WS": "<string>",
        "SM": "<string>",
        "ST": "<string>",
        "SA": "<string>",
        "SN": "<string>",
        "SC": "<string>",
        "SL": "<string>",
        "SG": "<string>",
        "SK": "<string>",
        "SI": "<string>",
        "SB": "<string>",
        "SO": "<string>",
        "ZA": "<string>",
        "GS": "<string>",
        "ES": "<string>",
        "LK": "<string>",
        "SD": "<string>",
        "SR": "<string>",
        "SJ": "<string>",
        "SZ": "<string>",
        "SE": "<string>",
        "CH": "<string>",
        "SY": "<string>",
        "TW": "<string>",
        "TJ": "<string>",
        "TZ": "<string>",
        "TH": "<string>",
        "TL": "<string>",
        "TG": "<string>",
        "TK": "<string>",
        "TO": "<string>",
        "TT": "<string>",
        "TN": "<string>",
        "TR": "<string>",
        "TM": "<string>",
        "TC": "<string>",
        "TV": "<string>",
        "UG": "<string>",
        "UA": "<string>",
        "AE": "<string>",
        "GB": "<string>",
        "US": "<string>",
        "UM": "<string>",
        "UY": "<string>",
        "UZ": "<string>",
        "VU": "<string>",
        "VE": "<string>",
        "VN": "<string>",
        "VG": "<string>",
        "VI": "<string>",
        "WF": "<string>",
        "EH": "<string>",
        "YE": "<string>",
        "ZM": "<string>",
        "ZW": "<string>",
        "AX": "<string>",
        "BQ": "<string>",
        "CW": "<string>",
        "GG": "<string>",
        "IM": "<string>",
        "JE": "<string>",
        "ME": "<string>",
        "BL": "<string>",
        "MF": "<string>",
        "RS": "<string>",
        "SX": "<string>",
        "SS": "<string>",
        "XK": "<string>"
    },
    "doIndex": False,
    "webhookIds": ["<string>"],
    "publicStats": False,
    "tagId": "<string>",
    "tagIds": ["clux0rgak00011..."],
    "tagNames": "<string>",
    "folderId": "<string>",
    "comments": "<string>",
    "flexible": False,
    "filled": False,
    "static": False,
    "useDisplayPage": True,
    "contentStatic": "<string>",
    "text": "<string>",
    "email": {},
    "wifi": {},
    "url": "<string>",
    "phone": "<string>",
    "vcard": {},
    "crypto": {},
    "sms": {},
    "facetime": {},
    "latlog": {},
    "logo": "<string>",
    "bgColor": "#ffffff",
    "fgColor": "#000000",
    "size": 1024,
    "level": "M",
    "showLogo": True,
    "src": "<string>",
    "height": 256,
    "width": 256,
    "excavate": True,
    "pattern": "default",
    "shape": "none",
    "frame": "none",
    "frameColor": "#000000",
    "frameText": "<string>",
    "frameTextColor": "<string>",
    "preRedirection": False,
    "pageId": "<string>",
    "pageUrl": "<string>",
    "isFormMandatory": False
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.codeqr.io/qrcodes",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'domain' => '<string>',
    'key' => '<string>',
    'externalId' => '123456',
    'trackConversion' => false,
    'archived' => false,
    'expiresAt' => '2023-11-07T05:31:56Z',
    'expiredUrl' => '<string>',
    'password' => '<string>',
    'proxy' => false,
    'title' => '<string>',
    'description' => '<string>',
    'image' => '<string>',
    'rewrite' => false,
    'ios' => '<string>',
    'android' => '<string>',
    'geo' => [
        'AF' => '<string>',
        'AL' => '<string>',
        'DZ' => '<string>',
        'AS' => '<string>',
        'AD' => '<string>',
        'AO' => '<string>',
        'AI' => '<string>',
        'AQ' => '<string>',
        'AG' => '<string>',
        'AR' => '<string>',
        'AM' => '<string>',
        'AW' => '<string>',
        'AU' => '<string>',
        'AT' => '<string>',
        'AZ' => '<string>',
        'BS' => '<string>',
        'BH' => '<string>',
        'BD' => '<string>',
        'BB' => '<string>',
        'BY' => '<string>',
        'BE' => '<string>',
        'BZ' => '<string>',
        'BJ' => '<string>',
        'BM' => '<string>',
        'BT' => '<string>',
        'BO' => '<string>',
        'BA' => '<string>',
        'BW' => '<string>',
        'BV' => '<string>',
        'BR' => '<string>',
        'IO' => '<string>',
        'BN' => '<string>',
        'BG' => '<string>',
        'BF' => '<string>',
        'BI' => '<string>',
        'KH' => '<string>',
        'CM' => '<string>',
        'CA' => '<string>',
        'CV' => '<string>',
        'KY' => '<string>',
        'CF' => '<string>',
        'TD' => '<string>',
        'CL' => '<string>',
        'CN' => '<string>',
        'CX' => '<string>',
        'CC' => '<string>',
        'CO' => '<string>',
        'KM' => '<string>',
        'CG' => '<string>',
        'CD' => '<string>',
        'CK' => '<string>',
        'CR' => '<string>',
        'CI' => '<string>',
        'HR' => '<string>',
        'CU' => '<string>',
        'CY' => '<string>',
        'CZ' => '<string>',
        'DK' => '<string>',
        'DJ' => '<string>',
        'DM' => '<string>',
        'DO' => '<string>',
        'EC' => '<string>',
        'EG' => '<string>',
        'SV' => '<string>',
        'GQ' => '<string>',
        'ER' => '<string>',
        'EE' => '<string>',
        'ET' => '<string>',
        'FK' => '<string>',
        'FO' => '<string>',
        'FJ' => '<string>',
        'FI' => '<string>',
        'FR' => '<string>',
        'GF' => '<string>',
        'PF' => '<string>',
        'TF' => '<string>',
        'GA' => '<string>',
        'GM' => '<string>',
        'GE' => '<string>',
        'DE' => '<string>',
        'GH' => '<string>',
        'GI' => '<string>',
        'GR' => '<string>',
        'GL' => '<string>',
        'GD' => '<string>',
        'GP' => '<string>',
        'GU' => '<string>',
        'GT' => '<string>',
        'GN' => '<string>',
        'GW' => '<string>',
        'GY' => '<string>',
        'HT' => '<string>',
        'HM' => '<string>',
        'VA' => '<string>',
        'HN' => '<string>',
        'HK' => '<string>',
        'HU' => '<string>',
        'IS' => '<string>',
        'IN' => '<string>',
        'ID' => '<string>',
        'IR' => '<string>',
        'IQ' => '<string>',
        'IE' => '<string>',
        'IL' => '<string>',
        'IT' => '<string>',
        'JM' => '<string>',
        'JP' => '<string>',
        'JO' => '<string>',
        'KZ' => '<string>',
        'KE' => '<string>',
        'KI' => '<string>',
        'KP' => '<string>',
        'KR' => '<string>',
        'KW' => '<string>',
        'KG' => '<string>',
        'LA' => '<string>',
        'LV' => '<string>',
        'LB' => '<string>',
        'LS' => '<string>',
        'LR' => '<string>',
        'LY' => '<string>',
        'LI' => '<string>',
        'LT' => '<string>',
        'LU' => '<string>',
        'MO' => '<string>',
        'MG' => '<string>',
        'MW' => '<string>',
        'MY' => '<string>',
        'MV' => '<string>',
        'ML' => '<string>',
        'MT' => '<string>',
        'MH' => '<string>',
        'MQ' => '<string>',
        'MR' => '<string>',
        'MU' => '<string>',
        'YT' => '<string>',
        'MX' => '<string>',
        'FM' => '<string>',
        'MD' => '<string>',
        'MC' => '<string>',
        'MN' => '<string>',
        'MS' => '<string>',
        'MA' => '<string>',
        'MZ' => '<string>',
        'MM' => '<string>',
        'NA' => '<string>',
        'NR' => '<string>',
        'NP' => '<string>',
        'NL' => '<string>',
        'NC' => '<string>',
        'NZ' => '<string>',
        'NI' => '<string>',
        'NE' => '<string>',
        'NG' => '<string>',
        'NU' => '<string>',
        'NF' => '<string>',
        'MK' => '<string>',
        'MP' => '<string>',
        'NO' => '<string>',
        'OM' => '<string>',
        'PK' => '<string>',
        'PW' => '<string>',
        'PS' => '<string>',
        'PA' => '<string>',
        'PG' => '<string>',
        'PY' => '<string>',
        'PE' => '<string>',
        'PH' => '<string>',
        'PN' => '<string>',
        'PL' => '<string>',
        'PT' => '<string>',
        'PR' => '<string>',
        'QA' => '<string>',
        'RE' => '<string>',
        'RO' => '<string>',
        'RU' => '<string>',
        'RW' => '<string>',
        'SH' => '<string>',
        'KN' => '<string>',
        'LC' => '<string>',
        'PM' => '<string>',
        'VC' => '<string>',
        'WS' => '<string>',
        'SM' => '<string>',
        'ST' => '<string>',
        'SA' => '<string>',
        'SN' => '<string>',
        'SC' => '<string>',
        'SL' => '<string>',
        'SG' => '<string>',
        'SK' => '<string>',
        'SI' => '<string>',
        'SB' => '<string>',
        'SO' => '<string>',
        'ZA' => '<string>',
        'GS' => '<string>',
        'ES' => '<string>',
        'LK' => '<string>',
        'SD' => '<string>',
        'SR' => '<string>',
        'SJ' => '<string>',
        'SZ' => '<string>',
        'SE' => '<string>',
        'CH' => '<string>',
        'SY' => '<string>',
        'TW' => '<string>',
        'TJ' => '<string>',
        'TZ' => '<string>',
        'TH' => '<string>',
        'TL' => '<string>',
        'TG' => '<string>',
        'TK' => '<string>',
        'TO' => '<string>',
        'TT' => '<string>',
        'TN' => '<string>',
        'TR' => '<string>',
        'TM' => '<string>',
        'TC' => '<string>',
        'TV' => '<string>',
        'UG' => '<string>',
        'UA' => '<string>',
        'AE' => '<string>',
        'GB' => '<string>',
        'US' => '<string>',
        'UM' => '<string>',
        'UY' => '<string>',
        'UZ' => '<string>',
        'VU' => '<string>',
        'VE' => '<string>',
        'VN' => '<string>',
        'VG' => '<string>',
        'VI' => '<string>',
        'WF' => '<string>',
        'EH' => '<string>',
        'YE' => '<string>',
        'ZM' => '<string>',
        'ZW' => '<string>',
        'AX' => '<string>',
        'BQ' => '<string>',
        'CW' => '<string>',
        'GG' => '<string>',
        'IM' => '<string>',
        'JE' => '<string>',
        'ME' => '<string>',
        'BL' => '<string>',
        'MF' => '<string>',
        'RS' => '<string>',
        'SX' => '<string>',
        'SS' => '<string>',
        'XK' => '<string>'
    ],
    'doIndex' => false,
    'webhookIds' => [
        '<string>'
    ],
    'publicStats' => false,
    'tagId' => '<string>',
    'tagIds' => [
        'clux0rgak00011...'
    ],
    'tagNames' => '<string>',
    'folderId' => '<string>',
    'comments' => '<string>',
    'flexible' => false,
    'filled' => false,
    'static' => false,
    'useDisplayPage' => true,
    'contentStatic' => '<string>',
    'text' => '<string>',
    'email' => [
        
    ],
    'wifi' => [
        
    ],
    'url' => '<string>',
    'phone' => '<string>',
    'vcard' => [
        
    ],
    'crypto' => [
        
    ],
    'sms' => [
        
    ],
    'facetime' => [
        
    ],
    'latlog' => [
        
    ],
    'logo' => '<string>',
    'bgColor' => '#ffffff',
    'fgColor' => '#000000',
    'size' => 1024,
    'level' => 'M',
    'showLogo' => true,
    'src' => '<string>',
    'height' => 256,
    'width' => 256,
    'excavate' => true,
    'pattern' => 'default',
    'shape' => 'none',
    'frame' => 'none',
    'frameColor' => '#000000',
    'frameText' => '<string>',
    'frameTextColor' => '<string>',
    'preRedirection' => false,
    'pageId' => '<string>',
    'pageUrl' => '<string>',
    'isFormMandatory' => false
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.codeqr.io/qrcodes"

	payload := strings.NewReader("{\n  \"domain\": \"<string>\",\n  \"key\": \"<string>\",\n  \"externalId\": \"123456\",\n  \"trackConversion\": false,\n  \"archived\": false,\n  \"expiresAt\": \"2023-11-07T05:31:56Z\",\n  \"expiredUrl\": \"<string>\",\n  \"password\": \"<string>\",\n  \"proxy\": false,\n  \"title\": \"<string>\",\n  \"description\": \"<string>\",\n  \"image\": \"<string>\",\n  \"rewrite\": false,\n  \"ios\": \"<string>\",\n  \"android\": \"<string>\",\n  \"geo\": {\n    \"AF\": \"<string>\",\n    \"AL\": \"<string>\",\n    \"DZ\": \"<string>\",\n    \"AS\": \"<string>\",\n    \"AD\": \"<string>\",\n    \"AO\": \"<string>\",\n    \"AI\": \"<string>\",\n    \"AQ\": \"<string>\",\n    \"AG\": \"<string>\",\n    \"AR\": \"<string>\",\n    \"AM\": \"<string>\",\n    \"AW\": \"<string>\",\n    \"AU\": \"<string>\",\n    \"AT\": \"<string>\",\n    \"AZ\": \"<string>\",\n    \"BS\": \"<string>\",\n    \"BH\": \"<string>\",\n    \"BD\": \"<string>\",\n    \"BB\": \"<string>\",\n    \"BY\": \"<string>\",\n    \"BE\": \"<string>\",\n    \"BZ\": \"<string>\",\n    \"BJ\": \"<string>\",\n    \"BM\": \"<string>\",\n    \"BT\": \"<string>\",\n    \"BO\": \"<string>\",\n    \"BA\": \"<string>\",\n    \"BW\": \"<string>\",\n    \"BV\": \"<string>\",\n    \"BR\": \"<string>\",\n    \"IO\": \"<string>\",\n    \"BN\": \"<string>\",\n    \"BG\": \"<string>\",\n    \"BF\": \"<string>\",\n    \"BI\": \"<string>\",\n    \"KH\": \"<string>\",\n    \"CM\": \"<string>\",\n    \"CA\": \"<string>\",\n    \"CV\": \"<string>\",\n    \"KY\": \"<string>\",\n    \"CF\": \"<string>\",\n    \"TD\": \"<string>\",\n    \"CL\": \"<string>\",\n    \"CN\": \"<string>\",\n    \"CX\": \"<string>\",\n    \"CC\": \"<string>\",\n    \"CO\": \"<string>\",\n    \"KM\": \"<string>\",\n    \"CG\": \"<string>\",\n    \"CD\": \"<string>\",\n    \"CK\": \"<string>\",\n    \"CR\": \"<string>\",\n    \"CI\": \"<string>\",\n    \"HR\": \"<string>\",\n    \"CU\": \"<string>\",\n    \"CY\": \"<string>\",\n    \"CZ\": \"<string>\",\n    \"DK\": \"<string>\",\n    \"DJ\": \"<string>\",\n    \"DM\": \"<string>\",\n    \"DO\": \"<string>\",\n    \"EC\": \"<string>\",\n    \"EG\": \"<string>\",\n    \"SV\": \"<string>\",\n    \"GQ\": \"<string>\",\n    \"ER\": \"<string>\",\n    \"EE\": \"<string>\",\n    \"ET\": \"<string>\",\n    \"FK\": \"<string>\",\n    \"FO\": \"<string>\",\n    \"FJ\": \"<string>\",\n    \"FI\": \"<string>\",\n    \"FR\": \"<string>\",\n    \"GF\": \"<string>\",\n    \"PF\": \"<string>\",\n    \"TF\": \"<string>\",\n    \"GA\": \"<string>\",\n    \"GM\": \"<string>\",\n    \"GE\": \"<string>\",\n    \"DE\": \"<string>\",\n    \"GH\": \"<string>\",\n    \"GI\": \"<string>\",\n    \"GR\": \"<string>\",\n    \"GL\": \"<string>\",\n    \"GD\": \"<string>\",\n    \"GP\": \"<string>\",\n    \"GU\": \"<string>\",\n    \"GT\": \"<string>\",\n    \"GN\": \"<string>\",\n    \"GW\": \"<string>\",\n    \"GY\": \"<string>\",\n    \"HT\": \"<string>\",\n    \"HM\": \"<string>\",\n    \"VA\": \"<string>\",\n    \"HN\": \"<string>\",\n    \"HK\": \"<string>\",\n    \"HU\": \"<string>\",\n    \"IS\": \"<string>\",\n    \"IN\": \"<string>\",\n    \"ID\": \"<string>\",\n    \"IR\": \"<string>\",\n    \"IQ\": \"<string>\",\n    \"IE\": \"<string>\",\n    \"IL\": \"<string>\",\n    \"IT\": \"<string>\",\n    \"JM\": \"<string>\",\n    \"JP\": \"<string>\",\n    \"JO\": \"<string>\",\n    \"KZ\": \"<string>\",\n    \"KE\": \"<string>\",\n    \"KI\": \"<string>\",\n    \"KP\": \"<string>\",\n    \"KR\": \"<string>\",\n    \"KW\": \"<string>\",\n    \"KG\": \"<string>\",\n    \"LA\": \"<string>\",\n    \"LV\": \"<string>\",\n    \"LB\": \"<string>\",\n    \"LS\": \"<string>\",\n    \"LR\": \"<string>\",\n    \"LY\": \"<string>\",\n    \"LI\": \"<string>\",\n    \"LT\": \"<string>\",\n    \"LU\": \"<string>\",\n    \"MO\": \"<string>\",\n    \"MG\": \"<string>\",\n    \"MW\": \"<string>\",\n    \"MY\": \"<string>\",\n    \"MV\": \"<string>\",\n    \"ML\": \"<string>\",\n    \"MT\": \"<string>\",\n    \"MH\": \"<string>\",\n    \"MQ\": \"<string>\",\n    \"MR\": \"<string>\",\n    \"MU\": \"<string>\",\n    \"YT\": \"<string>\",\n    \"MX\": \"<string>\",\n    \"FM\": \"<string>\",\n    \"MD\": \"<string>\",\n    \"MC\": \"<string>\",\n    \"MN\": \"<string>\",\n    \"MS\": \"<string>\",\n    \"MA\": \"<string>\",\n    \"MZ\": \"<string>\",\n    \"MM\": \"<string>\",\n    \"NA\": \"<string>\",\n    \"NR\": \"<string>\",\n    \"NP\": \"<string>\",\n    \"NL\": \"<string>\",\n    \"NC\": \"<string>\",\n    \"NZ\": \"<string>\",\n    \"NI\": \"<string>\",\n    \"NE\": \"<string>\",\n    \"NG\": \"<string>\",\n    \"NU\": \"<string>\",\n    \"NF\": \"<string>\",\n    \"MK\": \"<string>\",\n    \"MP\": \"<string>\",\n    \"NO\": \"<string>\",\n    \"OM\": \"<string>\",\n    \"PK\": \"<string>\",\n    \"PW\": \"<string>\",\n    \"PS\": \"<string>\",\n    \"PA\": \"<string>\",\n    \"PG\": \"<string>\",\n    \"PY\": \"<string>\",\n    \"PE\": \"<string>\",\n    \"PH\": \"<string>\",\n    \"PN\": \"<string>\",\n    \"PL\": \"<string>\",\n    \"PT\": \"<string>\",\n    \"PR\": \"<string>\",\n    \"QA\": \"<string>\",\n    \"RE\": \"<string>\",\n    \"RO\": \"<string>\",\n    \"RU\": \"<string>\",\n    \"RW\": \"<string>\",\n    \"SH\": \"<string>\",\n    \"KN\": \"<string>\",\n    \"LC\": \"<string>\",\n    \"PM\": \"<string>\",\n    \"VC\": \"<string>\",\n    \"WS\": \"<string>\",\n    \"SM\": \"<string>\",\n    \"ST\": \"<string>\",\n    \"SA\": \"<string>\",\n    \"SN\": \"<string>\",\n    \"SC\": \"<string>\",\n    \"SL\": \"<string>\",\n    \"SG\": \"<string>\",\n    \"SK\": \"<string>\",\n    \"SI\": \"<string>\",\n    \"SB\": \"<string>\",\n    \"SO\": \"<string>\",\n    \"ZA\": \"<string>\",\n    \"GS\": \"<string>\",\n    \"ES\": \"<string>\",\n    \"LK\": \"<string>\",\n    \"SD\": \"<string>\",\n    \"SR\": \"<string>\",\n    \"SJ\": \"<string>\",\n    \"SZ\": \"<string>\",\n    \"SE\": \"<string>\",\n    \"CH\": \"<string>\",\n    \"SY\": \"<string>\",\n    \"TW\": \"<string>\",\n    \"TJ\": \"<string>\",\n    \"TZ\": \"<string>\",\n    \"TH\": \"<string>\",\n    \"TL\": \"<string>\",\n    \"TG\": \"<string>\",\n    \"TK\": \"<string>\",\n    \"TO\": \"<string>\",\n    \"TT\": \"<string>\",\n    \"TN\": \"<string>\",\n    \"TR\": \"<string>\",\n    \"TM\": \"<string>\",\n    \"TC\": \"<string>\",\n    \"TV\": \"<string>\",\n    \"UG\": \"<string>\",\n    \"UA\": \"<string>\",\n    \"AE\": \"<string>\",\n    \"GB\": \"<string>\",\n    \"US\": \"<string>\",\n    \"UM\": \"<string>\",\n    \"UY\": \"<string>\",\n    \"UZ\": \"<string>\",\n    \"VU\": \"<string>\",\n    \"VE\": \"<string>\",\n    \"VN\": \"<string>\",\n    \"VG\": \"<string>\",\n    \"VI\": \"<string>\",\n    \"WF\": \"<string>\",\n    \"EH\": \"<string>\",\n    \"YE\": \"<string>\",\n    \"ZM\": \"<string>\",\n    \"ZW\": \"<string>\",\n    \"AX\": \"<string>\",\n    \"BQ\": \"<string>\",\n    \"CW\": \"<string>\",\n    \"GG\": \"<string>\",\n    \"IM\": \"<string>\",\n    \"JE\": \"<string>\",\n    \"ME\": \"<string>\",\n    \"BL\": \"<string>\",\n    \"MF\": \"<string>\",\n    \"RS\": \"<string>\",\n    \"SX\": \"<string>\",\n    \"SS\": \"<string>\",\n    \"XK\": \"<string>\"\n  },\n  \"doIndex\": false,\n  \"webhookIds\": [\n    \"<string>\"\n  ],\n  \"publicStats\": false,\n  \"tagId\": \"<string>\",\n  \"tagIds\": [\n    \"clux0rgak00011...\"\n  ],\n  \"tagNames\": \"<string>\",\n  \"folderId\": \"<string>\",\n  \"comments\": \"<string>\",\n  \"flexible\": false,\n  \"filled\": false,\n  \"static\": false,\n  \"useDisplayPage\": true,\n  \"contentStatic\": \"<string>\",\n  \"text\": \"<string>\",\n  \"email\": {},\n  \"wifi\": {},\n  \"url\": \"<string>\",\n  \"phone\": \"<string>\",\n  \"vcard\": {},\n  \"crypto\": {},\n  \"sms\": {},\n  \"facetime\": {},\n  \"latlog\": {},\n  \"logo\": \"<string>\",\n  \"bgColor\": \"#ffffff\",\n  \"fgColor\": \"#000000\",\n  \"size\": 1024,\n  \"level\": \"M\",\n  \"showLogo\": true,\n  \"src\": \"<string>\",\n  \"height\": 256,\n  \"width\": 256,\n  \"excavate\": true,\n  \"pattern\": \"default\",\n  \"shape\": \"none\",\n  \"frame\": \"none\",\n  \"frameColor\": \"#000000\",\n  \"frameText\": \"<string>\",\n  \"frameTextColor\": \"<string>\",\n  \"preRedirection\": false,\n  \"pageId\": \"<string>\",\n  \"pageUrl\": \"<string>\",\n  \"isFormMandatory\": false\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.codeqr.io/qrcodes")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"domain\": \"<string>\",\n  \"key\": \"<string>\",\n  \"externalId\": \"123456\",\n  \"trackConversion\": false,\n  \"archived\": false,\n  \"expiresAt\": \"2023-11-07T05:31:56Z\",\n  \"expiredUrl\": \"<string>\",\n  \"password\": \"<string>\",\n  \"proxy\": false,\n  \"title\": \"<string>\",\n  \"description\": \"<string>\",\n  \"image\": \"<string>\",\n  \"rewrite\": false,\n  \"ios\": \"<string>\",\n  \"android\": \"<string>\",\n  \"geo\": {\n    \"AF\": \"<string>\",\n    \"AL\": \"<string>\",\n    \"DZ\": \"<string>\",\n    \"AS\": \"<string>\",\n    \"AD\": \"<string>\",\n    \"AO\": \"<string>\",\n    \"AI\": \"<string>\",\n    \"AQ\": \"<string>\",\n    \"AG\": \"<string>\",\n    \"AR\": \"<string>\",\n    \"AM\": \"<string>\",\n    \"AW\": \"<string>\",\n    \"AU\": \"<string>\",\n    \"AT\": \"<string>\",\n    \"AZ\": \"<string>\",\n    \"BS\": \"<string>\",\n    \"BH\": \"<string>\",\n    \"BD\": \"<string>\",\n    \"BB\": \"<string>\",\n    \"BY\": \"<string>\",\n    \"BE\": \"<string>\",\n    \"BZ\": \"<string>\",\n    \"BJ\": \"<string>\",\n    \"BM\": \"<string>\",\n    \"BT\": \"<string>\",\n    \"BO\": \"<string>\",\n    \"BA\": \"<string>\",\n    \"BW\": \"<string>\",\n    \"BV\": \"<string>\",\n    \"BR\": \"<string>\",\n    \"IO\": \"<string>\",\n    \"BN\": \"<string>\",\n    \"BG\": \"<string>\",\n    \"BF\": \"<string>\",\n    \"BI\": \"<string>\",\n    \"KH\": \"<string>\",\n    \"CM\": \"<string>\",\n    \"CA\": \"<string>\",\n    \"CV\": \"<string>\",\n    \"KY\": \"<string>\",\n    \"CF\": \"<string>\",\n    \"TD\": \"<string>\",\n    \"CL\": \"<string>\",\n    \"CN\": \"<string>\",\n    \"CX\": \"<string>\",\n    \"CC\": \"<string>\",\n    \"CO\": \"<string>\",\n    \"KM\": \"<string>\",\n    \"CG\": \"<string>\",\n    \"CD\": \"<string>\",\n    \"CK\": \"<string>\",\n    \"CR\": \"<string>\",\n    \"CI\": \"<string>\",\n    \"HR\": \"<string>\",\n    \"CU\": \"<string>\",\n    \"CY\": \"<string>\",\n    \"CZ\": \"<string>\",\n    \"DK\": \"<string>\",\n    \"DJ\": \"<string>\",\n    \"DM\": \"<string>\",\n    \"DO\": \"<string>\",\n    \"EC\": \"<string>\",\n    \"EG\": \"<string>\",\n    \"SV\": \"<string>\",\n    \"GQ\": \"<string>\",\n    \"ER\": \"<string>\",\n    \"EE\": \"<string>\",\n    \"ET\": \"<string>\",\n    \"FK\": \"<string>\",\n    \"FO\": \"<string>\",\n    \"FJ\": \"<string>\",\n    \"FI\": \"<string>\",\n    \"FR\": \"<string>\",\n    \"GF\": \"<string>\",\n    \"PF\": \"<string>\",\n    \"TF\": \"<string>\",\n    \"GA\": \"<string>\",\n    \"GM\": \"<string>\",\n    \"GE\": \"<string>\",\n    \"DE\": \"<string>\",\n    \"GH\": \"<string>\",\n    \"GI\": \"<string>\",\n    \"GR\": \"<string>\",\n    \"GL\": \"<string>\",\n    \"GD\": \"<string>\",\n    \"GP\": \"<string>\",\n    \"GU\": \"<string>\",\n    \"GT\": \"<string>\",\n    \"GN\": \"<string>\",\n    \"GW\": \"<string>\",\n    \"GY\": \"<string>\",\n    \"HT\": \"<string>\",\n    \"HM\": \"<string>\",\n    \"VA\": \"<string>\",\n    \"HN\": \"<string>\",\n    \"HK\": \"<string>\",\n    \"HU\": \"<string>\",\n    \"IS\": \"<string>\",\n    \"IN\": \"<string>\",\n    \"ID\": \"<string>\",\n    \"IR\": \"<string>\",\n    \"IQ\": \"<string>\",\n    \"IE\": \"<string>\",\n    \"IL\": \"<string>\",\n    \"IT\": \"<string>\",\n    \"JM\": \"<string>\",\n    \"JP\": \"<string>\",\n    \"JO\": \"<string>\",\n    \"KZ\": \"<string>\",\n    \"KE\": \"<string>\",\n    \"KI\": \"<string>\",\n    \"KP\": \"<string>\",\n    \"KR\": \"<string>\",\n    \"KW\": \"<string>\",\n    \"KG\": \"<string>\",\n    \"LA\": \"<string>\",\n    \"LV\": \"<string>\",\n    \"LB\": \"<string>\",\n    \"LS\": \"<string>\",\n    \"LR\": \"<string>\",\n    \"LY\": \"<string>\",\n    \"LI\": \"<string>\",\n    \"LT\": \"<string>\",\n    \"LU\": \"<string>\",\n    \"MO\": \"<string>\",\n    \"MG\": \"<string>\",\n    \"MW\": \"<string>\",\n    \"MY\": \"<string>\",\n    \"MV\": \"<string>\",\n    \"ML\": \"<string>\",\n    \"MT\": \"<string>\",\n    \"MH\": \"<string>\",\n    \"MQ\": \"<string>\",\n    \"MR\": \"<string>\",\n    \"MU\": \"<string>\",\n    \"YT\": \"<string>\",\n    \"MX\": \"<string>\",\n    \"FM\": \"<string>\",\n    \"MD\": \"<string>\",\n    \"MC\": \"<string>\",\n    \"MN\": \"<string>\",\n    \"MS\": \"<string>\",\n    \"MA\": \"<string>\",\n    \"MZ\": \"<string>\",\n    \"MM\": \"<string>\",\n    \"NA\": \"<string>\",\n    \"NR\": \"<string>\",\n    \"NP\": \"<string>\",\n    \"NL\": \"<string>\",\n    \"NC\": \"<string>\",\n    \"NZ\": \"<string>\",\n    \"NI\": \"<string>\",\n    \"NE\": \"<string>\",\n    \"NG\": \"<string>\",\n    \"NU\": \"<string>\",\n    \"NF\": \"<string>\",\n    \"MK\": \"<string>\",\n    \"MP\": \"<string>\",\n    \"NO\": \"<string>\",\n    \"OM\": \"<string>\",\n    \"PK\": \"<string>\",\n    \"PW\": \"<string>\",\n    \"PS\": \"<string>\",\n    \"PA\": \"<string>\",\n    \"PG\": \"<string>\",\n    \"PY\": \"<string>\",\n    \"PE\": \"<string>\",\n    \"PH\": \"<string>\",\n    \"PN\": \"<string>\",\n    \"PL\": \"<string>\",\n    \"PT\": \"<string>\",\n    \"PR\": \"<string>\",\n    \"QA\": \"<string>\",\n    \"RE\": \"<string>\",\n    \"RO\": \"<string>\",\n    \"RU\": \"<string>\",\n    \"RW\": \"<string>\",\n    \"SH\": \"<string>\",\n    \"KN\": \"<string>\",\n    \"LC\": \"<string>\",\n    \"PM\": \"<string>\",\n    \"VC\": \"<string>\",\n    \"WS\": \"<string>\",\n    \"SM\": \"<string>\",\n    \"ST\": \"<string>\",\n    \"SA\": \"<string>\",\n    \"SN\": \"<string>\",\n    \"SC\": \"<string>\",\n    \"SL\": \"<string>\",\n    \"SG\": \"<string>\",\n    \"SK\": \"<string>\",\n    \"SI\": \"<string>\",\n    \"SB\": \"<string>\",\n    \"SO\": \"<string>\",\n    \"ZA\": \"<string>\",\n    \"GS\": \"<string>\",\n    \"ES\": \"<string>\",\n    \"LK\": \"<string>\",\n    \"SD\": \"<string>\",\n    \"SR\": \"<string>\",\n    \"SJ\": \"<string>\",\n    \"SZ\": \"<string>\",\n    \"SE\": \"<string>\",\n    \"CH\": \"<string>\",\n    \"SY\": \"<string>\",\n    \"TW\": \"<string>\",\n    \"TJ\": \"<string>\",\n    \"TZ\": \"<string>\",\n    \"TH\": \"<string>\",\n    \"TL\": \"<string>\",\n    \"TG\": \"<string>\",\n    \"TK\": \"<string>\",\n    \"TO\": \"<string>\",\n    \"TT\": \"<string>\",\n    \"TN\": \"<string>\",\n    \"TR\": \"<string>\",\n    \"TM\": \"<string>\",\n    \"TC\": \"<string>\",\n    \"TV\": \"<string>\",\n    \"UG\": \"<string>\",\n    \"UA\": \"<string>\",\n    \"AE\": \"<string>\",\n    \"GB\": \"<string>\",\n    \"US\": \"<string>\",\n    \"UM\": \"<string>\",\n    \"UY\": \"<string>\",\n    \"UZ\": \"<string>\",\n    \"VU\": \"<string>\",\n    \"VE\": \"<string>\",\n    \"VN\": \"<string>\",\n    \"VG\": \"<string>\",\n    \"VI\": \"<string>\",\n    \"WF\": \"<string>\",\n    \"EH\": \"<string>\",\n    \"YE\": \"<string>\",\n    \"ZM\": \"<string>\",\n    \"ZW\": \"<string>\",\n    \"AX\": \"<string>\",\n    \"BQ\": \"<string>\",\n    \"CW\": \"<string>\",\n    \"GG\": \"<string>\",\n    \"IM\": \"<string>\",\n    \"JE\": \"<string>\",\n    \"ME\": \"<string>\",\n    \"BL\": \"<string>\",\n    \"MF\": \"<string>\",\n    \"RS\": \"<string>\",\n    \"SX\": \"<string>\",\n    \"SS\": \"<string>\",\n    \"XK\": \"<string>\"\n  },\n  \"doIndex\": false,\n  \"webhookIds\": [\n    \"<string>\"\n  ],\n  \"publicStats\": false,\n  \"tagId\": \"<string>\",\n  \"tagIds\": [\n    \"clux0rgak00011...\"\n  ],\n  \"tagNames\": \"<string>\",\n  \"folderId\": \"<string>\",\n  \"comments\": \"<string>\",\n  \"flexible\": false,\n  \"filled\": false,\n  \"static\": false,\n  \"useDisplayPage\": true,\n  \"contentStatic\": \"<string>\",\n  \"text\": \"<string>\",\n  \"email\": {},\n  \"wifi\": {},\n  \"url\": \"<string>\",\n  \"phone\": \"<string>\",\n  \"vcard\": {},\n  \"crypto\": {},\n  \"sms\": {},\n  \"facetime\": {},\n  \"latlog\": {},\n  \"logo\": \"<string>\",\n  \"bgColor\": \"#ffffff\",\n  \"fgColor\": \"#000000\",\n  \"size\": 1024,\n  \"level\": \"M\",\n  \"showLogo\": true,\n  \"src\": \"<string>\",\n  \"height\": 256,\n  \"width\": 256,\n  \"excavate\": true,\n  \"pattern\": \"default\",\n  \"shape\": \"none\",\n  \"frame\": \"none\",\n  \"frameColor\": \"#000000\",\n  \"frameText\": \"<string>\",\n  \"frameTextColor\": \"<string>\",\n  \"preRedirection\": false,\n  \"pageId\": \"<string>\",\n  \"pageUrl\": \"<string>\",\n  \"isFormMandatory\": false\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.codeqr.io/qrcodes")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"domain\": \"<string>\",\n  \"key\": \"<string>\",\n  \"externalId\": \"123456\",\n  \"trackConversion\": false,\n  \"archived\": false,\n  \"expiresAt\": \"2023-11-07T05:31:56Z\",\n  \"expiredUrl\": \"<string>\",\n  \"password\": \"<string>\",\n  \"proxy\": false,\n  \"title\": \"<string>\",\n  \"description\": \"<string>\",\n  \"image\": \"<string>\",\n  \"rewrite\": false,\n  \"ios\": \"<string>\",\n  \"android\": \"<string>\",\n  \"geo\": {\n    \"AF\": \"<string>\",\n    \"AL\": \"<string>\",\n    \"DZ\": \"<string>\",\n    \"AS\": \"<string>\",\n    \"AD\": \"<string>\",\n    \"AO\": \"<string>\",\n    \"AI\": \"<string>\",\n    \"AQ\": \"<string>\",\n    \"AG\": \"<string>\",\n    \"AR\": \"<string>\",\n    \"AM\": \"<string>\",\n    \"AW\": \"<string>\",\n    \"AU\": \"<string>\",\n    \"AT\": \"<string>\",\n    \"AZ\": \"<string>\",\n    \"BS\": \"<string>\",\n    \"BH\": \"<string>\",\n    \"BD\": \"<string>\",\n    \"BB\": \"<string>\",\n    \"BY\": \"<string>\",\n    \"BE\": \"<string>\",\n    \"BZ\": \"<string>\",\n    \"BJ\": \"<string>\",\n    \"BM\": \"<string>\",\n    \"BT\": \"<string>\",\n    \"BO\": \"<string>\",\n    \"BA\": \"<string>\",\n    \"BW\": \"<string>\",\n    \"BV\": \"<string>\",\n    \"BR\": \"<string>\",\n    \"IO\": \"<string>\",\n    \"BN\": \"<string>\",\n    \"BG\": \"<string>\",\n    \"BF\": \"<string>\",\n    \"BI\": \"<string>\",\n    \"KH\": \"<string>\",\n    \"CM\": \"<string>\",\n    \"CA\": \"<string>\",\n    \"CV\": \"<string>\",\n    \"KY\": \"<string>\",\n    \"CF\": \"<string>\",\n    \"TD\": \"<string>\",\n    \"CL\": \"<string>\",\n    \"CN\": \"<string>\",\n    \"CX\": \"<string>\",\n    \"CC\": \"<string>\",\n    \"CO\": \"<string>\",\n    \"KM\": \"<string>\",\n    \"CG\": \"<string>\",\n    \"CD\": \"<string>\",\n    \"CK\": \"<string>\",\n    \"CR\": \"<string>\",\n    \"CI\": \"<string>\",\n    \"HR\": \"<string>\",\n    \"CU\": \"<string>\",\n    \"CY\": \"<string>\",\n    \"CZ\": \"<string>\",\n    \"DK\": \"<string>\",\n    \"DJ\": \"<string>\",\n    \"DM\": \"<string>\",\n    \"DO\": \"<string>\",\n    \"EC\": \"<string>\",\n    \"EG\": \"<string>\",\n    \"SV\": \"<string>\",\n    \"GQ\": \"<string>\",\n    \"ER\": \"<string>\",\n    \"EE\": \"<string>\",\n    \"ET\": \"<string>\",\n    \"FK\": \"<string>\",\n    \"FO\": \"<string>\",\n    \"FJ\": \"<string>\",\n    \"FI\": \"<string>\",\n    \"FR\": \"<string>\",\n    \"GF\": \"<string>\",\n    \"PF\": \"<string>\",\n    \"TF\": \"<string>\",\n    \"GA\": \"<string>\",\n    \"GM\": \"<string>\",\n    \"GE\": \"<string>\",\n    \"DE\": \"<string>\",\n    \"GH\": \"<string>\",\n    \"GI\": \"<string>\",\n    \"GR\": \"<string>\",\n    \"GL\": \"<string>\",\n    \"GD\": \"<string>\",\n    \"GP\": \"<string>\",\n    \"GU\": \"<string>\",\n    \"GT\": \"<string>\",\n    \"GN\": \"<string>\",\n    \"GW\": \"<string>\",\n    \"GY\": \"<string>\",\n    \"HT\": \"<string>\",\n    \"HM\": \"<string>\",\n    \"VA\": \"<string>\",\n    \"HN\": \"<string>\",\n    \"HK\": \"<string>\",\n    \"HU\": \"<string>\",\n    \"IS\": \"<string>\",\n    \"IN\": \"<string>\",\n    \"ID\": \"<string>\",\n    \"IR\": \"<string>\",\n    \"IQ\": \"<string>\",\n    \"IE\": \"<string>\",\n    \"IL\": \"<string>\",\n    \"IT\": \"<string>\",\n    \"JM\": \"<string>\",\n    \"JP\": \"<string>\",\n    \"JO\": \"<string>\",\n    \"KZ\": \"<string>\",\n    \"KE\": \"<string>\",\n    \"KI\": \"<string>\",\n    \"KP\": \"<string>\",\n    \"KR\": \"<string>\",\n    \"KW\": \"<string>\",\n    \"KG\": \"<string>\",\n    \"LA\": \"<string>\",\n    \"LV\": \"<string>\",\n    \"LB\": \"<string>\",\n    \"LS\": \"<string>\",\n    \"LR\": \"<string>\",\n    \"LY\": \"<string>\",\n    \"LI\": \"<string>\",\n    \"LT\": \"<string>\",\n    \"LU\": \"<string>\",\n    \"MO\": \"<string>\",\n    \"MG\": \"<string>\",\n    \"MW\": \"<string>\",\n    \"MY\": \"<string>\",\n    \"MV\": \"<string>\",\n    \"ML\": \"<string>\",\n    \"MT\": \"<string>\",\n    \"MH\": \"<string>\",\n    \"MQ\": \"<string>\",\n    \"MR\": \"<string>\",\n    \"MU\": \"<string>\",\n    \"YT\": \"<string>\",\n    \"MX\": \"<string>\",\n    \"FM\": \"<string>\",\n    \"MD\": \"<string>\",\n    \"MC\": \"<string>\",\n    \"MN\": \"<string>\",\n    \"MS\": \"<string>\",\n    \"MA\": \"<string>\",\n    \"MZ\": \"<string>\",\n    \"MM\": \"<string>\",\n    \"NA\": \"<string>\",\n    \"NR\": \"<string>\",\n    \"NP\": \"<string>\",\n    \"NL\": \"<string>\",\n    \"NC\": \"<string>\",\n    \"NZ\": \"<string>\",\n    \"NI\": \"<string>\",\n    \"NE\": \"<string>\",\n    \"NG\": \"<string>\",\n    \"NU\": \"<string>\",\n    \"NF\": \"<string>\",\n    \"MK\": \"<string>\",\n    \"MP\": \"<string>\",\n    \"NO\": \"<string>\",\n    \"OM\": \"<string>\",\n    \"PK\": \"<string>\",\n    \"PW\": \"<string>\",\n    \"PS\": \"<string>\",\n    \"PA\": \"<string>\",\n    \"PG\": \"<string>\",\n    \"PY\": \"<string>\",\n    \"PE\": \"<string>\",\n    \"PH\": \"<string>\",\n    \"PN\": \"<string>\",\n    \"PL\": \"<string>\",\n    \"PT\": \"<string>\",\n    \"PR\": \"<string>\",\n    \"QA\": \"<string>\",\n    \"RE\": \"<string>\",\n    \"RO\": \"<string>\",\n    \"RU\": \"<string>\",\n    \"RW\": \"<string>\",\n    \"SH\": \"<string>\",\n    \"KN\": \"<string>\",\n    \"LC\": \"<string>\",\n    \"PM\": \"<string>\",\n    \"VC\": \"<string>\",\n    \"WS\": \"<string>\",\n    \"SM\": \"<string>\",\n    \"ST\": \"<string>\",\n    \"SA\": \"<string>\",\n    \"SN\": \"<string>\",\n    \"SC\": \"<string>\",\n    \"SL\": \"<string>\",\n    \"SG\": \"<string>\",\n    \"SK\": \"<string>\",\n    \"SI\": \"<string>\",\n    \"SB\": \"<string>\",\n    \"SO\": \"<string>\",\n    \"ZA\": \"<string>\",\n    \"GS\": \"<string>\",\n    \"ES\": \"<string>\",\n    \"LK\": \"<string>\",\n    \"SD\": \"<string>\",\n    \"SR\": \"<string>\",\n    \"SJ\": \"<string>\",\n    \"SZ\": \"<string>\",\n    \"SE\": \"<string>\",\n    \"CH\": \"<string>\",\n    \"SY\": \"<string>\",\n    \"TW\": \"<string>\",\n    \"TJ\": \"<string>\",\n    \"TZ\": \"<string>\",\n    \"TH\": \"<string>\",\n    \"TL\": \"<string>\",\n    \"TG\": \"<string>\",\n    \"TK\": \"<string>\",\n    \"TO\": \"<string>\",\n    \"TT\": \"<string>\",\n    \"TN\": \"<string>\",\n    \"TR\": \"<string>\",\n    \"TM\": \"<string>\",\n    \"TC\": \"<string>\",\n    \"TV\": \"<string>\",\n    \"UG\": \"<string>\",\n    \"UA\": \"<string>\",\n    \"AE\": \"<string>\",\n    \"GB\": \"<string>\",\n    \"US\": \"<string>\",\n    \"UM\": \"<string>\",\n    \"UY\": \"<string>\",\n    \"UZ\": \"<string>\",\n    \"VU\": \"<string>\",\n    \"VE\": \"<string>\",\n    \"VN\": \"<string>\",\n    \"VG\": \"<string>\",\n    \"VI\": \"<string>\",\n    \"WF\": \"<string>\",\n    \"EH\": \"<string>\",\n    \"YE\": \"<string>\",\n    \"ZM\": \"<string>\",\n    \"ZW\": \"<string>\",\n    \"AX\": \"<string>\",\n    \"BQ\": \"<string>\",\n    \"CW\": \"<string>\",\n    \"GG\": \"<string>\",\n    \"IM\": \"<string>\",\n    \"JE\": \"<string>\",\n    \"ME\": \"<string>\",\n    \"BL\": \"<string>\",\n    \"MF\": \"<string>\",\n    \"RS\": \"<string>\",\n    \"SX\": \"<string>\",\n    \"SS\": \"<string>\",\n    \"XK\": \"<string>\"\n  },\n  \"doIndex\": false,\n  \"webhookIds\": [\n    \"<string>\"\n  ],\n  \"publicStats\": false,\n  \"tagId\": \"<string>\",\n  \"tagIds\": [\n    \"clux0rgak00011...\"\n  ],\n  \"tagNames\": \"<string>\",\n  \"folderId\": \"<string>\",\n  \"comments\": \"<string>\",\n  \"flexible\": false,\n  \"filled\": false,\n  \"static\": false,\n  \"useDisplayPage\": true,\n  \"contentStatic\": \"<string>\",\n  \"text\": \"<string>\",\n  \"email\": {},\n  \"wifi\": {},\n  \"url\": \"<string>\",\n  \"phone\": \"<string>\",\n  \"vcard\": {},\n  \"crypto\": {},\n  \"sms\": {},\n  \"facetime\": {},\n  \"latlog\": {},\n  \"logo\": \"<string>\",\n  \"bgColor\": \"#ffffff\",\n  \"fgColor\": \"#000000\",\n  \"size\": 1024,\n  \"level\": \"M\",\n  \"showLogo\": true,\n  \"src\": \"<string>\",\n  \"height\": 256,\n  \"width\": 256,\n  \"excavate\": true,\n  \"pattern\": \"default\",\n  \"shape\": \"none\",\n  \"frame\": \"none\",\n  \"frameColor\": \"#000000\",\n  \"frameText\": \"<string>\",\n  \"frameTextColor\": \"<string>\",\n  \"preRedirection\": false,\n  \"pageId\": \"<string>\",\n  \"pageUrl\": \"<string>\",\n  \"isFormMandatory\": false\n}"

response = http.request(request)
puts response.read_body

200

{
  "id": "<string>",
  "domain": "<string>",
  "key": "<string>",
  "archived": false,
  "expiresAt": "<string>",
  "expiredUrl": "<string>",
  "password": "<string>",
  "externalId": "<string>",
  "trackConversion": false,
  "proxy": false,
  "title": "<string>",
  "description": "<string>",
  "image": "<string>",
  "utm_source": "<string>",
  "utm_medium": "<string>",
  "utm_campaign": "<string>",
  "utm_term": "<string>",
  "utm_content": "<string>",
  "rewrite": false,
  "doIndex": false,
  "flexible": false,
  "filled": false,
  "ios": "<string>",
  "android": "<string>",
  "geo": {},
  "static": false,
  "useDisplayPage": true,
  "contentStatic": "<string>",
  "text": "<string>",
  "email": {},
  "wifi": {},
  "url": "<string>",
  "phone": "<string>",
  "vcard": {},
  "crypto": {},
  "sms": {},
  "facetime": {},
  "latlog": {},
  "logo": "<string>",
  "bgColor": "<string>",
  "fgColor": "<string>",
  "size": 123,
  "level": "<string>",
  "showLogo": false,
  "src": "<string>",
  "height": 123,
  "width": 123,
  "excavate": false,
  "userId": "<string>",
  "projectId": "<string>",
  "publicStats": false,
  "scans": 0,
  "lastClicked": "<string>",
  "leads": 0,
  "sales": 0,
  "saleAmount": 0,
  "createdAt": "<string>",
  "updatedAt": "<string>",
  "tagId": "<string>",
  "tags": [
    {
      "id": "<string>",
      "name": "<string>"
    }
  ],
  "folderId": "<string>",
  "comments": "<string>",
  "notificationToken": "<string>",
  "preRedirection": false,
  "isFormMandatory": false,
  "pageId": "<string>",
  "pageUrl": "<string>"
}

{
  "error": {
    "code": "bad_request",
    "message": "The requested resource was not found.",
    "doc_url": "https://docs.codeqr.io/api-reference/errors#bad-request"
  }
}

{
  "error": {
    "code": "unauthorized",
    "message": "The requested resource was not found.",
    "doc_url": "https://docs.codeqr.io/api-reference/errors#unauthorized"
  }
}

{
  "error": {
    "code": "forbidden",
    "message": "The requested resource was not found.",
    "doc_url": "https://docs.codeqr.io/api-reference/errors#forbidden"
  }
}

{
  "error": {
    "code": "not_found",
    "message": "The requested resource was not found.",
    "doc_url": "https://docs.codeqr.io/api-reference/errors#not-found"
  }
}

{
  "error": {
    "code": "conflict",
    "message": "The requested resource was not found.",
    "doc_url": "https://docs.codeqr.io/api-reference/errors#conflict"
  }
}

{
  "error": {
    "code": "invite_expired",
    "message": "The requested resource was not found.",
    "doc_url": "https://docs.codeqr.io/api-reference/errors#invite-expired"
  }
}

{
  "error": {
    "code": "unprocessable_entity",
    "message": "The requested resource was not found.",
    "doc_url": "https://docs.codeqr.io/api-reference/errors#unprocessable-entity"
  }
}

{
  "error": {
    "code": "rate_limit_exceeded",
    "message": "The requested resource was not found.",
    "doc_url": "https://docs.codeqr.io/api-reference/errors#rate-limit_exceeded"
  }
}

{
  "error": {
    "code": "internal_server_error",
    "message": "The requested resource was not found.",
    "doc_url": "https://docs.codeqr.io/api-reference/errors#internal-server_error"
  }
}

Authorizations

Authorization · string · header · required

Default authentication mechanism

Body

application/json

type · enum<string> · required

The type of content of the QR code.

Available options: url, text, email, wifi, phone, vcard, crypto, sms, facetime, latlog

domain · string

The domain of the QR code. If not provided, the main domain of the project will be used (or codeqr.link if the project does not have domains).

key · string

The slug of the QR code. If not provided, a random slug of 7 characters will be generated.

externalId · string | null

This is the ID of the QR code in your database. If defined, it can be used to identify the QR code in the future. It must be prefixed with ext_ when passed as a query parameter.

Required string length: 1 - 255

Example:

"123456"

trackConversion · boolean · default: false

If should track conversions for the QR code.

archived · boolean · default: false

If the QR code is archived.

expiresAt · string<date-time> | null

The date and time the QR code will expire in ISO-8601 format. Must be in the future.

expiredUrl · string | null

The URL to redirect when the QR code expires.

password · string | null

The password required to access the destination URL of the QR code.

proxy · boolean · default: false

If the QR code uses the custom link preview feature.

title · string | null

The title of the QR code generated via api.codeqr.io/metatags. Will be used for custom link preview if proxy is true.

description · string | null

The description of the QR code generated via api.codeqr.io/metatags. Will be used for custom link preview if proxy is true.

image · string | null

The image of the QR code generated via api.codeqr.io/metatags. Will be used for custom link preview if proxy is true.

rewrite · boolean · default: false

If the QR code uses link cloaking.

ios · string | null

The destination URL for iOS for the QR code for device targeting iOS.

android · string | null

The destination URL for Android for the QR code for device targeting Android.

geo · object | null

Geographic segmentation information for the QR code in the JSON format {[COUNTRY]: https://example.com }.

Show child attributes

doIndex · boolean · default: false

Allow search engines to index your QR code. The default is false if not provided. Learn more: https://codeqr.link/noindex

webhookIds · string[] | null

An array of webhook IDs to trigger when the link is clicked. These webhooks will receive click event data.

publicStats · boolean · default: false

If the statistics of the QR code are publicly accessible.

tagId · string | null · deprecated

The unique ID of the tag assigned to the QR code. This field is deprecated – use tagIds instead.

tagIds · string string[]

The unique IDs of the tags assigned to the QR code.

Example:

["clux0rgak00011..."]

tagNames · string string[]

The unique name of the tags assigned to the QR code (case insensitive).

folderId · string | null

The unique ID of the folder assigned to the QR code. Omit or set to null for no folder.

comments · string | null

The comments for the QR code.

flexible · boolean · default: false

If the QR code is flexible.

filled · boolean · default: false

If the QR code is filled.

static · boolean · default: false

If the QR code is static.

useDisplayPage · boolean · default: true

For dynamic QR codes with phone, email, or sms types: if true (default), shows an action page with buttons. If false, redirects directly to tel:/mailto:/sms: URI.

contentStatic · string | null

The static content of the QR code.

text · string | null

The text of the QR code.

email · object | null

The email information of the QR code.

Show child attributes

wifi · object | null

The WiFi information of the QR code.

Show child attributes

url · string | null

The destination URL of the QR code.

phone · string | null

The phone number of the QR code.

vcard · object | null

The vCard information of the QR code.

Show child attributes

crypto · object | null

The cryptocurrency information of the QR code.

Show child attributes

sms · object | null

The SMS information of the QR code.

Show child attributes

facetime · object | null

The FaceTime information of the QR code.

Show child attributes

latlog · object | null

The latitude and longitude information of the QR code.

Show child attributes

logo · string | null

The logo of the QR code.

bgColor · string · default: #ffffff

The background color of the QR code.

fgColor · string · default: #000000

The foreground color of the QR code.

size · number · default: 1024

The size of the QR code.

level · string · default: M

The level of error correction of the QR code.

showLogo · boolean · default: true

If the logo should be displayed in the QR code.

src · string | null

The image URL of the QR code.

height · number · default: 256

The height of the QR code.

width · number · default: 256

The width of the QR code.

excavate · boolean · default: true

If the QR code should have excavated areas.

pattern · string · default: default

The pattern of the modules of the QR code.

shape · string · default: none

The shape of the design around the QR code (none, square, circle).

frame · string · default: none

The type of frame of the QR code (e.g. none, frame-1, frame-2, frame-3, frame-5, frame-6). frame-5/6 are top-bar variants. Unknown ids fall back to no frame at render.

frameColor · string · default: #000000

The color of the frame (hex or CSS keyword). Invalid values are coerced to default.

frameText · string

The text of the frame of the QR code.

Maximum string length: 200

frameTextColor · string

The color of the text inside the frame (hex or CSS keyword). When not set, a contrasting color is derived from the frame color.

preRedirection · boolean · default: false

If the QR code has pre-redirection.

pageId · string | null

The ID of the page to redirect to before the QR code destination.

pageUrl · string | null

The URL of the page to redirect to before the QR code destination.

isFormMandatory · boolean · default: false

If the form is mandatory for the page.

Response

200

application/json

The created QR Code

id · string · required

The unique ID of the QR code.

domain · string · required

The domain of the QR code. If not provided, the main domain of the project will be used (or codeqr.link if the project does not have domains).

key · string · required

The slug of the QR code. If not provided, a random slug of 7 characters will be generated.

archived · boolean · default: false · required

If the QR code is archived.

expiresAt · string | null · required

The date and time the QR code will expire in ISO-8601 format. Must be in the future.

expiredUrl · string | null · required

The destination URL when the QR code expires.

password · string | null · required

The password required to access the destination URL of the QR code.

externalId · string | null · required

The external ID associated with the QR code.

trackConversion · boolean · default: false · required

[BETA] If should track conversions for the QR code.

proxy · boolean · default: false · required

If the QR code uses the custom link preview feature.

title · string | null · required

The title of the QR code generated via api.codeqr.io/metatags. Will be used for custom link preview if proxy is true.

description · string | null · required

The description of the QR code generated via api.codeqr.io/metatags. Will be used for custom link preview if proxy is true.

image · string | null · required

The image of the QR code generated via api.codeqr.io/metatags. Will be used for custom link preview if proxy is true.

utm_source · string | null · required

The source UTM of the QR code.

utm_medium · string | null · required

The medium UTM of the QR code.

utm_campaign · string | null · required

The campaign UTM of the QR code.

utm_term · string | null · required

The term UTM of the QR code.

utm_content · string | null · required

The content UTM of the QR code.

rewrite · boolean · default: false · required

If the QR code uses link cloaking.

doIndex · boolean · default: false · required

If the QR code should be indexed.

flexible · boolean · default: false · required

If the QR code is flexible.

filled · boolean · default: false · required

If the QR code is filled.

ios · string | null · required

The destination URL for iOS for the QR code for device targeting iOS.

android · string | null · required

The destination URL for Android for the QR code for device targeting Android.

geo · object | null · required

Geographic segmentation information for the QR code in the JSON format {[COUNTRY]: https://example.com }. Learn more: https://codeqr.link/geo

Show child attributes

static · boolean · default: false · required

If the QR code is static.

useDisplayPage · boolean · default: true · required

For dynamic QR codes with phone, email, or sms types: if true (default), shows an action page with buttons. If false, redirects directly to tel:/mailto:/sms: URI.

type · enum<string> · required

The type of the QR code.

Available options: url, text, email, wifi, phone, vcard, crypto, sms, facetime, latlog, pix

contentStatic · string | null · required

The static content of the QR code.

text · string | null · required

The text of the QR code.

email · object | null · required

The email information of the QR code.

Show child attributes

wifi · object | null · required

The WiFi information of the QR code.

Show child attributes

url · string | null · required

The URL of the QR code.

phone · string | null · required

The phone number of the QR code.

vcard · object | null · required

The vCard information of the QR code.

Show child attributes

crypto · object | null · required

The cryptocurrency information of the QR code.

Show child attributes

sms · object | null · required

The SMS information of the QR code.

Show child attributes

facetime · object | null · required

The FaceTime information of the QR code.

Show child attributes

latlog · object | null · required

The latitude and longitude information of the QR code.

Show child attributes

logo · string | null · required

The logo of the QR code.

bgColor · string · required

The background color of the QR code.

fgColor · string · required

The foreground color of the QR code.

size · number · required

The size of the QR code.

level · string · required

The level of error correction of the QR code.

showLogo · boolean · default: false · required

If the logo should be displayed in the QR code.

src · string | null · required

The source of the QR code.

height · number · required

The height of the QR code.

width · number · required

The width of the QR code.

excavate · boolean · default: false · required

If the QR code should be excavated.

userId · string | null · required

The ID of the user that created the QR code.

projectId · string | null · required

The ID of the project of the QR code.

publicStats · boolean · default: false · required

If the statistics of the QR code are publicly accessible.

scans · number · default: 0 · required

The number of scans of the QR code.

lastClicked · string | null · required

The date and time the QR code was scanned last.

leads · number · default: 0 · required

The number of leads generated by the QR code.

sales · number · default: 0 · required

The number of sales generated by the QR code.

saleAmount · number · default: 0 · required

The amount of the sale generated by the link.

createdAt · string · required

The date and time the QR code was created.

updatedAt · string · required

The date and time the QR code was updated last.

tagId · string | null · required · deprecated

[DEPRECATED (use tags instead)]: The unique ID of the tag assigned to the QR code.

tags · Tag · object[] | null · required

The tags assigned to the QR code.

Show child attributes

folderId · string | null · required

The unique ID of the folder assigned to the QR code.

comments · string | null · required

The comments for the QR code.

notificationToken · string | null · required

The notification token of the QR code.

preRedirection · boolean · default: false · required

If the QR code has pre-redirection.

isFormMandatory · boolean · default: false · required

If the form is mandatory for the page.

pageId · string | null

The ID of the page to redirect to before the QR code destination.

pageUrl · string | null

The URL of the page to redirect to before the QR code destination.