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

# Update a collection

> Updates a collection. Send `position` to reorder it within the flat list; send the full `rules` set to sync automatic rules.

**Required scope:** `write_collections` (for API-key authentication).



## OpenAPI

````yaml /api-reference/admin.yaml patch /api/v3/admin/collections/{id}
openapi: 3.0.3
info:
  title: Admin API
  contact:
    name: Spree Commerce
    url: https://spreecommerce.org
    email: hello@spreecommerce.org
  description: >
    Spree Admin API v3 - Administrative API for managing products, orders, and
    store settings.


    ## Authentication


    The Admin API requires a secret API key passed in the `x-spree-api-key`
    header.

    Secret API keys can be generated in the Spree admin dashboard.


    ## Response Format


    All responses are JSON. List endpoints return paginated responses with
    `data` and `meta` keys.

    Single resource endpoints return a flat JSON object.


    ## Resource IDs


    Every resource is identified by an opaque string ID (e.g. `prod_86Rf07xd4z`,

    `variant_k5nR8xLq`, `or_UkLWZg9DAJ`). Use these IDs everywhere — URL paths,

    request bodies, and Ransack filters all accept them directly.


    ## Error Handling


    Errors return a consistent format:

    ```json

    {
      "error": {
        "code": "validation_error",
        "message": "Validation failed",
        "details": { "name": ["can't be blank"] }
      }
    }

    ```
  version: v3
servers:
  - url: http://{defaultHost}
    variables:
      defaultHost:
        default: localhost:3000
security: []
tags:
  - name: Authentication
    description: Admin user login, logout, token refresh, and current user profile
  - name: Allowed Origins
    description: CORS allowlist for storefront and admin client origins
  - name: API Keys
    description: Secret and publishable API keys
  - name: Categories
    description: >-
      Hierarchical product categories — tree management, repositioning, and
      product assignments
  - name: Channels
    description: >-
      Sales channels, product publication across channels, and per-channel order
      routing rules
  - name: Custom Fields
    description: >-
      Custom field definitions for products, variants, customers, and other
      resources
  - name: Customer Groups
    description: >-
      Customer groups for segmenting customers (e.g. wholesale, VIP) used by
      pricing and promotions
  - name: Customers
    description: Customer profiles, addresses, credit cards, and store credits
  - name: Email Templates
    description: >-
      Customer email templates, the email layout and shared partials: drafts,
      previews, publishing and history
  - name: Exports
    description: Async CSV exports of admin resources
  - name: Files
    description: Uploading the files that product media, imports, logos and documents use
  - name: Fulfillments
    description: Order fulfillments — shipments, fulfill, cancel, resume, split
  - name: Gift Cards
    description: Gift cards and gift card batches
  - name: Imports
    description: >-
      Async CSV imports of admin resources, with per-row status and failed-row
      retry
  - name: Markets
    description: >-
      Markets — geographic groupings of countries used for pricing, tax, and
      fulfillment rules
  - name: Option Types
    description: >-
      Option types and option values used to build product variants (e.g. Size,
      Color)
  - name: Orders
    description: Orders, order items, applied gift cards, and applied store credits
  - name: Payment Methods
    description: Configured payment providers and their available types
  - name: Payments
    description: Order payments — list, capture, void
  - name: Pricing
    description: >-
      Prices and price lists for currency-, market-, and customer-group-specific
      pricing
  - name: Products
    description: >-
      Products, taxons/categories, product custom field values, and bulk product
      operations
  - name: Policies
    description: The store's legal documents — terms of service, privacy, returns, shipping
  - name: Reasons
    description: >-
      Merchant-owned vocabularies for why a return, claim, refund, cancellation
      or tax exemption happened
  - name: Promotions
    description: Promotions, promotion rules, promotion actions, and coupon codes
  - name: Refunds
    description: Order refunds
  - name: Settings
    description: Store-level settings — store profile, tags, and configuration
  - name: Staff
    description: Admin users, roles, and invitations to the store
  - name: Stock Locations
    description: Warehouses and physical fulfillment locations
  - name: Store Credits
    description: Prepaid customer balances across all customers, and each balance's ledger
  - name: Variants
    description: >-
      Product variants — the individual SKUs (size/color combinations) sold
      under a product
  - name: Webhooks
    description: Webhook endpoints and webhook delivery history
paths:
  /api/v3/admin/collections/{id}:
    patch:
      tags:
        - Collections
      summary: Update a collection
      description: >-
        Updates a collection. Send `position` to reorder it within the flat
        list; send the full `rules` set to sync automatic rules.


        **Required scope:** `write_collections` (for API-key authentication).
      parameters:
        - name: x-spree-api-key
          in: header
          required: true
          schema:
            type: string
        - name: Authorization
          in: header
          required: true
          description: Bearer token for admin authentication
          schema:
            type: string
        - name: id
          in: path
          required: true
          description: Collection ID
          schema:
            type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CollectionUpdateParams'
        required: true
      responses:
        '200':
          description: collection updated
          content:
            application/json:
              example:
                id: coll_UkLWZg9DAJ
                name: Winter Sale
                permalink: summer-sale
                position: 1
                sort_order: manual
                meta_title: null
                meta_description: null
                meta_keywords: null
                products_count: 0
                description: ''
                description_html: ''
                image_url: null
                square_image_url: null
                automatic: false
                rules_match_policy: all
                metadata: {}
                created_at: '2026-01-15T12:00:00.000Z'
                updated_at: '2026-01-15T12:00:00.000Z'
              schema:
                $ref: '#/components/schemas/Collection'
      security:
        - api_key: []
          bearer_auth: []
      x-codeSamples:
        - lang: javascript
          label: Spree Admin SDK
          source: >-
            import { createAdminClient } from '@spree/admin-sdk'


            const client = createAdminClient({
              baseUrl: 'https://your-store.com',
              secretKey: 'sk_xxx',
            })


            const collection = await
            client.collections.update('coll_UkLWZg9DAJ', {
              name: 'Winter Sale',
            })
        - lang: bash
          label: Spree CLI
          source: spree api patch /collections/{id} -d '{"name":"Winter Sale"}'
components:
  schemas:
    CollectionUpdateParams:
      type: object
      properties:
        name:
          type: string
          example: On Sale
        description:
          type: string
          description: >-
            Rich text HTML. Reads come back as this (plain text) plus
            `description_html`.
        permalink:
          type: string
        position:
          type: integer
          description: >-
            1-based position among the store's collections; the server shifts
            its siblings. The nested products reposition endpoints, unlike this,
            take 0-based indexes.
        meta_title:
          type: string
        meta_description:
          type: string
        meta_keywords:
          type: string
        image_signed_id:
          type: string
          description: >-
            A `signed_id` from `files.upload()` for the landscape image, or null
            to remove it.
          nullable: true
        square_image_signed_id:
          type: string
          description: >-
            A `signed_id` from `files.upload()` for the square image, or null to
            remove it.
          nullable: true
        automatic:
          type: boolean
          description: >-
            When true, membership is materialized from `rules` instead of
            curated by hand.
        rules_match_policy:
          type: string
          enum:
            - all
            - any
          description: >-
            Whether a product must match all rules or any of them. Defaults to
            `all`.
        sort_order:
          type: string
          enum:
            - manual
            - best_selling
            - price asc
            - price desc
            - available_on desc
            - available_on asc
            - name asc
            - name desc
          description: >-
            Default product sort for the storefront listing; a shopper's own
            sort wins. Defaults to `manual`.
        rules:
          type: array
          items:
            $ref: '#/components/schemas/CollectionRuleParams'
          description: >-
            The complete desired rule set. Entries with an `id` update, entries
            without one are created, and existing rules left out are removed.
        custom_fields:
          type: array
          items:
            $ref: '#/components/schemas/CustomFieldValueParams'
          description: Custom field values, each validated against its definition.
    Collection:
      type: object
      properties:
        id:
          type: string
        name:
          type: string
        permalink:
          type: string
        position:
          type: number
        sort_order:
          type: string
          enum:
            - manual
            - best_selling
            - price asc
            - price desc
            - available_on desc
            - available_on asc
            - name asc
            - name desc
        meta_title:
          type: string
          nullable: true
        meta_description:
          type: string
          nullable: true
        meta_keywords:
          type: string
          nullable: true
        products_count:
          type: number
        description:
          type: string
        description_html:
          type: string
        image_url:
          type: string
          nullable: true
        square_image_url:
          type: string
          nullable: true
        custom_fields:
          type: array
          items:
            $ref: '#/components/schemas/CustomField'
        translations:
          type: object
        automatic:
          type: boolean
        rules_match_policy:
          type: string
          enum:
            - all
            - any
        metadata:
          type: object
        created_at:
          type: string
        updated_at:
          type: string
        rules:
          type: array
          items:
            $ref: '#/components/schemas/CollectionRule'
      required:
        - id
        - name
        - permalink
        - position
        - sort_order
        - meta_title
        - meta_description
        - meta_keywords
        - products_count
        - description
        - description_html
        - image_url
        - square_image_url
        - automatic
        - rules_match_policy
        - metadata
        - created_at
        - updated_at
      x-typelizer: true
    CollectionRuleParams:
      type: object
      properties:
        id:
          type: string
          description: Omit to create a new rule.
          example: crule_abc123
        type:
          type: string
          description: >-
            Wire shorthand for the rule kind, from the collection rule types
            endpoint.
          example: tag
        value:
          type: string
          example: summer
        match_policy:
          type: string
          enum:
            - is_equal_to
            - is_not_equal_to
            - contains
            - does_not_contain
          example: contains
    CustomFieldValueParams:
      type: object
      properties:
        id:
          type: string
        custom_field_definition_id:
          type: string
        value:
          description: >-
            A scalar for text, number and boolean fields; a list or a hash for
            JSON fields.
    CustomField:
      type: object
      properties:
        id:
          type: string
        label:
          type: string
        field_type:
          type: string
          enum:
            - short_text
            - long_text
            - rich_text
            - number
            - boolean
            - json
        key:
          type: string
        value: {}
        created_at:
          type: string
        updated_at:
          type: string
        storefront_visible:
          type: boolean
        custom_field_definition_id:
          type: string
      required:
        - id
        - label
        - field_type
        - key
        - value
        - created_at
        - updated_at
        - storefront_visible
        - custom_field_definition_id
      x-typelizer: true
    CollectionRule:
      type: object
      properties:
        id:
          type: string
        value:
          type: string
          nullable: true
        match_policy:
          type: string
          enum:
            - is_equal_to
            - is_not_equal_to
            - contains
            - does_not_contain
        type:
          type: string
          description: >-
            Rule type. Built-in: tag, available_on, sale. Extensions may
            register more.
      required:
        - id
        - value
        - match_policy
        - type
      x-typelizer: true
  securitySchemes:
    api_key:
      type: apiKey
      name: x-spree-api-key
      in: header
      description: Secret API key for admin access
    bearer_auth:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: JWT token for admin user authentication

````

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