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

# Checklist Restore Action

Request restoration of a Checklist's archived files.
The namespaced Apex action name is `rooms__ChecklistRestoreAction`.

## 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 restore job creates Salesforce Files and their Checklist links, and updates Checklist status fields later. |
| Platform event | The action does not directly publish a platform event. |
| Background work | Yes. Restore 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 restore. |
| `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 creating Files. |
| `overwriteExisting` | Overwrite Existing | No | Defaults to `false`. Matching restored Files are skipped unless this value is `true`. |
| `manifestKey` | Manifest Key | No | Optional archive manifest reference. Leave blank to use the normal Checklist archive reference. |

## Outputs

| API name | Flow label | Meaning |
| --- | --- | --- |
| `success` | Success | Whether the restore request was accepted. It does not confirm that Files were restored. |
| `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 used for restore. |
| `status` | Status | The immediate request state, such as `ACCEPTED`. |

## Configure the Flow

1. Select the Checklist and the intended archive manifest.
2. Choose Dry Run and Overwrite Existing settings.
3. Store Success, Message, Status and the job references.
4. Inspect the restored Files and job result before 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.** Restore submission makes a callout. Review preceding work in the transaction.

**No new File appears.** Check Dry Run, the archive manifest, existing matching Files and job completion.

**The request is repeated.** Confirm the existing restore result first. Overwrite Existing changes which matching Files are eligible for restoration.

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.
