Skip to main content

DELETE /v1/items/{id}/images/{imageId}

Scope

write_items

Request parameters

NameInTypeRequiredDescription
idpathstringrequiredID of the target resource.
imageIdpathstringrequiredID of the target resource.
Idempotency-KeyheaderstringrequiredIdempotency key (required). A UUID v4 is recommended. Resending the same key replays the original result, and the response carries Idempotent-Replay: true. Sending a different body with the same key returns 422, so always retry with the identical request.

Response example

{
"item_id": "string",
"images": [
{
"id": "string",
"key": "string",
"url": "string",
"sort": 0
}
]
}

Description

Delete one additional image. The main image cannot be deleted this way. (write_items)

Error response example

{
"error": {
"code": "insufficient_scope",
"message": "requires scope 'write_items'",
"request_id": "req_01H..."
}
}

Possible errors: 401 / 403 / 404 / 409 / 503