Links › Reset a link’s QR code to the plain code
Links
Reset a link’s QR code to the plain code
DELETE/api/{ORG}/links/{link}/qrPermalink
Answers the QrCode.
- Permission
- Links · edit
- Plan
- Plans that include the API: Pricing
- Retry
- Safe with an
Idempotency-Key
Example request
curl -X DELETE "https://console.brevily.com/api/NORTHWIND/links/01JC6Y8QH2M4ZK7T9VRW3XNB5D/qr" \ -H "x-api-key: brv_ak_7Fq2Lw9xK3" \ -H "x-api-secret: $BREVILY_SECRET" \ -H "Idempotency-Key: 4f9c1e2a-autumn"const res = await fetch("https://console.brevily.com/api/NORTHWIND/links/01JC6Y8QH2M4ZK7T9VRW3XNB5D/qr", { method: "DELETE", headers: { "x-api-key": "brv_ak_7Fq2Lw9xK3", "x-api-secret": process.env.BREVILY_SECRET, "Idempotency-Key": "4f9c1e2a-autumn", },});const answer = await res.json();Example answer
{ "styled": false, "fg": "example", "bg": "example", "shape": "example", "margin": 1, "logo": false, "logoSize": "SMALL", "logoAvailable": false}{ "code": "VALIDATION_FAILED", "message": "Check the form. (root): Not a value this field takes.", "details": { "fields": { "(root)": "Not a value this field takes." } }, "requestId": "18188559082372202519"}Made-up values. Send your own Idempotency-Key, one per change.
PathPermalink
| Name | Type | Required | Description | Allowed values |
|---|---|---|---|---|
ORG | string | required | Your organisation’s code. | 3 to 20 characters |
link | string | required | — |
AnswerPermalink
QrCode
| Name | Type | Description | Allowed values |
|---|---|---|---|
styled | boolean | A style is saved; false for the plain code. | — |
fg | string | The code’s colour, #rrggbb. | — |
bg | string | The ground’s colour, #rrggbb; null when transparent. | or null |
shape | string | The module shape. | — |
margin | integer | The quiet zone, in modules. | — |
logo | boolean | The organisation’s logo sits in the middle. | — |
logoSize | string | How big the logo is drawn when logo is true: LARGE (the default) is as big as still scans reliably at the code’s size; MEDIUM and SMALL are smaller shares of it. | SMALL, MEDIUM, LARGE |
logoAvailable | boolean | The organisation has a logo uploaded (Settings › General › Logo in QR codes). logo may be true without one: the code is then drawn whole until one is uploaded. | — |
ErrorsPermalink
| Status | Code | When |
|---|---|---|
| 400 | VALIDATION_FAILED |
A field, a parameter or the body is wrong; details.fields says which. |
| 400 | IDEMPOTENCY_KEY_INVALID |
The Idempotency-Key is longer than 255 characters. |
| 401 | UNAUTHENTICATED |
No key, a key that does not match, or one expired or revoked. |
| 403 | ACCESS_DENIED |
The key lacks Links · edit, or the organisation’s plan does not include it. |
| 404 | NOT_FOUND |
No organisation with that code for this key, or no such record in it. |
| 409 | CONFLICT |
|
| 409 | IDEMPOTENCY_IN_FLIGHT |
The first call with this Idempotency-Key is still running. |
| 413 | PAYLOAD_TOO_LARGE |
|
| 415 | UNSUPPORTED_MEDIA |
|
| 422 | IDEMPOTENCY_MISMATCH |
The same Idempotency-Key was sent with a different request. |
| 429 | RATE_LIMITED |
Too many calls: wait Retry-After seconds. |
Rate limitsPermalink
Counted with every other call of the organisation, by plan: Pricing. The answer carries RateLimit-Limit, RateLimit-Remaining and RateLimit-Reset; more on rate limits.
Type a call, a field or a guide.