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

# Update a catalog product

> Updates a merchant-scoped catalog product name and description. Requires idempotency key and `catalog.manage` capability.



## OpenAPI

````yaml /openapi.json put /catalog/products/{productId}
openapi: 3.0.0
info:
  title: PayGood Merchant API
  description: Server-to-server integration surface for merchant API keys.
  version: '1.0'
  contact: {}
servers:
  - url: https://api-sandbox.paygood.co
    description: Sandbox
  - url: https://api.paygood.co
    description: Production
security: []
paths:
  /catalog/products/{productId}:
    put:
      tags:
        - catalog-products
      summary: Update a catalog product
      description: >-
        Updates a merchant-scoped catalog product name and description. Requires
        idempotency key and `catalog.manage` capability.
      operationId: CatalogProductsController_update
      parameters:
        - name: productId
          required: true
          in: path
          description: Product TypeID (`prod_...`) to update.
          schema:
            type: string
      requestBody:
        required: true
        description: >-
          Update payload with idempotency key, merchant scope, product name, and
          optional description.
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateProductDto'
      responses:
        '200':
          description: Updated product in canonical response shape.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProductResponseDto'
        '400':
          description: Invalid payload (TypeID, name, or idempotency key shape).
        '401':
          description: Missing or invalid bearer token.
        '403':
          description: >-
            Caller is authenticated but lacks `catalog.manage` capability for
            this merchant.
        '404':
          description: No product exists for the provided merchant and product id.
      security:
        - bearer: []
components:
  schemas:
    UpdateProductDto:
      type: object
      properties:
        idempotencyKey:
          type: string
          minLength: 1
        merchantId:
          type: string
        name:
          type: string
          minLength: 1
        description:
          type: string
          nullable: true
      required:
        - idempotencyKey
        - merchantId
        - name
    ProductResponseDto:
      type: object
      properties:
        productId:
          type: string
        merchantId:
          type: string
        name:
          type: string
          minLength: 1
        description:
          type: string
        status:
          type: string
          enum:
            - active
            - inactive
        active:
          type: boolean
        createdAt:
          type: string
          format: date-time
          pattern: >-
            ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$
      required:
        - productId
        - merchantId
        - name
        - status
        - active
        - createdAt
  securitySchemes:
    bearer:
      scheme: bearer
      bearerFormat: merchant_<prefix>_<secret>
      type: http
      description: >-
        Merchant API key bearer token. Legacy wire prefixes `api_key_` and
        `api_` are also accepted.

````