Bulk-archive entities
Archives up to 100 entities of the same type in one call. Each id is processed independently - entities that cannot be archived (e.g. still referenced by an active subscription) are reported in results[] with status=blocked and an error message, while the rest are archived. The response always returns 200 with per-id results plus archived/blocked counts.
Headers
Idempotency-KeyUnique key that makes this POST safe to retry: repeats with the same key replay the first response instead of re-executing. Replays are scoped to the retrying principal (same API key / user) and kept for 24 hours. Required on every POST.
Client-generated idempotency key (e.g. a UUID).
X-Workspace-IdSelects the workspace this request operates in, by workspace UUID or slug (e.g. a sandbox workspace for test integrations). Omitted: the organization's default live workspace. Unknown workspace: 404; workspace outside your organization: 403. Discover workspaces via GET /workspaces.
Workspace UUID or slug.
Bulk-archive entities › Request Body
deprecated_beforeentity_idsentity_typeBulk-archive entities › Responses
OK