API reference/18 of 22

Bulk jobs

Enqueue CSV or rows, poll, then download a ZIP.

POST/api/v1/workspaces/:workspaceId/bulk-jobs

Enqueue CSV (or rows[]) generation. Returns 202 with { job, credits_used }. Poll GET …/bulk-jobs/:jobId; when has_zip, GET …/download and …/mapping. Also GET list and DELETE cancel.

Requires Business plan (features.bulk) and bulk scope when using an API key. Format is png or svg only (not pdf).

Auth: User JWT, or Business API key · Scope: bulk

JSON body

  • content_typestringRequired

    Usually url (column must match)

  • formatstring

    png | svg (default png)

  • csvstring

    CSV text with header row (or pass rows[])

  • namestring

    Optional job label

curl -s -X POST "https://api.getmaxqr.com/api/v1/workspaces/$WS/bulk-jobs" \
  -H "content-type: application/json" \
  -H "X-Api-Key: mq_live_…" \
  -d '{"content_type":"url","format":"png","csv":"url,name\nhttps://a.com,A\nhttps://b.com,B\n"}'
Response
{
  "job": {
    "id": "…",
    "status": "queued",
    "content_type": "url",
    "format": "png",
    "total_rows": 2,
    "ok_rows": 0,
    "error_rows": 0,
    "has_zip": false,
    "has_mapping": false
  },
  "credits_used": 0
}