---
title: "admArchiveProject"
canonical: "https://support.appfire.com/space/PSJC/433000656/admArchiveProject"
format: markdown
---
> Macro (aura-html)


## Description

> Macro (excerpt)

Archives a project.

|  |  |  |  |
| --- | --- | --- | --- |
| **Syntax** | admArchiveProject(projectKey) | **Package** | adm |
| **Alias** |  | **Pkg Usage** | archiveProject(projectKey) |

## Parameters

| Parameter name | Type | Required | Description |
| --- | --- | --- | --- |
| projectKey | String | Yes | Project key of project to archive. |

## Return Type

**Boolean**

Returns 'true' if operation succeeded and 'false' otherwise.

## Example

```javascript
admArchiveProject("TSTPROJ");
```

Returns: true

## See also

> Macro (contentbylabel)