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

# Change the multi-store group's settings

> Sets the toggles present in the body for `merchant_id`'s whole group and returns the resulting settings. Side effects: enabling auto_replicate_enabled makes the caller the replication source (if none is recorded) and stamps existing links to replicate from it; enabling sync_publish_status publishes every replica whose source is live and syncs those stores back to Shopify. Switching a toggle from off to on requires multi-store in the plan (402 otherwise); re-sending an unchanged toggle or switching one off never does.



## OpenAPI

````yaml /api-reference/openapi/lite.json put /multi-store/group-settings/{merchant_id}
openapi: 3.1.0
info:
  title: Search & Merchandising API
  version: 1.0.0
  description: >-
    REST API behind Depict: Search & Merchandising, the native Shopify app:
    onboarding, collections, boost & bury, dashboards, A/B testing and
    multi-store management. Endpoints are served under the /api/lite prefix and
    are authenticated with the Shopify session token that App Bridge issues to
    the embedded app.
servers:
  - url: /api/lite
security:
  - ShopifySessionToken: []
paths:
  /multi-store/group-settings/{merchant_id}:
    put:
      summary: Change the multi-store group's settings
      description: >-
        Sets the toggles present in the body for `merchant_id`'s whole group and
        returns the resulting settings. Side effects: enabling
        auto_replicate_enabled makes the caller the replication source (if none
        is recorded) and stamps existing links to replicate from it; enabling
        sync_publish_status publishes every replica whose source is live and
        syncs those stores back to Shopify. Switching a toggle from off to on
        requires multi-store in the plan (402 otherwise); re-sending an
        unchanged toggle or switching one off never does.
      operationId: multiStoreGroupSettingsUpdate
      parameters:
        - schema:
            type: string
            description: Lite merchant id, e.g. `shopify-<shop id>`.
          required: true
          description: Lite merchant id, e.g. `shopify-<shop id>`.
          name: merchant_id
          in: path
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/LiteMultiStoreGroupSettingsUpdate'
      responses:
        '200':
          description: The group's settings after the change.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/LiteMultiStoreGroupSettingsDto'
        '400':
          description: >-
            The body failed the schema or is not JSON, or `error_code:
            NOT_IN_GROUP`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  detail:
                    type: string
                  error_code:
                    type: string
                    enum:
                      - NOT_IN_GROUP
                required:
                  - detail
        '401':
          description: Not authenticated.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Detail'
        '402':
          description: >-
            The plan does not include multi-store (Merchandising at Large or
            above).
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Paywall'
        '403':
          description: Authenticated, but this identity may not call the API.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Detail'
        '404':
          description: Merchant not found for this caller.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Detail'
        '415':
          description: Content-Type is not application/json.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Detail'
        '500':
          description: Internal error.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Detail'
components:
  schemas:
    LiteMultiStoreGroupSettingsUpdate:
      type: object
      properties:
        auto_replicate_enabled:
          type:
            - boolean
            - 'null'
        sync_publish_status:
          type:
            - boolean
            - 'null'
        replicate_recommendations:
          type:
            - boolean
            - 'null'
      description: >-
        Only the toggles being changed; an absent or null toggle is left as it
        is.
    LiteMultiStoreGroupSettingsDto:
      type: object
      properties:
        auto_replicate_enabled:
          type: boolean
          description: >-
            New cross-store collection links are stamped to replicate from the
            source store.
        auto_replicate_source_merchant_id:
          type:
            - string
            - 'null'
          description: The store auto-replication copies from; null until set.
        sync_publish_status:
          type: boolean
          description: >-
            Publishing or unpublishing a source collection fans out to its
            replicas.
        replicate_recommendations:
          type: boolean
      required:
        - auto_replicate_enabled
        - auto_replicate_source_merchant_id
        - sync_publish_status
        - replicate_recommendations
    Detail:
      type: object
      properties:
        detail:
          type: string
      required:
        - detail
      description: 'Every 4xx/5xx body: `{detail}`.'
    Paywall:
      type: object
      properties:
        detail:
          type: string
        code:
          type: string
          enum:
            - product_required
            - collection_limit_exceeded
            - installation_frozen
        product:
          type: string
          enum:
            - search
            - recs
            - vm
        limit:
          type: integer
      required:
        - detail
        - code
      description: >-
        402: the merchant's plan does not include this. Branch on `code`; show
        `detail`.
  securitySchemes:
    ShopifySessionToken:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: >-
        Shopify App Bridge session token of the embedded Depict: Search &
        Merchandising app. The shop in the token determines the merchant;
        merchant_id parameters must belong to that shop.

````