Designs

Rename a design or replace its spec; QRs using it re-render

patch/api/v1/designs/{id}

Request

  • Base URL: https://qrlia.dev.castlesoft.eu
  • URL: https://qrlia.dev.castlesoft.eu/api/v1/designs/{id}
  • Auth: one of:
    • HTTP bearer
    • API key in cookie qrc_session

Path parameters

idstring uuid required

Request body

namestring
specobject

Replaces the whole spec. QR codes using this design re-render with it. Style fields, all optional: foreground and background (hex colour, background may be "transparent"); moduleShape square|rounded|dots|extra-rounded|star|sparkle|heart|diamond; eyeShape square|rounded|dot|leaf|petal|petal-out|diamond|flower|shield and eyeInnerShape square|rounded|dot|star|petal|petal-out|diamond|flower|heart (the three corner markers); eyeColor and eyeInnerColor (hex); gradient {type: linear|radial, angle, stops: [{at: 0-1, color}]}; logoUrl (https URL or an /uploads/… path), logoScale up to 0.35, logoShape rect|circle; without a logoUrl the code carries the qrlia mark, and hideLogo: true leaves the centre empty (not on the Free plan, which always shows the mark); errorCorrection L|M|Q|H (H when there is a logo); margin (modules); frame {variant: none|banner|bubble|callout, text up to 30 characters, color, textColor, background}. A brand style is usually foreground = the brand's dark colour, eyeColor = its accent, background = white or its light colour, the company logo in the centre.

Response

Updated

idstring uuid required
namestring required
specobject required
companyIdstring uuid nullable required
createdAtstring date-time required

Changes

No recorded changes to this operation across all 1 revision of this API.