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

# Update Script

> Update metadata, approval mode, or draft source. Saving source does not change the active immutable deployment. Requires scripts:write.



## OpenAPI

````yaml /openapi.json patch /api/v1/scripts/{scriptId}
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: agents
    description: agents
    x-group: Agents
  - name: analytics
    description: Sales performance across marketplaces
    x-group: Analytics
  - name: aops
    description: Agent operating procedures
    x-group: AOPs
  - name: branding
    description: branding
    x-group: Branding
  - name: campaigns
    description: Campaign briefs, offer windows, and marketplace runs
    x-group: Campaigns
  - name: commerce
    description: commerce
    x-group: Commerce
  - name: developer-platform
    description: Authenticated developer platform APIs
    x-group: Developer Platform
  - name: documents
    description: Knowledge base document uploads
    x-group: Knowledge Base
  - name: inventory
    description: Inventory quantities, planning signals, and marketplace listing absence
    x-group: Inventory
  - 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, enrichment, publish, and delist
    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: returns
    description: returns
    x-group: Returns
  - name: reviews
    description: Marketplace product reviews and seller replies
    x-group: Reviews
  - name: scripts
    description: scripts
    x-group: Scripts
  - name: settlements
    description: settlements
    x-group: Settlements
  - name: ucp
    description: Universal Commerce Protocol
    x-group: UCP
paths:
  /api/v1/scripts/{scriptId}:
    patch:
      tags:
        - scripts
      summary: Update Script
      description: >-
        Update metadata, approval mode, or draft source. Saving source does not
        change the active immutable deployment. Requires scripts:write.
      operationId: patch_v1_scripts_by_scriptid
      parameters:
        - name: scriptId
          in: path
          required: true
          schema:
            type: string
            format: uuid
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                organizationId:
                  type: string
                  minLength: 1
                title:
                  type: string
                  maxLength: 120
                description:
                  type: string
                  maxLength: 500
                approvalMode:
                  type: string
                  enum:
                    - no_approval
                    - required_with_override
                    - required_no_override
                source:
                  type: string
              additionalProperties: false
      responses:
        '200':
          description: Script result.
          content:
            application/json:
              schema:
                type: object
                properties:
                  script:
                    $ref: '#/components/schemas/OrganizationScript'
                required:
                  - script
        '400':
          description: Invalid request, arguments, or deployment.
        '401':
          description: Missing or invalid credentials.
        '403':
          description: Missing script scope, organization capability, or Scripts feature.
        '404':
          description: Script not found in this organization.
        '429':
          description: Rate limit exceeded.
      security:
        - bearerAuth: []
components:
  schemas:
    OrganizationScript:
      type: object
      properties:
        id:
          type: string
        organizationId:
          type: string
        slug:
          type: string
        toolName:
          type: string
        title:
          type: string
        description:
          type: string
        kind:
          type: string
          enum:
            - general
            - source_adapter
        windmillPath:
          type: string
        approvalMode:
          type: string
          enum:
            - no_approval
            - required_with_override
            - required_no_override
        isActive:
          type: boolean
        archivedAt:
          anyOf:
            - type: string
            - type: 'null'
        activeVersionId:
          anyOf:
            - type: string
            - type: 'null'
        createdByUserId:
          type: string
        updatedByUserId:
          type: string
        createdAt:
          type: string
        updatedAt:
          type: string
      required:
        - id
        - organizationId
        - slug
        - toolName
        - title
        - description
        - kind
        - windmillPath
        - approvalMode
        - isActive
        - archivedAt
        - activeVersionId
        - createdByUserId
        - updatedByUserId
        - createdAt
        - updatedAt
  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.

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.