Lifecycle

Archive an entity

Archives an <i>approved</i> entity. The entity can be restored if needed. Requires the <i>Archive</i> permission.

post/api/entities/{id}/lifecycle/archive

Request

Base URL
https://your-server
Auth
OAuth 2
Authorization code/oauth/authorize
Token URL/oauth/token
TypeScript
https://skmtc.dev/sitecore/apis/entities-api/docs/api/entities/:id/lifecycle/archive/post.ts
A function with typed inputs. Its response is checked against the schema.

Path parameters

idinteger required

The unique identifier for the entity.

Response

Entity archived successfully

Changes

No recorded changes to this operation across all 1 revision of this API.