Create many codes

Up to the plan's batch size per call (see limits.bulkBatch on GET /me), all into one folder, all or nothing. Send csv to import a file as the dashboard would; dryRun: true returns a preview with a previewHash to confirm with. Ten batches per ten minutes per key; dry runs are free.

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.

rows?array<>

One code per row. GS1 rows carry gs1; a batch is all links or all GS1. Either rows or csv.

Items1 <= items <= 1000

csv?string

The file's text instead of rows, parsed with the dashboard's bulk template rules (Name, Destination URL, Tags, UTM parameters, GPS; or the GS1 template).

Length1 <= length <= 2000000

dryRun?boolean

true validates and returns a preview (rows, problems, quota impact, previewHash) and writes nothing.

Defaultfalse

previewHash?string

From a dry run. The batch is refused with preview_changed when the rows no longer match it.

design?|||

How the code looks. Omit for plain black on white; assistants creating a code for a website should send { kind: "auto" }.

templateId?string

Shorthand for design: { kind: "template", templateId }.

scanHost?string

Branded scan host for every code in the batch.

Lengthlength <= 253

folderId?string

Existing folder for the whole batch. Exactly one of folderId / newFolderName.

newFolderName?string

Create this folder at the root and file the batch in it.

Length1 <= length <= 120

Response Body

`application/json`

curl -X POST "https://example.com/codes/bulk" \  -H "Content-Type: application/json" \  -d '{}'

{  "preview": true,  "kind": "website",  "rows": 0,  "sample": [    {      "name": "string",      "url": "string"    }  ],  "errors": [    "string"  ],  "quota": {    "limit": 0,    "used": 0,    "remaining": 0,    "fits": true  },  "batchLimit": 0,  "over": 0,  "design": {    "kind": "auto"  },  "previewHash": "string"}

Create many codes

AuthorizationCopiar link a esta sección

Request BodyCopiar link a esta sección

Response BodyCopiar link a esta sección

200application/json

201application/json

400application/json

403application/json

409application/json

429application/json

Authorization

Request Body

Response Body

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`