Skip to main content

Create Folder

Create a new folder in your workspace. Use folders to organize QR codes by campaign, location, product line, or any structure that fits your workflow.

POST/folders
Folders feature

Folders require the Folders feature to be enabled on your workspace plan. If disabled, this endpoint returns a 403 error.

Headers

HeaderRequiredDescription
X-API-KeyRequiredYour API key
Content-TypeRequiredapplication/json
QR-VersionOptionalAPI version (e.g., 2026-02-16)

Body Parameters

ParameterTypeRequiredDescription
namestringRequiredFolder name (1–255 characters, leading/trailing spaces trimmed)

Request

curl -X POST "https://integration-api.qr-build.com/folders" \
-H "X-API-Key: qrb_live_your_api_key_here" \
-H "Content-Type: application/json" \
-d '{
"name": "Marketing Campaign 2026"
}'

Response

{
"object": "folder",
"success": true,
"data": {
"id": "fld-aBc123XyZ9",
"name": "Marketing Campaign 2026",
"qr_codes_count": 0,
"created_at": "2026-02-16T10:30:00Z"
}
}

Error — Validation

{
"success": false,
"error": {
"code": "VALIDATION_ERROR",
"message": "Invalid request body",
"details": [
{ "field": "name", "message": "name is required" }
]
}
}

Error — Folders Not Available

{
"success": false,
"error": {
"code": "FEATURE_DISABLED",
"message": "Folders feature is not available for this workspace"
}
}