Links › Set a link’s QR code style

Links

Set a link’s QR code style

PUT/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

bash
curl -X PUT "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" \  -H "Content-Type: application/json" \  -d '{    "fg": "example",    "bg": "example",    "transparent": false,    "shape": "square",    "margin": 1,    "logo": false,    "logoSize": "SMALL"  }'

Example answer

json
{  "styled": false,  "fg": "example",  "bg": "example",  "shape": "example",  "margin": 1,  "logo": false,  "logoSize": "SMALL",  "logoAvailable": false}

Made-up values. Send your own Idempotency-Key, one per change.

Path parameters
NameTypeRequiredDescriptionAllowed values
ORGstringrequiredYour organisation’s code.3 to 20 characters
linkstringrequired—

JSON. An unknown field is refused with a 400 naming it.

Body fields
NameTypeRequiredDescriptionAllowed values
fgstringoptionalThe code’s colour, #rrggbb; #000000 when left out.—
bgstringoptionalThe ground’s colour, #rrggbb; #ffffff when left out.—
transparentbooleanoptionalTrue: no ground colour.—
shapestringrequiredThe module shape.square, rounded, dot
marginintegeroptionalThe quiet zone in modules; 4 when left out.—
logobooleanoptionalTrue: the organisation’s logo sits in the middle.—
logoSizestringoptionalWith logo: how big it is drawn; LARGE (as big as still scans reliably) when left out.SMALL, MEDIUM, LARGE

QrCode

Answer fields
NameTypeDescriptionAllowed values
styledbooleanA style is saved; false for the plain code.—
fgstringThe code’s colour, #rrggbb.—
bgstringThe ground’s colour, #rrggbb; null when transparent.or null
shapestringThe module shape.—
marginintegerThe quiet zone, in modules.—
logobooleanThe organisation’s logo sits in the middle.—
logoSizestringHow 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
logoAvailablebooleanThe 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.—
Errors
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.

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.