sourceCollection: purgeData
Namespace: microsoft.graph.ediscovery
Important
APIs under the /beta
version in Microsoft Graph are subject to change. Use of these APIs in production applications is not supported. To determine whether an API is available in v1.0, use the Version selector.
Permanently delete Microsoft Teams messages contained in a sourceCollection.
Note: This request purges Teams data only. It does not purge other types of data such as mailbox items.
You can collect and purge the following categories of Teams content:
- Teams 1:1 chats - Chat messages, posts, and attachments shared in a Teams conversation between two people. Teams 1:1 chats are also called conversations.
- Teams group chats - Chat messages, posts, and attachments shared in a Teams conversation between three or more people. Also called 1:N chats or group conversations.
- Teams channels - Chat messages, posts, replies, and attachments shared in a standard Teams channel.
- Private channels - Message posts, replies, and attachments shared in a private Teams channel.
- Shared channels - Message posts, replies, and attachments shared in a shared Teams channel.
For more information about purging Teams messages, see:
- eDiscovery solution series: Data spillage scenario - Search and purge
- Advanced eDiscovery workflow for content in Microsoft Teams
Permissions
One of the following permissions is required to call this API. To learn more, including how to choose permissions, see Permissions.
Permission type | Permissions (from least to most privileged) |
---|---|
Delegated (work or school account) | eDiscovery.ReadWrite.All |
Delegated (personal Microsoft account) | Not supported. |
Application | Not supported. |
HTTP request
POST /compliance/ediscovery/cases/{caseId}/sourceCollections/{sourceCollectionId}/purgeData
Request headers
Name | Description |
---|---|
Authorization | Bearer {token}. Required. |
Request body
Do not supply a request body for this method.
Response
If successful, this action returns a 202 Accepted
response code.
If the purge data operation is started successfully, this action returns a 202 Accepted
response code. The response will also contain a Location
header, which contains the location of the Purge data operation that was created to commit the purge.
To check the status of the purge data operation, make a GET request to the location URL. When the request successfully completes, the status will change to succeeded
.
Examples
Request
POST https://graph.microsoft.com/beta/compliance/ediscovery/cases/{caseId}/sourceCollections/{sourceCollectionId}/purgeData
Response
HTTP/1.1 202 Accepted
Feedback
Submit and view feedback for