API reference
API explorer
Pick an endpoint, fill in its parameters and see the exact request in cURL, JavaScript and Python. With your own API key you can also send it and read the real response.
Requests here are live
QRBold has no sandbox. A request you send from this page acts on the real account your key belongs to: a POST creates a real card or code, a DELETE removes one. Nothing is sent until you press Send.
PATCH/cards/ID
Replaces the card’s data, and optionally moves it to another template. Needs the cards:write scope.
Only fields and templateId are accepted: any other top-level key is rejected with 422. The card’s name follows the person’s name automatically. The design, status and short code cannot be changed here.
The code for this request
Updates as you type. It reads the key from an environment variable; the key you paste below is never put into it.
curl -X PATCH "https://api.qrbold.com/api/public/v1/cards/ID" \
-H "Authorization: Bearer $QRBOLD_API_KEY" \
-H "Content-Type: application/json" \
-H "Idempotency-Key: $(uuidgen)" \
-d '{
"fields": {
"firstName": "Ada",
"lastName": "Lovelace",
"title": "Chief Technology Officer",
"company": "Analytical Engines Ltd",
"photoUrl": "https://example.com/photos/ada.jpg",
"companyLogoUrl": "https://example.com/brand/logo.png",
"bio": "Builds calculating machines and the teams around them.",
"emails": [
{
"label": "Work",
"value": "ada@example.com"
}
],
"phones": [
{
"label": "Mobile",
"value": "+44 20 7946 0958"
}
],
"links": [
{
"type": "website",
"url": "example.com"
},
{
"type": "linkedin",
"url": "linkedin.com/in/ada-lovelace"
}
],
"address": {
"city": "London",
"country": "United Kingdom"
}
}
}'Send it from this browser
Kept in this page’s memory only, and sent only to the QRBold API in the Authorization header. It is not stored, not logged and not sent to any other server. Reloading the page clears it. Use a key with only the scopes you need, and revoke it afterwards if you created it for testing.
Paste an API key to send the request.
You do not need a key to use the explorer as a request builder. If you would rather work in a dedicated tool, download the Postman collection. New here? Start with the quickstart.