---
title: "Page Approval macro"
canonical: "https://support.appfire.com/space/PAFS/2213905904/Page%20Approval%20macro"
format: markdown
---
> Macro (aura-html)

## Overview

Add the page approval functionality to a page by adding the **Page Approval macro** to the page.

## Parameters

| **Parameter** | **Mandatory** | **Default value** | **Description** |
| --- | --- | --- | --- |
| **users** | No | None | One or more users added as approvers.<br>- If empty, anyone can approve<br>> ✅ Start typing a name in the box to search for a user. |
| **approval group** | No | None | Comma-separated list of one or more Confluence user groups:<br>- Members of the specified group(s) are added to the list of **users** who are registered to approve the page.<br>Users can not remove themselves from the list.<br>> 📝 Notifications are NOT generated immediately when users are added or removed from a group. |
| **acknowledgers** | No | None | One or more users added as acknowledgers<br>- comma-separated list of *case-sensitive* user names.<br>> ℹ️ For more information about acknowledgments, refer to the [Acknowledgements](https://appfire.atlassian.net/wiki/spaces/PAFS/pages/2213938564/Page+Approval+features#Acknowledgements). |
| **acknowledgement group** | No | None | Comma-separated list of one or more Confluence user groups:<br>- Members of the specified group(s) are added to the list of **users** who are registered to approve the page.<br>Users can not remove themselves from the list.<br>> 📝 Notifications are NOT generated immediately when users are added or removed from a group.<br>> ℹ️ For more information about acknowledgments, refer to the [Acknowledgements](https://appfire.atlassian.net/wiki/spaces/PAFS/pages/2213938564/Page+Approval+features#Acknowledgements). |
| **quorum** | No | None | The number of approvers required before approval achieved and set as complete. |
| **notifiedusers** | No | None | Users who are sent page approval notifications. Options are<br>- **all**
  - Notify all users
- **unapproved**
  - Notify registered users who have not approved the page.
- **approved**
  - Notify users who have approved the page<br>> 📝 Must have **notifiedactions** defined. |
| **notifiedactions** | No |  | Approval actions for which users are sent page approval notifications. Options are<br>- **change**
  - Notify of any change
- **unapproval**
  - Notify when the page is unapproved
- **approval**
  - Notify when the page is approved<br>> 📝 Must have **notifiedusers** defined. |
| **notifyapprovals** | No | false | Notify on approval events |
| **notifyacknowledgements** | No | false | Notify on acknowledgment events |
| **chain** | No | no | Enforce an ordered list of approvals. Options are<br>- **yes**
- **no**<br>The approvals are undertaken in the order of the users that are defined by the **users** option.<br>> 📝 Must have **users** defined. |
| **allowacknowledgements** | No | None | Creates an option such that users can acknowledge a page.<br>Users who acknowledge a page are added to an acknowledgement list.<br>> ℹ️ Options not required.<br>> ℹ️ For more information about acknowledgments, refer to [Acknowledgements](https://appfire.atlassian.net/wiki/spaces/PAFS/pages/2213938564/Page+Approval+features#Acknowledgements). |
| **showrole** | No |  | Display a box where users can enter their role in the approval process<br>> 📝 If the **showrole** parameter has been configured to be true by default, then the **hiderole** parameter can be used to turn off comments. |
| **showcomment** | No |  | Display a comment box where users can make comments about why they approved or unapproved a page.<br>> 📝 If the **showcomment** parameter is configured to be true by default, then the **hidecomment** parameter can be used to turn off comments. |
| **acknowledgersvisible** | No | true | By default, the **Acknowledgers** section is visible when the page is loaded (the value is true). The value is a boolean:<br>- **true**
- **false** |
| **expireafter** | No | None | Specify a time period after the page is approved when the approval expires.<br>> ℹ️ Options are a number and time word, such as '72 hours', '1 day', '6 months' or '1 year'. Time periods allowed are year, month, day, hour.<br>> ✅ The usage example shows a page where the approval expires 2 months after the page is approved. |
| **expirymonth** | No | None | Specify a fixed, recurring month when the page expires:<br>- can be used in conjunction with `expiryday`<br>> ℹ️ The options are a number (1-12), where the number is the month this page's approval expires. |
| **expiryday** | No | None | Specify a fixed, recurring day of the month when the page expires:<br>- can be used in conjunction with **expirymonth** to define a particular day in a year<br>> ℹ️ The options are a number (1-28). The number defines the day when this page's approval expires.<br>> 📝 Do not use days 29, 30, and 31, as their behavior is undefined. |

> 📝 When [migrating to Confluence Cloud](https://appfire.atlassian.net/wiki/spaces/PAFS/pages/2214953111), none of these parameter values are included.