Bulk Patch Images
Updates up to 20 images in a single request. Each item includes an image id and its own patch fields. Returns arrays of successfully patched images and failed patches with reasons.
PATCH
/api/v1/{team_slug}/{app_slug}/images/bulk- API
- Management
- OpenAPI
- management-api
- Updated
- Apr 26, 2026
management-api:PATCH:/api/v1/{team_slug}/{app_slug}/images/bulk
Updates up to 20 images in a single request. Each item includes an image id and its own patch fields. Returns arrays of successfully patched images and failed patches with reasons.
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\}/images/bulk - Summary: Bulk Patch Images
- Description: Updates up to 20 images in a single request. Each item includes an image id and its own patch fields. Returns arrays of successfully patched images and failed patches with reasons.
- 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.
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: Image patch items
- Content: application/json (object)
Bulk Patch Images Payload
| Property | Type | Required | Details |
|---|---|---|---|
images | object[] | Yes | minItems: 1, maxItems: 20 |
Bulk Patch Image Item
| Property | Type | Required | Details |
|---|---|---|---|
alt | string | No | - |
copyright | string | No | - |
custom | object | No | - |
filename | string | No | - |
id | string | Yes | - |
parent_id | string | No | - |
public | boolean | No | - |
status | enum("active", "inactive", "draft") | No | - |
title | string | No | - |
Generated example (synthetic):
{
"images": [
{
"alt": "string",
"copyright": "string",
"custom": {},
"filename": "string",
"id": "string",
"parent_id": "string",
"public": false,
"status": "active",
"title": "string"
}
]
}Responses
| Status | Description | Content |
|---|---|---|
| 200 | Images patched 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 Images Response
| Property | Type | Required | Details |
|---|---|---|---|
data | object | Yes | - |
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 | Yes | - |
Bulk Patch Images
| Property | Type | Required | Details |
|---|---|---|---|
failed | object[] | No | - |
successful | object[] | No | - |
Bulk Patch Image Failed Op
| Property | Type | Required | Details |
|---|---|---|---|
id | string | No | - |
reason | string | No | - |
Image With Used By
| Property | Type | Required | Details |
|---|---|---|---|
alt | string | No | - |
app_id | string | No | - |
attributes | object[] | No | - |
blurhash | string | No | - |
copyright | string | No | - |
custom | object | No | - |
folder_id | string | No | - |
id | string | No | - |
parent_id | string | No | - |
public | boolean | No | - |
status | string | No | - |
title | string | No | - |
translations | object | No | - |
url | string | No | - |
used_by | object[] | No | - |
variants | object[] | No | - |
Generated example (synthetic):
{
"data": {
"failed": [
{
"id": "string",
"reason": "string"
}
],
"successful": [
{
"alt": "string",
"app_id": "string",
"attributes": [],
"blurhash": "string",
"copyright": "string",
"custom": {},
"folder_id": "string",
"id": "string",
"parent_id": "string",
"public": false,
"status": "string",
"title": "string",
"translations": {
"alt": null,
"copyright": null,
"title": null
},
"url": "string",
"used_by": [],
"variants": []
}
]
},
"details": [
"string"
],
"success": false
}400 - object
Error Message
| Property | Type | Required | Details |
|---|---|---|---|
details | string[] | No | - |
message | string | No | - |
success | boolean | Yes | - |
Generated example (synthetic):
{
"details": [
"string"
],
"message": "string",
"success": false
}401 - object
Error Message
| Property | Type | Required | Details |
|---|---|---|---|
details | string[] | No | - |
message | string | No | - |
success | boolean | Yes | - |
Generated example (synthetic):
{
"details": [
"string"
],
"message": "string",
"success": false
}500 - object
Error Message
| Property | Type | Required | Details |
|---|---|---|---|
details | string[] | No | - |
message | string | No | - |
success | boolean | Yes | - |
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\}/images/bulk - Operation ID: Not documented in the OpenAPI contract.
- OpenAPI tag: Images, Bulk
- OpenAPI summary: Bulk Patch Images