Skip to main content

archiveCustomRecord

Archives a custom record identified by collection + key.

Business Rules​

  • Records are tenant-scoped to the current company
  • Only active records can be archived

Permissions Required​

  • tools:save_record
archiveCustomRecord(
  input: ArchiveCustomRecordInput!
): CustomRecord!

Arguments​

archiveCustomRecord.input ● ArchiveCustomRecordInput! non-null input common​

Parameters for ArchiveCustomRecord

Type​

CustomRecord object common​

A tenant-scoped custom JSON record identified by collection + key. Records are persisted in the Tools store and can optionally be scoped to a brand through metadata.