Skip to main content
BOOK A DEMO

Action: Create retention label

skybow Support
  • Article Updated

Create retention label action allows to create a retention label for the items/documents that need exceptions to your retention policies. Exceptions include extending the retention period for specific items/documents or preventing certain items/documents from being permanently deleted.

Note: Created retention labels can be applied to the item in 24 hours after creation.

Retention label is used to retain specific items longer than an applied retention policy, but they can also be used to override automatic deletion at the end of the retention period, or apply a different deletion period.

Example of Create retention label action configuration on the current site

createRetemtionLabel.png

For more information about Action Builder read Action Builder introduction article.

Note 1: In order to use the Create retention label action in Scheduled/Triggered Actions skybow Compliance Connector has to be approved by a tenant administrator and site has to be added to Approved sites list before this action can be used. Learn more about skybow M365 Connectors
Note 2: When you deploy the solution to another SharePoint tenant, it requires approval of skybow Compliance Connector on the deployment tenant as well. 

To configure the action Create retention label the additional properties should be specified. 

Configuration

Property Required Type Description

Label name

 yes String

Specify the name of the retention label
Description for admins no String Specify the description for the admins
Description for users no String

Specify the description for the users
Label settings yes Choice Specify the setting that will be applied to the labeled item:
  • Retain items even if users delete
  • Enforce actions after a specific period
  • Mark as record
  • Enter custom value
Retention period in days yes String

Specify how long the retention period should last (be)
Enter 0 if label should last forever
Start count retention period after yes  Choice Specify from which date starting to count the retention:
  • Date labeled
  • Date created
  • Date modified
  • Enter custom value
Action after retention period is over yes Choice Specify what happens after the retention period:
  • Deactivate retention settings
  • Delete
  • Change label
  • Start disposition review
  • Enter custom value
Label to be applied no String For the option 'Change label' specify the name of the label to be applied after the retention period is over.
Disposition stages no String For the option 'Start disposition review' specify the Disposition stages in json format:
{name:'stage name', reviewersEmailAddresses: ['email', ...]}

 

Availability

Modern Forms List Actions Scheduled/Triggered Actions
- - ✓

 

Output

Output Parameter Type Description
LabelName String Return the name of the created retention label

retentionLabelOutput.png

 

Related articles