> ## Documentation Index
> Fetch the complete documentation index at: https://learn.biq.li/llms.txt
> Use this file to discover all available pages before exploring further.

# Update a QR code

> Surgically update content, dynamic behavior, tags, or styling.

`PATCH /v1/qr/{qr_id}` requires **QR codes: Write** (`qr_codes.update`). Send at least one supported field. Omitted top-level fields remain unchanged.

```bash theme={null}
curl --request PATCH \
  --url https://biq.li/api/v1/qr/biq_qr_01M19Q8W6R3M0AS7B4PK2H5XCY \
  --header 'Authorization: Bearer biqli_your_workspace_api_key' \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json' \
  --data '{
    "title": "Autumn product QR",
    "payload": {
      "long_url": "https://example.com/autumn"
    }
  }'
```

## Merge behavior

* `qr_config` is recursively merged with the current public styling configuration. You can change one color or one gradient property without resending the complete design.
* `payload` is replaced and normalized as a complete content payload. When changing it, send all values you want to preserve.
* `tag_ids` replaces the complete tag set. Send `[]` to remove all tags. A non-empty array also requires `tags.view`.
* Rule arrays replace their corresponding rule set. Send `[]` to clear a rule group and `exp_clicks_rule: null` to clear scan expiration.
* `qr_config: null` resets the saved public styling configuration to renderer defaults.

## Change styling surgically

```json theme={null}
{
  "qr_config": {
    "matrixColorMode": "gradient",
    "matrixGradient": {
      "colorOne": "#214687",
      "colorTwo": "#44C8DE",
      "angle": "315deg",
      "midpoint": 55
    },
    "applyGradientToAll": true
  }
}
```

See [Style a QR code](/docs/api-reference/qr-codes/styling) for accepted styles, colors, angles, logo rules, and precedence.

## Change type or content type

If you change `content_type`, also send a complete matching `payload`. Static and dynamic types accept different content types. Changing a QR to `static` clears scheduling, UTM data, and dynamic rules because those features do not apply to static content.

Custom logos are not supported. `qr_config.logoUrl` and `qr_config.useCustomLogo` return `422 validation_error`.

Success returns `200 OK` with the complete updated QR code. An unavailable or cross-workspace `biq_qr_...` ID returns `404 resource_not_found`.

## Shared API behavior

Authentication is workspace-scoped; see [Authentication](/docs/api-reference/authentication). Errors use the standard envelope and request IDs described in [Errors](/docs/api-reference/errors), and requests are subject to [Rate limits](/docs/api-reference/rate-limits).


## OpenAPI

````yaml PATCH /v1/qr/{qr}
openapi: 3.1.0
info:
  title: Biqli API
  version: 1.0.0
  description: Workspace-scoped REST API for Biqli.
servers:
  - url: https://biq.li/api
security:
  - bearerAuth: []
paths:
  /v1/qr/{qr}:
    parameters:
      - $ref: '#/components/parameters/QrId'
    patch:
      tags:
        - QR codes
      summary: Update a QR code
      description: Updates only supplied fields. Requires qr_codes.update.
      operationId: qr.update
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/QrPatch'
      responses:
        '200':
          description: Updated QR code.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/QrResponse'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
        '422':
          $ref: '#/components/responses/UnprocessableEntity'
        '429':
          $ref: '#/components/responses/RateLimited'
        '500':
          $ref: '#/components/responses/InternalError'
components:
  parameters:
    QrId:
      name: qr
      in: path
      required: true
      schema:
        type: string
        pattern: ^biq_qr_[0-9A-HJKMNP-TV-Z]{26}$
  schemas:
    QrPatch:
      allOf:
        - $ref: '#/components/schemas/QrFields'
        - type: object
          minProperties: 1
    QrResponse:
      type: object
      required:
        - qr_code
        - status
      properties:
        qr_code:
          $ref: '#/components/schemas/QrCode'
        status:
          type: string
          const: success
    QrFields:
      type: object
      additionalProperties: false
      properties:
        type:
          type: string
          enum:
            - static
            - dynamic
        content_type:
          type: string
          enum:
            - text
            - link
            - email
            - phone
            - sms
            - wifi
            - vcard
            - event
            - application
            - whatsapp
        title:
          type: string
          maxLength: 255
        payload:
          $ref: '#/components/schemas/QrPayload'
        qr_config:
          oneOf:
            - type: 'null'
            - $ref: '#/components/schemas/QrConfig'
        utm:
          type:
            - string
            - 'null'
          maxLength: 2000
        activates_at:
          type:
            - string
            - 'null'
          format: date-time
        expires_at:
          type:
            - string
            - 'null'
          format: date-time
        geo_rules:
          type: array
          items:
            $ref: '#/components/schemas/PublicRule'
        device_rules:
          type: array
          items:
            $ref: '#/components/schemas/PublicRule'
        platform_rules:
          type: array
          items:
            $ref: '#/components/schemas/PublicRule'
        exp_clicks_rule:
          type:
            - object
            - 'null'
        tag_ids:
          $ref: '#/components/schemas/PublicIdList'
    QrCode:
      type: object
      required:
        - id
        - type
        - content_type
        - title
        - payload
        - scan_value
        - qr_config
        - geo_rules
        - device_rules
        - platform_rules
        - tag_ids
        - clicks_count
        - safety_status
      properties:
        id:
          type: string
          pattern: ^biq_qr_[0-9A-HJKMNP-TV-Z]{26}$
        type:
          type: string
          enum:
            - static
            - dynamic
        content_type:
          type: string
          enum:
            - text
            - link
            - email
            - phone
            - sms
            - wifi
            - vcard
            - event
            - application
            - whatsapp
        title:
          type:
            - string
            - 'null'
        payload:
          $ref: '#/components/schemas/QrPayload'
        scan_value:
          type: string
        qr_config:
          $ref: '#/components/schemas/QrConfig'
        utm:
          type:
            - string
            - 'null'
        activates_at:
          type:
            - string
            - 'null'
          format: date-time
        expires_at:
          type:
            - string
            - 'null'
          format: date-time
        geo_rules:
          type: array
          items:
            $ref: '#/components/schemas/PublicRule'
        device_rules:
          type: array
          items:
            $ref: '#/components/schemas/PublicRule'
        platform_rules:
          type: array
          items:
            $ref: '#/components/schemas/PublicRule'
        exp_clicks_rule:
          type:
            - object
            - 'null'
        tag_ids:
          $ref: '#/components/schemas/PublicIdList'
        clicks_count:
          type: integer
          minimum: 0
        clicked_at:
          type:
            - string
            - 'null'
          format: date-time
        safety_status:
          type: string
          enum:
            - clear
            - pending
            - quarantined
        created_at:
          type:
            - string
            - 'null'
          format: date-time
        updated_at:
          type:
            - string
            - 'null'
          format: date-time
    ApiError:
      type: object
      required:
        - error
        - request_id
      properties:
        error:
          type: object
          required:
            - code
            - message
          properties:
            code:
              type: string
              enum:
                - invalid_token
                - insufficient_scope
                - upgrade_required
                - quota_exceeded
                - resource_not_found
                - domain_taken
                - alias_taken
                - external_id_taken
                - folder_name_taken
                - tag_name_taken
                - pixel_name_taken
                - biolink_name_taken
                - method_not_allowed
                - url_blocked
                - dns_verification_failed
                - validation_error
                - rate_limit_exceeded
                - internal_server_error
            message:
              type: string
            details:
              type: object
              additionalProperties: true
        request_id:
          type: string
          description: Request identifier to include when contacting support.
    QrPayload:
      type: object
      additionalProperties: false
      description: >-
        Fields must match content_type. See Create a QR code for required
        combinations.
      properties:
        long_url:
          type: string
        text:
          type: string
          maxLength: 300
        phone:
          type: string
          maxLength: 80
        message:
          type: string
          maxLength: 2000
        ssid:
          type: string
          maxLength: 255
        encryption:
          type: string
          enum:
            - none
            - WEP
            - WPA
            - WPA2
            - WPA3
        password:
          type: string
          maxLength: 255
        first_name:
          type: string
          maxLength: 100
        last_name:
          type: string
          maxLength: 100
        organization:
          type: string
          maxLength: 255
        fax:
          type: string
          maxLength: 80
        email:
          type: string
          format: email
          maxLength: 255
        subject:
          type: string
          maxLength: 255
        website:
          type: string
          maxLength: 255
        socials:
          $ref: '#/components/schemas/QrSocials'
        title:
          type: string
          maxLength: 255
        description:
          type: string
          maxLength: 2000
        location:
          type: string
          maxLength: 1000
        url:
          type: string
          format: uri
          maxLength: 1000
        start:
          type: string
          format: date-time
        end:
          type: string
          format: date-time
        app_store_url:
          type: string
          format: uri
          maxLength: 1000
        google_play_url:
          type: string
          format: uri
          maxLength: 1000
        fallback_url:
          type: string
          format: uri
          maxLength: 1000
    QrConfig:
      type: object
      additionalProperties: false
      description: >-
        Public QR design. applyGradientToAll gives the matrix gradient
        precedence over both eye sections. Otherwise applyEyeFrameGradientToEye
        gives the eye-frame gradient precedence over the eye center. Custom
        logos are not supported.
      properties:
        matrixColor:
          type: string
          pattern: ^#[0-9A-Fa-f]{6}$
        eyeFrameColor:
          type: string
          pattern: ^#[0-9A-Fa-f]{6}$
        eyeColor:
          type: string
          pattern: ^#[0-9A-Fa-f]{6}$
        matrixColorMode:
          type: string
          enum:
            - flat
            - gradient
        matrixGradient:
          $ref: '#/components/schemas/QrGradient'
        eyeFrameColorMode:
          type: string
          enum:
            - flat
            - gradient
        eyeFrameGradient:
          $ref: '#/components/schemas/QrGradient'
        eyeColorMode:
          type: string
          enum:
            - flat
            - gradient
        eyeGradient:
          $ref: '#/components/schemas/QrGradient'
        applyGradientToAll:
          type: boolean
          description: >-
            Requires matrixColorMode=gradient. When true, matrixGradient renders
            the matrix, eye frames, and eye centers.
        applyEyeFrameGradientToEye:
          type: boolean
          description: >-
            Requires eyeFrameColorMode=gradient. When true and
            applyGradientToAll is false, eyeFrameGradient renders the eye frames
            and eye centers.
        matrixStyle:
          type: string
          enum:
            - square
            - dots
            - organic
            - vertical-pills
            - horizontal-pills
        eyeFrameStyle:
          type: string
          enum:
            - square
            - rounded-square
            - circle
        eyeStyle:
          type: string
          enum:
            - square
            - rounded-square
            - circle
            - diamond
        showLogo:
          type: boolean
          description: Shows the default Biqli logo. Hiding it requires plan access.
    PublicRule:
      type: object
      additionalProperties: false
      required:
        - key
        - value
      properties:
        key:
          type: string
          maxLength: 250
        value:
          type: string
          maxLength: 1000
    PublicIdList:
      type: array
      maxItems: 100
      uniqueItems: true
      items:
        type: string
    QrSocials:
      type: object
      additionalProperties: false
      properties:
        youtube:
          type: string
          maxLength: 1000
        x:
          type: string
          maxLength: 1000
        instagram:
          type: string
          maxLength: 1000
        tiktok:
          type: string
          maxLength: 1000
        linkedin:
          type: string
          maxLength: 1000
    QrGradient:
      type: object
      additionalProperties: false
      required:
        - colorOne
        - colorTwo
        - angle
        - midpoint
      properties:
        colorOne:
          type: string
          pattern: ^#[0-9A-Fa-f]{6}$
          examples:
            - '#214687'
        colorTwo:
          type: string
          pattern: ^#[0-9A-Fa-f]{6}$
          examples:
            - '#44C8DE'
        angle:
          type: string
          enum:
            - 0deg
            - 45deg
            - 90deg
            - 135deg
            - 180deg
            - 225deg
            - 270deg
            - 315deg
        midpoint:
          type: integer
          minimum: 5
          maximum: 95
  responses:
    Unauthorized:
      $ref: '#/components/responses/ApiErrorResponse'
      description: The workspace API key is missing, invalid, or revoked.
    Forbidden:
      $ref: '#/components/responses/ApiErrorResponse'
      description: >-
        The key lacks a required scope, the workspace must upgrade, or its quota
        is exhausted.
    NotFound:
      $ref: '#/components/responses/ApiErrorResponse'
      description: >-
        The requested resource or referenced public ID is unavailable in the
        key's workspace.
    UnprocessableEntity:
      $ref: '#/components/responses/ApiErrorResponse'
      description: >-
        The payload is invalid, a destination was blocked, or domain DNS
        verification is not ready.
    RateLimited:
      description: The workspace exceeded its plan's API rate limit.
      headers:
        RateLimit-Policy:
          description: Current IETF HTTPAPI quota policy as a structured field.
          schema:
            type: string
            example: '"workspace-api";q=1000;w=60'
        RateLimit:
          description: Current IETF HTTPAPI service limit as a structured field.
          schema:
            type: string
            example: '"workspace-api";r=0;t=17'
        Retry-After:
          description: Seconds to wait before retrying the request.
          schema:
            type: integer
            minimum: 0
            example: 17
        X-RateLimit-Limit:
          description: Legacy maximum request count for the current window.
          schema:
            type: integer
            minimum: 1
            example: 1000
        X-RateLimit-Remaining:
          description: Legacy remaining request count.
          schema:
            type: integer
            minimum: 0
            example: 0
        X-RateLimit-Reset:
          description: Legacy reset time as a UTC Unix timestamp.
          schema:
            type: integer
            format: int64
            example: 1788126519
        X-Biq-Request-Id:
          description: Request identifier for support and tracing.
          schema:
            type: string
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ApiError'
    InternalError:
      $ref: '#/components/responses/ApiErrorResponse'
      description: The request failed unexpectedly.
    ApiErrorResponse:
      description: API error.
      headers:
        X-Biq-Request-Id:
          description: Request identifier for support and tracing.
          schema:
            type: string
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ApiError'
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: Workspace API key
      description: A workspace API key beginning with biqli_.

````