---
isPublished: true
knowledgeIndex: false
hidden: true
noindex: true
template: "page.peb"
title: "Checklist Archive Action Flow Reference"
description: "Request archival of a Checklist's files."
contentType: "reference"
audience: "admin,developer"
---

# Checklist Archive Action

Request archival of a Checklist's files.
The namespaced Apex action name is `rooms__ChecklistArchiveAction`.

## Transaction summary

| Effect | Behavior |
| --- | --- |
| API callout | Yes. The action waits for a submission response. |
| Record writes | No direct record changes in the action step. The archive job updates Checklist status fields and can delete eligible Salesforce Files when Delete Salesforce Files is enabled. |
| Platform event | The action does not directly publish a platform event. |
| Background work | Yes. Archive work continues after an accepted response. |
| Email | Requested By Email is used for job status notifications. |

## Inputs

Required describes the Flow input setting. Additional configuration rules can still require a value.

| API name | Flow label | Required | Default or guidance |
| --- | --- | --- | --- |
| `checklistId` | Checklist ID | Yes | Select the Checklist to archive. |
| `requestedByUserId` | Requested By User ID | No | Defaults to the current Salesforce user. |
| `requestedByEmail` | Requested By Email | No | Defaults to the current Salesforce user email. |
| `dryRun` | Dry Run | No | Defaults to `false`. Set `true` to evaluate work without file copying or deletion. |
| `deleteSalesforceFiles` | Delete Salesforce Files | No | Defaults to `true`. Eligible Salesforce Files can be deleted after the archive manifest is created. Set `false` to retain them. |
| `skipUnsafeSharedFiles` | Skip Unsafe Shared Files | No | Defaults to `true`. Skips Files linked outside this Checklist scope. |
| `manifestKey` | Manifest Key | No | Optional existing archive-reference override. Leave blank to use the normal Checklist archive reference. |

## Outputs

| API name | Flow label | Meaning |
| --- | --- | --- |
| `success` | Success | Whether the archive request was accepted. It does not confirm archive completion. |
| `message` | Message | Acknowledgement or error details. |
| `jobType` | Job Type | The requested background operation. |
| `queueMessageId` | Queue Message ID | The submitted job reference. |
| `archivePrefix` | Archive Prefix | An archive reference. Keep it for support; it is not a Salesforce record ID. |
| `manifestKey` | Manifest Key | The archive manifest reference. Keep it for the corresponding restore. |
| `status` | Status | The immediate request state, such as `ACCEPTED`. |

## Configure the Flow

1. Confirm the Checklist and its File sharing scope.
2. Choose whether to retain Salesforce Files. Review the default Delete Salesforce Files setting.
3. Use Dry Run to evaluate the selected work when needed.
4. Store Success, Message, Status, Queue Message ID and Manifest Key.
5. Monitor the archive result before restoring or repeating the request.

Confirm the Flow user's Apex action access and access to the records or Files used by this operation. Review the configured Salesforce API connection user's access when the action makes an API request.

## Troubleshooting

**You have uncommitted work pending.** Archive submission makes a callout. Review preceding record writes and queued work.

**Files remain in Salesforce.** Check Dry Run, Delete Salesforce Files, shared-file exclusions and the final job result. An accepted request does not confirm deletion.

**The response is uncertain.** Keep the returned job and manifest references. Check the existing archive result before submitting the same work again.

See the [Flow action catalog](/content/build/flows/index.md) for related actions and transaction guidance. Confirm that the action and input fields are available in the installed package.
