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

# Patch item

> Update an existing catalog item using the compatibility PATCH method.



## OpenAPI

````yaml PATCH /v1/items/{item_id}
openapi: 3.0.3
info:
  title: NeuronSearchLab Core API
  version: 1.0.0
  description: >-
    Versioned data-plane API for OAuth token exchange, catalog item ingestion,
    user event ingestion, and recommendation serving.
  license:
    name: Proprietary
    url: https://neuronsearchlab.com
servers:
  - url: https://api.neuronsearchlab.com
    description: Core API Gateway custom domain
security:
  - oauth2: []
tags:
  - name: Authentication
    description: OAuth 2.0 client credentials token exchange.
  - name: Items
    description: Catalog item ingestion, lookup, update, deletion, and pagination.
  - name: Events
    description: User interaction event ingestion, lookup, and pagination.
  - name: Recommendations
    description: >-
      Personalized recommendation serving, request-scoped filtering, and
      auto-section generation.
  - name: Search
    description: Query-driven search serving through the Core API data plane.
  - name: CORS
    description: Browser preflight routes generated by API Gateway.
paths:
  /v1/items/{item_id}:
    patch:
      tags:
        - Items
      summary: Patch item
      description: >-
        Compatibility alias for partially updating an existing catalog item. It
        accepts the same body and returns the same response as `POST
        /v1/items/{item_id}`.
      operationId: patchItem
      parameters:
        - $ref: '#/components/parameters/ItemId'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ItemUpdate'
            examples:
              update:
                $ref: '#/components/examples/ItemUpdate'
      responses:
        '200':
          description: Updated item
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Item'
              examples:
                item:
                  $ref: '#/components/examples/Item'
        '400':
          $ref: '#/components/responses/Error400'
        '401':
          $ref: '#/components/responses/Error401'
        '403':
          $ref: '#/components/responses/Error403'
        '404':
          $ref: '#/components/responses/Error404'
        '500':
          $ref: '#/components/responses/Error500'
      security:
        - oauth2:
            - neuronsearchlab-api/write
components:
  parameters:
    ItemId:
      name: item_id
      in: path
      required: true
      description: Public item ID.
      schema:
        type: string
        pattern: ^[A-Za-z0-9][A-Za-z0-9_-]{0,127}$
      example: 7f3a2c9e
  schemas:
    ItemUpdate:
      type: object
      description: Partial item update. At least one field must be supplied.
      minProperties: 1
      properties:
        name:
          type: string
          minLength: 1
        description:
          type: string
        metadata:
          $ref: '#/components/schemas/Metadata'
        active:
          type: boolean
          description: Whether the item is eligible for recommendations.
      additionalProperties: false
    Item:
      type: object
      required:
        - id
        - object
        - name
        - description
        - metadata
        - active
        - created
        - updated_at
      properties:
        id:
          type: string
          pattern: ^[A-Za-z0-9][A-Za-z0-9_-]{0,127}$
          example: 7f3a2c9e
        object:
          type: string
          enum:
            - item
        name:
          type: string
          example: Wireless Headphones
        description:
          type: string
          example: Noise-cancelling Bluetooth headphones.
        metadata:
          $ref: '#/components/schemas/Metadata'
        active:
          type: boolean
          example: true
        created:
          type: integer
          format: int64
          nullable: true
          description: Unix timestamp in seconds.
          example: 1777478400
        updated_at:
          type: integer
          format: int64
          nullable: true
          description: Unix timestamp in seconds.
          example: 1777478500
    Metadata:
      type: object
      description: Arbitrary JSON object used for filtering, ranking, and debugging.
      additionalProperties: true
      example:
        category: electronics
        brand: Acme
        price: 10999
        currency: usd
    ErrorResponse:
      type: object
      required:
        - error
      properties:
        error:
          type: object
          required:
            - type
            - code
            - message
          properties:
            type:
              type: string
              enum:
                - invalid_request_error
                - authentication_error
                - permission_error
                - not_found_error
                - conflict_error
                - rate_limit_error
                - api_error
            code:
              type: string
            message:
              type: string
            details: {}
            request_id:
              type: string
              format: uuid
          additionalProperties: true
  examples:
    ItemUpdate:
      summary: Update item fields
      value:
        name: Wireless Headphones v2
        metadata:
          category: electronics
          availability: in_stock
        active: true
    Item:
      summary: Item
      value:
        id: 7f3a2c9e
        object: item
        name: Wireless Headphones
        description: Noise-cancelling Bluetooth headphones.
        metadata:
          category: electronics
          brand: Acme
        active: true
        created: 1777478400
        updated_at: 1777478500
    ErrorValidation:
      summary: Validation error
      value:
        error:
          type: invalid_request_error
          code: validation_error
          message: Validation error
          details:
            fieldErrors:
              name:
                - Required
    ErrorUnauthorized:
      summary: Unauthorized
      value:
        error:
          type: authentication_error
          code: unauthorized_no_client_id_in_jwt
          message: 'Unauthorized: No client ID in JWT'
    ErrorNotFound:
      summary: Not found
      value:
        error:
          type: not_found_error
          code: item_not_found
          message: Item not found
  responses:
    Error400:
      description: Invalid request
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
          examples:
            validation:
              $ref: '#/components/examples/ErrorValidation'
    Error401:
      description: Unauthenticated
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
          examples:
            unauthorized:
              $ref: '#/components/examples/ErrorUnauthorized'
    Error403:
      description: Forbidden
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
    Error404:
      description: Not found
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
          examples:
            notFound:
              $ref: '#/components/examples/ErrorNotFound'
    Error500:
      description: Server error
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
  securitySchemes:
    oauth2:
      type: oauth2
      flows:
        clientCredentials:
          tokenUrl: https://auth.neuronsearchlab.com/oauth2/token
          scopes:
            neuronsearchlab-api/read: Read recommendations, items, and events.
            neuronsearchlab-api/write: Create, update, and delete items; submit events.

````