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

# Update Promotion

> Update promotion fields (name, discount, schedule, status, stores). Requires `promotions:write`.



## OpenAPI

````yaml /openapi.json patch /api/v1/promotions/{promotionId}
openapi: 3.1.0
info:
  title: OmniCommerce API
  version: 1.0.0
  license:
    name: Proprietary
    url: https://omnicommerce.sg/terms
  description: >-
    OmniCommerce API surface for agents and developer integrations. Includes
    public endpoints (merchant discovery, product search, compare, catalog, ACO
    retrieval) and authenticated endpoints (product management via API key
    Bearer tokens).
servers:
  - url: https://omnicommerce.sg
    description: Production
  - url: http://localhost:3000
    description: Local development
security: []
tags:
  - name: agentic-checkout
    description: Merchant-fulfilled agentic checkout
    x-group: Agentic Checkout
  - name: commerce
    description: Root commerce discovery
    x-group: Commerce
  - name: developer-platform
    description: Authenticated developer platform APIs
    x-group: Developer Platform
  - name: looks
    description: AI-styled product looks
    x-group: Looks
  - name: oauth
    description: OAuth token endpoints
    x-group: OAuth
  - name: orders
    description: Workspace and agentic orders
    x-group: Orders
  - name: organizations
    description: Organization management
    x-group: Organizations
  - name: price-books
    description: Marketplace list-price markup rules
    x-group: Price Books
  - name: products
    description: Product CRUD, bulk import, and publish
    x-group: Products
  - name: promotions
    description: Central promotions and marketplace sync
    x-group: Promotions
  - name: public-agent
    description: Public agent discovery and catalog APIs
    x-group: Public Agent
  - name: settlements
    description: settlements
    x-group: Settlements
  - name: ucp
    description: Universal Commerce Protocol
    x-group: UCP
paths:
  /api/v1/promotions/{promotionId}:
    patch:
      tags:
        - promotions
      summary: Update Promotion
      description: >-
        Update promotion fields (name, discount, schedule, status, stores).
        Requires `promotions:write`.
      operationId: patch_v1_promotions_by_promotionid
      parameters:
        - name: promotionId
          in: path
          required: true
          schema:
            type: string
        - name: organizationId
          in: query
          required: false
          description: >-
            Optional organization scope for session-authenticated calls. OAuth
            client credentials resolve the organization from the token.
          schema:
            type: string
            maxLength: 120
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              additionalProperties: false
              properties:
                organizationId:
                  type: string
                  maxLength: 120
                name:
                  type: string
                  maxLength: 200
                description:
                  type:
                    - string
                    - 'null'
                  maxLength: 2000
                discountType:
                  type: string
                  enum:
                    - percentage
                    - fixed_amount
                discountValue:
                  type: number
                  minimum: 0
                  description: Positive discount amount or percentage (must be > 0).
                storeKeys:
                  type: array
                  items:
                    type: string
                  minItems: 1
                startsAt:
                  type:
                    - string
                    - 'null'
                  format: date-time
                endsAt:
                  type:
                    - string
                    - 'null'
                  format: date-time
                status:
                  type: string
                  enum:
                    - draft
                    - scheduled
                    - active
                    - paused
                    - ended
                    - archived
                minSalePrice:
                  type:
                    - number
                    - 'null'
                  minimum: 0
                maxDiscountAmount:
                  type:
                    - number
                    - 'null'
                  minimum: 0
                minSpend:
                  type:
                    - number
                    - 'null'
                  minimum: 0
      responses:
        '200':
          description: Promotion updated.
          content:
            application/json:
              schema:
                type: object
                required:
                  - promotion
                properties:
                  promotion:
                    type: object
        '400':
          description: Bad Request
        '401':
          description: Unauthorized
        '403':
          description: Forbidden or missing `promotions:write` scope
        '404':
          description: Promotion not found
        '500':
          description: Internal Server Error
      security:
        - bearerAuth: []
components:
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: API Key
      description: >-
        Bearer API key for server-to-server access. Session auth is also
        supported in first-party UI flows.

````