Create a code

Creates a dynamic KuikCode. Send an Idempotency-Key header to make retries safe.

Authorization

apiKey

AuthorizationBearer <token>

An API key from Settings, Developers: Authorization: Bearer kc_live_...

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

name*string

Length1 <= length <= 120

destination*|

folderId?|

Folder to file the code in; omit or null for the workspace root.

tags?array<>

Itemsitems <= 20

templateId?string

Design the code like one of your saved templates (GET /templates). Omit for the default look.

scanHost?string

Print the code on your branded scan host (your kuikco.de subdomain or an active custom domain) instead of the shared kuikco.de/p/ link. Fixed once the code exists.

Lengthlength <= 253

utm?

Campaign parameters appended to the destination on every scan.

gps?boolean

Ask scanners for their precise location (PRO). Off by default.

webhookUrl?string

https endpoint that receives every scan (Business).

Formaturi

Lengthlength <= 500

accessCode?string

Password visitors type before the destination opens (PRO). Never readable again.

Length1 <= length <= 64

Response Body

`application/json`

curl -X POST "https://example.com/codes" \  -H "Content-Type: application/json" \  -d '{    "name": "string",    "destination": {      "type": "url",      "url": "http://example.com"    }  }'

{  "id": "string",  "shortCode": "string",  "name": "string",  "scanUrl": "string",  "destination": {    "type": "string",    "url": "string",    "pageId": "string",    "summary": "string"  },  "folderId": "string",  "tags": [    "string"  ],  "archived": true,  "hasAccessCode": true,  "previewUrl": "string",  "scans": 0,  "createdAt": "2019-08-24T14:15:22Z",  "updatedAt": "2019-08-24T14:15:22Z"}

Authorization

Request Body

Response Body

201application/json

400application/json

403application/json

404application/json

`application/json`

`application/json`

`application/json`

`application/json`