Skip to main content
POST
/
batches
Create Batch
curl --request POST \
  --url https://api.useqrkit.com/v1/batches \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "items": [
    {
      "target": {
        "destination": "<string>",
        "text": "<string>",
        "email": "<string>",
        "subject": "<string>",
        "message": "<string>",
        "phone": "<string>",
        "ssid": "<string>",
        "password": "<string>",
        "title": "<string>",
        "location": "<string>",
        "start": "<string>",
        "end": "<string>",
        "utm": {
          "source": "<string>",
          "medium": "<string>",
          "campaign": "<string>",
          "term": "<string>",
          "content": "<string>"
        }
      },
      "name": "<string>",
      "folder_id": "<string>",
      "tags": [
        "<string>"
      ]
    }
  ],
  "design": {
    "error_correction": "Q",
    "colors": {
      "foreground": "#000000",
      "background": "#ffffff"
    },
    "gradient": {
      "start": "#005ae0",
      "end": "#00c2ff",
      "type": "linear-top-to-bottom"
    },
    "shapes": {
      "body": "square",
      "eye_frame": "square",
      "eye_ball": "square"
    },
    "eye_colors": {
      "frame": "#005ae0",
      "ball": "#004bb8"
    },
    "logo": {
      "url": "<string>",
      "clear_background": false
    },
    "transparent_background": false
  },
  "template_id": "<string>"
}
'
{
  "id": "batch_aB3dE5fG7hI9jK1m",
  "object": "batch",
  "total_count": 123,
  "completed_count": 123,
  "error_count": 123,
  "items": [
    {
      "name": "<string>",
      "type": "<string>",
      "qr_code_id": "<string>",
      "error": "<string>"
    }
  ],
  "created_at": "2023-11-07T05:31:56Z"
}

Authorizations

​
Authorization
string
header
required

API key in the Authorization header: Bearer qr_live_… or Bearer qr_test_…. Token endpoints take a Clerk session JWT instead.

Body

application/json
​
items
object[]
required
Required array length: 1 - 1000 elements
​
design
object

Visual customization. Stored with the code, so the dashboard shows exactly what the API created.

​
template_id
string

Saved dashboard template id — overrides design.

Response

Batch accepted for processing

​
id
string
Example:

"batch_aB3dE5fG7hI9jK1m"

​
object
string
Example:

"batch"

​
total_count
integer
​
completed_count
integer
​
error_count
integer
​
status
enum<string>
Available options:
processing,
completed,
failed
​
items
object[]

Present on GET /batches/{id}.

​
created_at
string<date-time>