Bulk update collections

Updates multiple collections in a single request. Accepts up to 50 collections with partial updates to title, slug, status, or parent. Returns lists of successful and failed updates.

PATCH/api/v1/{team_slug}/{app_slug}/collections/bulk
API
Management
Updated
Apr 26, 2026

management-api:PATCH:/api/v1/{team_slug}/{app_slug}/collections/bulk

Updates multiple collections in a single request. Accepts up to 50 collections with partial updates to title, slug, status, or parent. Returns lists of successful and failed updates.

API ownership

  • API family: Management API
  • Best for: Trusted back-office workflows that create, update, organize, or delete merchant-owned data.
  • Do not use from: Browser-only storefront code or public clients.
  • Guide route: /apis/management/latest

The OpenAPI contract defines the method, path, parameters, request body, and responses for this operation.

Operation

  • Method: PATCH
  • Path: /api/v1/\{team_slug\}/\{app_slug\}/collections/bulk
  • Summary: Bulk update collections
  • Description: Updates multiple collections in a single request. Accepts up to 50 collections with partial updates to title, slug, status, or parent. Returns lists of successful and failed updates.
  • OpenAPI contract: management-api
  • Operation ID: Not documented in the OpenAPI contract.

Operation key uses API family, method, and path because this OpenAPI contract does not publish an operation ID.

Parameters2 parameters
NameInRequiredTypeDescription
team_slugpathYesstringTeam slug
app_slugpathYesstringApp slug
Request bodyDocumented body
  • Required: Yes
  • Description: Collections data to update
  • Content: application/json (object)

Bulk Patch Collections Payload

PropertyTypeRequiredDetails
collectionsobject[]YesmaxItems: 50

Bulk Patch Collection Item

PropertyTypeRequiredDetails
idstringYes-
parent_idstringNo-
slugstringNo-
statusenum("active", "inactive", "draft")No-
titlestringNo-

Generated example (synthetic):

{
  "collections": [
    {
      "id": "string",
      "parent_id": "string",
      "slug": "string",
      "status": "active",
      "title": "string"
    }
  ]
}
Responses4 statuses
StatusDescriptionContent
200Collections updated successfullyapplication/json (object)
400Invalid requestapplication/json (object)
401Unauthorized accessapplication/json (object)
500Internal server errorapplication/json (object)

200 - object

Bulk Patch Collections Response

PropertyTypeRequiredDetails
dataobjectNo-
detailsstring[]NoAdditional contextual information about the response. Used to provide supplementary details beyond the main data payload, such as validation warnings or processing notes
successbooleanNo-
Bulk Patch Collections
PropertyTypeRequiredDetails
failedobject[]No-
successfulobject[]No-
Bulk Patch Failed Update
PropertyTypeRequiredDetails
idstringNo-
reasonstringNo-
Collection
PropertyTypeRequiredDetails
childrenobject[]No-
created_atstringNo-
idstringNo-
parent_idstringNo-
redirectsobject[]No-
slugstringYes-
statusenum("active", "inactive", "draft")Yes-
titlestringNo-
translationsobjectNo-
updated_atstringNo-
uristringNo-

Generated example (synthetic):

{
  "data": {
    "failed": [
      {
        "id": "string",
        "reason": "string"
      }
    ],
    "successful": [
      {
        "children": [],
        "created_at": "string",
        "id": "string",
        "parent_id": "string",
        "redirects": [],
        "slug": "string",
        "status": "active",
        "title": "string",
        "translations": {
          "slug": null,
          "title": null
        },
        "updated_at": "string",
        "uri": "string"
      }
    ]
  },
  "details": [
    "string"
  ],
  "success": false
}

400 - object

Error Message

PropertyTypeRequiredDetails
detailsstring[]No-
messagestringNo-
successbooleanNo-

Generated example (synthetic):

{
  "details": [
    "string"
  ],
  "message": "string",
  "success": false
}

401 - object

Error Message

PropertyTypeRequiredDetails
detailsstring[]No-
messagestringNo-
successbooleanNo-

Generated example (synthetic):

{
  "details": [
    "string"
  ],
  "message": "string",
  "success": false
}

500 - object

Error Message

PropertyTypeRequiredDetails
detailsstring[]No-
messagestringNo-
successbooleanNo-

Generated example (synthetic):

{
  "details": [
    "string"
  ],
  "message": "string",
  "success": false
}

Contract identity

Use these fields to confirm you are implementing the intended endpoint contract.

  • API family: Management API
  • Method: PATCH
  • Path: /api/v1/\{team_slug\}/\{app_slug\}/collections/bulk
  • Operation ID: Not documented in the OpenAPI contract.
  • OpenAPI tag: Collections, Bulk
  • OpenAPI summary: Bulk update collections

Bulk update collections

# Bulk update collections Updates multiple collections in a single request. Accepts up to 50 collections with partial updates to title, slug, status, or parent. Returns lists of successful and failed updates.
PATCH /api/v1/{team_slug}/{app_slug}/collections/bulk
Purpose

Updates multiple collections in a single request.

Required inputs

team_slug path app_slug path

Primary response

200 ยท Collections updated successfully

Operation key

management-api:PATCH:/api/v1/{team_slug}/{app_slug}/collections/bulk

## API ownership - API family: Management API - Best for: Trusted back-office workflows that create, update, organize, or delete merchant-owned data. - Do not use from: Browser-only storefront code or public clients. - Guide route: [/apis/management/latest](/apis/management/latest) The OpenAPI contract defines the method, path, parameters, request body, and responses for this operation. ## Operation - Method: `PATCH` - Path: `/api/v1/{team_slug}/{app_slug}/collections/bulk` - Summary: Bulk update collections - Description: Updates multiple collections in a single request. Accepts up to 50 collections with partial updates to title, slug, status, or parent. Returns lists of successful and failed updates. - OpenAPI contract: management-api - Operation ID: Not documented in the OpenAPI contract. - Stable operation key: `management-api:PATCH:/api/v1/{team_slug}/{app_slug}/collections/bulk` Operation key uses API family, method, and path because this OpenAPI contract does not publish an operation ID. ## Parameters | Name | In | Required | Type | Description | | --- | --- | --- | --- | --- | | team_slug | path | Yes | string | Team slug | | app_slug | path | Yes | string | App slug | ## Request body - Required: Yes - Description: Collections data to update - Content: application/json (object) ### Bulk Patch Collections Payload | Property | Type | Required | Details | | --- | --- | --- | --- | | `collections` | object[] | Yes | maxItems: 50 | #### Bulk Patch Collection Item | Property | Type | Required | Details | | --- | --- | --- | --- | | `id` | string | Yes | - | | `parent_id` | string | No | - | | `slug` | string | No | - | | `status` | enum("active", "inactive", "draft") | No | - | | `title` | string | No | - | **Generated example (synthetic):** ```json { "collections": [ { "id": "string", "parent_id": "string", "slug": "string", "status": "active", "title": "string" } ] } ``` ## Responses | Status | Description | Content | | --- | --- | --- | | 200 | Collections updated successfully | application/json (object) | | 400 | Invalid request | application/json (object) | | 401 | Unauthorized access | application/json (object) | | 500 | Internal server error | application/json (object) | ### 200 - object #### Bulk Patch Collections Response | Property | Type | Required | Details | | --- | --- | --- | --- | | `data` | object | No | - | | `details` | string[] | No | Additional contextual information about the response. Used to provide supplementary details beyond the main data payload, such as validation warnings or processing notes | | `success` | boolean | No | - | ##### Bulk Patch Collections | Property | Type | Required | Details | | --- | --- | --- | --- | | `failed` | object[] | No | - | | `successful` | object[] | No | - | ##### Bulk Patch Failed Update | Property | Type | Required | Details | | --- | --- | --- | --- | | `id` | string | No | - | | `reason` | string | No | - | ##### Collection | Property | Type | Required | Details | | --- | --- | --- | --- | | `children` | object[] | No | - | | `created_at` | string | No | - | | `id` | string | No | - | | `parent_id` | string | No | - | | `redirects` | object[] | No | - | | `slug` | string | Yes | - | | `status` | enum("active", "inactive", "draft") | Yes | - | | `title` | string | No | - | | `translations` | object | No | - | | `updated_at` | string | No | - | | `uri` | string | No | - | **Generated example (synthetic):** ```json { "data": { "failed": [ { "id": "string", "reason": "string" } ], "successful": [ { "children": [], "created_at": "string", "id": "string", "parent_id": "string", "redirects": [], "slug": "string", "status": "active", "title": "string", "translations": { "slug": null, "title": null }, "updated_at": "string", "uri": "string" } ] }, "details": [ "string" ], "success": false } ``` ### 400 - object #### Error Message | Property | Type | Required | Details | | --- | --- | --- | --- | | `details` | string[] | No | - | | `message` | string | No | - | | `success` | boolean | No | - | **Generated example (synthetic):** ```json { "details": [ "string" ], "message": "string", "success": false } ``` ### 401 - object #### Error Message | Property | Type | Required | Details | | --- | --- | --- | --- | | `details` | string[] | No | - | | `message` | string | No | - | | `success` | boolean | No | - | **Generated example (synthetic):** ```json { "details": [ "string" ], "message": "string", "success": false } ``` ### 500 - object #### Error Message | Property | Type | Required | Details | | --- | --- | --- | --- | | `details` | string[] | No | - | | `message` | string | No | - | | `success` | boolean | No | - | **Generated example (synthetic):** ```json { "details": [ "string" ], "message": "string", "success": false } ``` ## Contract identity Use these fields to confirm you are implementing the intended endpoint contract. - API family: Management API - Method: `PATCH` - Path: `/api/v1/{team_slug}/{app_slug}/collections/bulk` - Operation ID: Not documented in the OpenAPI contract. - Stable operation key: `management-api:PATCH:/api/v1/{team_slug}/{app_slug}/collections/bulk` - OpenAPI tag: Collections, Bulk - OpenAPI summary: Bulk update collections