CIPP.app icon

CIPP.app

Manage Microsoft 365 tenants via CIPP.app

Actions619

Mailbox → Manage Retention Tags

AI-generated

Summary

Manage retention tags for a specified tenant's mailbox by listing all tags, creating a new tag, or deleting an existing tag.

Inputs

  • Tenant (required) — Select the tenant to perform the operation on, either from a searchable list or by specifying the tenant domain.
  • Action (required) — Choose the retention tag operation to perform: List all retention tags, Create a new retention tag, or Delete an existing retention tag.
  • Tag Name — Specify the name of the retention tag when creating or deleting a tag.

Output shape

a JSON object reflecting the API response for the retention tag action performed, such as a list of tags for 'List', or confirmation data for 'Create' and 'Delete'.

The output format depends on the chosen action. Listing returns an array of retention tags. Create and Delete actions return status or details of the performed operation. Tenant selection is mandatory. The Tag Name is required only for Create and Delete actions.

Examples

Example 1: List all retention tags for a tenant's mailbox

Set Tenant to the desired tenant and Action to 'List'. No Tag Name input needed.

Example 2: Create a new retention tag

Set Tenant to the desired tenant, Action to 'Create', and specify the Tag Name for the new retention tag.

Example 3: Delete an existing retention tag

Set Tenant to the desired tenant, Action to 'Delete', and specify the Tag Name of the retention tag to delete.

Links

Discussion