Service Update
| Availability | April 7th, 2026 |
| Product(s) | Cloud Archive for Email - Data Retention, Smart Tags |
| Who's affected | Administrators and API integrators using Cloud Archive for Email with Smart Tags functionality and API 2.0 applications |
Overview
Mimecast is pleased to announce new Smart Tags API endpoints in the Data Retention area of the Mimecast API 2.0 Developer Portal. These endpoints enable organizations to programmatically manage Smart Tags, supporting automated content categorization, eDiscovery, and compliance workflows.
Smart Tags automatically categorize and group archived emails based on conditions like keywords, attachments, or email attributes. Smart Tags group messages into folders accessible via the Mimecast Personal Portal or Mimecast for Outlook, with permissions managed by administrators. Users can forward tagged messages but cannot modify or delete tags.
Previously, Smart Tags were configured only through the Mimecast Administration Portal. The new API endpoints now allow programmatic management of Smart Tags for enhanced workflow integration.
What's changing
Three new Smart Tags API endpoints are now available:
- Get List of Smart Tags: Retrieves a list of Smart Tags configured in the authenticated account's Mimecast Archive. Returns the tag identifier, display name, description, parent ID, and path for each Smart Tag. Use this endpoint to enumerate available tags before performing search or apply operations, or to synchronize Mimecast Smart Tags with external platforms.
- Apply Smart Tag: Applies a specific Smart Tag to an archived message. When a Smart Tag is applied, the targeted message is grouped under the specific Smart Tag folder and becomes accessible to users or groups that have been granted permissions to that tag. This is the programmatic equivalent of tagging messages through the Mimecast Administration Console under Archive | Smart Tags. Use this endpoint to categorize archived emails as part of party case management and post-delivery analysis tools.
- Search Smart Tag: Searches for archived messages that have been assigned to a specified Smart Tag. Returns a paginated list of message IDs within the given tag. If message content is required, use the returned message IDs with the Get Message Detail or Get Message Part endpoints. Use this endpoint to retrieve the contents of a Smart Tag for compliance review. legal hold analysis, audit purposes, or to enable automated export and synchronization of tagged message sets to external platforms.
Prerequisites
- API 2.0 Application: A registered API 2.0 application with the Data Retention product enabled. See API & Integrations - Managing API 2.0 for Cloud Gateway for setup instructions.
- Application Role Permissions: The role assigned to the API application must be Super Administrator.
- Account Requirements: The Mimecast Account must have an active Cloud Archive for Email subscription with Smart Tags functionality enabled.
Recommended actions
Nothing needs to be done as a result of these changes.
For full endpoint documentation, including request and response schemas, visit the Data Retention section of the Mimecast API 2.0 Developer Portal.
For questions or assistance, contact your Mimecast representative or raise a support case.
Comments
Please sign in to leave a comment.