Archive team

Archive the specified team. When a team is archived, users can no longer send or like messages on any channel in the team, edit the team's name, description, or other settings, or in general make most changes to the team. Membership changes to the team continue to be allowed.

Archiving is an async operation. A team is archived once the async operation completes successfully, which may occur subsequent to a response from this API.

In order to archive team, the team and group must have an owner.

To restore a team from its archived state, use the API to unarchive.

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) Group.ReadWrite.All
Delegated (personal Microsoft account) Not supported.
Application Group.ReadWrite.All

Note: This API supports admin permissions. Global admins and Microsoft Teams service admins can access teams that they are not a member of.

HTTP request

POST /teams/{id}/archive

Request headers

Header Value
Authorization Bearer {token}. Required.

Request body

In the request, you may optionally include the shouldSetSpoSiteReadOnlyForMembers parameter in a JSON body, as follows.

{
    "shouldSetSpoSiteReadOnlyForMembers": true
}

This optional parameter defines whether to set permissions for team members to read-only on the Sharepoint Online site associated with the team. Setting it to false or omitting the body altogether will result in this step being skipped.

Response

If archiving is started successfully, this method returns a 202 Accepted response code. The response will also contain a Location header, which contains the location of the teamsAsyncOperation that was created to handle archiving of the team. Check the status of the archiving operation by making a GET request to this location.

Example

Request

The following is an example of a request.

POST https://graph.microsoft.com/v1.0/teams/{id}/archive

Response

The following is an example of a response.

HTTP/1.1 202 Accepted
Location: /teams({id})/operations({opId})
Content-Type: text/plain
Content-Length: 0