Update a showcase
/showcases/{showcase_id}Updates an existing showcase. Only the fields present in the request are changed.
Updating status requires the showcases.publish permission in addition to showcases.update. Setting parent_id moves the showcase into a group, or to the top level when null; moves that would break the two-level hierarchy are rejected with hierarchy_violation. Setting deleted to false restores a showcase from the trash.
Replicated showcases accept only status; a request that includes any other field returns the replica_readonly error code.
Send the current ETag value in the If-Match header to avoid overwriting changes made since the showcase was retrieved.
Autonomous mode: the API credential secret, sent as a bearer token. Credential secrets are identified by a fixed prefix.
In: header
Path Parameters
Header Parameters
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
application/json
application/json
application/json
application/json
application/json
curl -X PATCH "https://example.com/showcases/string" \ -H "Content-Type: application/json" \ -d '{}'{ "data": { "created_at": "2019-08-24T14:15:22Z", "deleted": true, "id": "string", "image": "string", "kind": "group", "name": "string", "object": "showcase", "parent_id": "string", "position": 0, "products_count": 0, "revision": "string", "status": "published", "updated_at": "2019-08-24T14:15:22Z" }}Retrieve a showcase GET
Retrieves a showcase by its public ID, including the number of products it contains. The response includes an `ETag` representing the current revision. Send this value in the `If-Match` header when updating the showcase to avoid overwriting a newer version. Showcases that do not exist or are not accessible with the current credentials return `404 Not Found`.
Delete a showcase DELETE
Moves the showcase to the trash. Its child showcases, the products in the showcase, and its copies in replicated accounts are moved to the trash along with it. Replicated showcases are read-only and cannot be deleted. Attempts to delete them return the `replica_readonly` error code.