Errors

How the API reports errors, and what each status code means.

EZQR uses HTTP status codes to say whether a request worked. Errors have a JSON body with an error message written for people, so you can show it or log it as is.

{ "error": "QR code not found" }

Status codes

StatusMeaning
200The request worked
201A resource was created
204The request worked and there's nothing to return
400The body or parameters are invalid, or the body isn't valid JSON
401The API key is missing, wrong, revoked or expired
403Your plan doesn't include this, a plan limit was reached, or your role can't do it
404The resource doesn't exist in your workspace
429Too many requests. See Rate limits
500Something went wrong on our side. It's safe to retry

Common errors

ErrorWhat to do
Dynamic QR code limit reachedDelete or deactivate dynamic codes, or upgrade the plan
A destination URL is required for dynamic QR codesSend targetUrl, or a URL as content
Upgrade your plan to edit this dynamic QR codeThe code is beyond your plan's dynamic code limit. Upgrade to edit it again
Folder not foundThe folderId doesn't belong to your workspace
Domain not found or not active yetVerify the custom domain before using its domainId

Retrying

Retry 429 and 500 responses with exponential backoff. Don't retry 400, 401, 403 or 404 without changing the request, because the result will be the same.