Archive entities

PATCH

/page/{entityPath}/entities/archive

Archives multiple entities by setting their isActive status to false. This is a soft delete operation
that preserves entity data while removing them from active listings.

Archive Process:

Sets isActive: false on all specified entities

For Asset entities, also archives related AssetStoreInstance records

For Booking entities, delegates to specialized booking archive handler

Preserves all entity data and relationships for potential restoration

Entity-Specific Behavior:

Assets: Archives associated store instances to maintain data consistency

Bookings: Uses specialized archive logic with additional business rules

Other entities: Standard isActive flag update

Access Control: Requires appropriate permissions for the entity type and client context.

Request

Authorization

API Key

Add parameter in header

Authorization

Example:

Authorization: ********************

Path Params

Body Params application/jsonRequired

Examples

Responses

🟢200OK

application/json

Entities archived successfully

Body

🟠400Bad Request

🟠404Not Found

🟠405Method Not Allowed

🔴500Internal Server Error

Request Example

Shell

JavaScript

Java

Swift

cURL

Archive single entityArchive multiple entities in batchArchive assets with store instances

curl --location --request PATCH 'https://prod.your-api-server.com/page/asset/entities/archive' \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--data-raw '{
    "entityIds": [
        "e6fb1b70-5295-11f0-b0ba-adfe69a423b8"
    ]
}'

Response Example

200 - Entities successfully archived

{
    "success": true
}

Modified at 2025-09-25 10:04:16

Duplicate entities

Restore archived entities