Skip to main content

​
Overview

Archive is CXF’s reversible deletion. Instead of removing a record for good, archiving hides it from normal listings while keeping it recoverable — you can restore it later, or permanently delete it in a second step. A record is active by default and archived once it’s been archived. For the mental model, see Core concepts. Archive is opt-in per object type — the Object types catalog shows which ones support it. Object types that don’t support archive are deleted permanently on the first delete.

​
Where to find it

In a list, toggle between active and archived records. On a record you can Archive it (active → archived), Restore it (archived → active), or permanently delete it once it’s archived. The same actions are available in bulk from a list.

​
Properties

Archive adds a single field to a record:
PropertyTypeRequiredDescription
deleted_atdatetimeRead-onlyEmpty while the record is active; set to the archive time once archived.

​
Behaviour & rules

  • Delete twice to destroy. The first delete archives a record; deleting an already-archived record permanently deletes it.
  • Archived records are hidden from default listings — you reach them by switching the list to its archived view.
  • Restore brings a record back to active.
  • Cascades to dependents. Archiving, restoring, or permanently deleting a record propagates to its dependent records; restoring a parent brings back only the dependents that were archived together with it.
  • No archive support → hard delete. For object types that don’t support archive, the first delete is permanent.
  • You can’t archive your own user.

​
Seeds

A record’s archived state travels in a structural Seed: set the record’s deleted_at to archive it on import (leave it out to keep the record active).

​
Governance & permissions

A super admin, admin, or Journey Manager (JM) can archive, restore, and permanently delete records.

​
API access

A DELETE on a record archives it (or permanently deletes it if it’s already archived); a dedicated restore operation brings it back, and listing with archived=true returns only archived records. Bulk archive and restore are available too. See the API reference.

Object types

Which object types support Archive.

Core concepts

How Archive fits the shared object model.