Skip to navigation

Update a product sketch

Requires products:update. Replaces the image or edits its metadata; omitted fields are preserved and the parent cannot be changed. Provide exactly one image file or image URL when uploading. Binary files use multipart/form-data; HTTP(S) URLs or base64 image data URIs use application/json. Single uploads complete processing before returning. Maximum 25 MB per image. Image writes update the parent product updatedAt. Concurrent edits during upload return 409; retry against the current image. Failed uploads preserve the existing image. PUT and PATCH accept the same partial-update fields. List /sketch_groups to find an allowed group. On create, omitting sketchGroupId uses Uncategorized. On update, omission preserves the current group; null or an empty value selects Uncategorized.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

idstringRequiredformat: "uuid"
Image ID returned by an image endpoint or a completed batch result.

Request

Use the productSketch JSON wrapper, or bracketed fields such as productSketch[photo] for multipart uploads.

productSketchobjectRequired

Response

Image updated.
idstringOptionalformat: "uuid"
productIdstringOptionalformat: "uuid"
ID of the product that owns the image.
photoUrlstring or nullOptionalformat: "uri"
positionintegerOptional
createdAtdatetimeOptional
updatedAtdatetimeOptional
descriptionstring or nullOptional
sketchGroupIdstring or nullOptionalformat: "uuid"

Errors

401
Unauthorized Error
403
Forbidden Error
404
Not Found Error
409
Conflict Error
422
Unprocessable Entity Error