API reference/17 of 22

Dynamic codes

Create editable short links on go.getmaxqr.com.

POST/api/v1/workspaces/:workspaceId/dynamic-codes

Creates a short redirect URL you can change later without reprinting. Free plans have maxDynamicCodes: 0 (Pro+). API keys need the dynamic scope and Business (keys are Business-only).

Also: GET list, GET/PATCH/DELETE …/:codeId, POST …/:codeId/activate|deactivate. Public redirect on the go host; status via GET /api/v1/r/:slug/status (no destination leaked).

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

JSON body

  • destination_urluriRequired

    Where scans should land

  • namestring

    Label in the dashboard

  • slugstring

    Optional custom slug

  • expires_atdatetime

    Optional expiry (ISO 8601)

curl -s -X POST "https://api.getmaxqr.com/api/v1/workspaces/$WS/dynamic-codes" \
  -H "content-type: application/json" \
  -H "X-Api-Key: mq_live_…" \
  -d '{"name":"Menu","destination_url":"https://example.com/menu"}'
Response
{
  "code": {
    "id": "…",
    "workspace_id": "…",
    "name": "Menu",
    "slug": "menu-ab12",
    "destination_url": "https://example.com/menu",
    "status": "active",
    "stored_status": "active",
    "scan_count": 0,
    "redirect_url": "https://go.getmaxqr.com/r/menu-ab12",
    "expires_at": null
  }
}