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

# Update a custom checkout link

> Updates the details of an existing custom checkout link.

- **Request Headers:**
  - `x-store-id` (string, required): The ID of the store performing the update.

- **Path Parameters:**
  - `id` (string, required): ID of the checkout link.

- **Request Body:**
  - `name` (string, optional): New name for the checkout link.
  - `design` (object, optional): Updated design details.
  - `status` (string, optional): New status for the checkout link.

- **Response:** The updated checkout link details.

Enables store managers to modify checkout experiences for better customer engagement.



## OpenAPI

````yaml /api-reference/blink-api.json patch /checkout-links/{id}
openapi: 3.0.0
info:
  title: Blink API
  description: Comprehensive API documentation for Blink.
  version: 1.0.0
servers:
  - url: https://api.blink.store/v1
security:
  - storeIdHeader: []
tags:
  - name: Invoices
    description: Unified merchant of record invoices for products and subscriptions.
  - name: Geo Pricing
    description: Resolve Purchasing Power Parity (PPP) localized pricing.
paths:
  /checkout-links/{id}:
    patch:
      tags:
        - Checkouts
      summary: Update a custom checkout link
      description: >-
        Updates the details of an existing custom checkout link.


        - **Request Headers:**
          - `x-store-id` (string, required): The ID of the store performing the update.

        - **Path Parameters:**
          - `id` (string, required): ID of the checkout link.

        - **Request Body:**
          - `name` (string, optional): New name for the checkout link.
          - `design` (object, optional): Updated design details.
          - `status` (string, optional): New status for the checkout link.

        - **Response:** The updated checkout link details.


        Enables store managers to modify checkout experiences for better
        customer engagement.
      parameters:
        - name: id
          in: path
          required: true
          schema:
            type: string
          description: ID of the checkout link.
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateCheckoutLinkRequest'
      responses:
        '200':
          description: Checkout link updated successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CheckoutLinkDetails'
        '400':
          description: Invalid fields provided for update.
        '404':
          description: Checkout Link not found.
      security:
        - storeIdHeader: []
components:
  schemas:
    UpdateCheckoutLinkRequest:
      type: object
      properties:
        name:
          type: string
        design:
          $ref: '#/components/schemas/CheckoutDesign'
        status:
          type: string
    CheckoutLinkDetails:
      type: object
      properties:
        id:
          type: string
        store_id:
          type: string
        name:
          type: string
        design:
          $ref: '#/components/schemas/CheckoutDesign'
        status:
          type: string
        views:
          type: integer
        sales:
          type: integer
        created_at:
          type: string
          format: date-time
    CheckoutDesign:
      type: object
      description: >-
        Configuration for the visual layout, display options, and colors of a
        custom checkout.
      properties:
        layout:
          type: string
          enum:
            - classic
            - overlay
            - inline
            - split
            - minimal
          description: >-
            The overall layout structure of the checkout page. `classic` is
            standard, `overlay` highlights product imagery, `inline` embeds the
            form, `split` divides into two columns, and `minimal` removes all
            distractions.
        display_options:
          type: object
          properties:
            preview_button:
              type: boolean
              description: Show a preview button next to the product title.
            discount_code:
              type: boolean
              description: Show a discount input field at checkout.
            refund_policy:
              type: boolean
              description: Display a refund policy link in the footer.
        override_theme:
          type: boolean
          description: >-
            If true, ignores the global store theme and uses the custom colors
            defined below.
        colors:
          type: object
          properties:
            button:
              type: string
              description: Primary button color.
            button_hover:
              type: string
              description: Button color when hovered.
            button_text:
              type: string
              description: Text color inside buttons.
            button_text_hover:
              type: string
              description: Text color when hovering over buttons.
            link:
              type: string
              description: Color for clickable links.
            checkbox:
              type: string
              description: Color of variants checkbox.
            selection_border:
              type: string
              description: Border color for selected variants/methods.
            selection_background:
              type: string
              description: Background color for selected states.
  securitySchemes:
    storeIdHeader:
      type: apiKey
      in: header
      name: x-store-id

````