Edit

channel: completeMigration

Namespace: microsoft.graph

Complete migration on existing channels or new channels. Complete migration operations were initially restricted to newly created standard channels using migration templates specifically designed for the initial migration process. For more information, see Import third-party platform messages to Teams using Microsoft Graph.

Consider the following points when completing migration for new and existing channels:

  • When a channel is created in migration mode for the initial import flow, the property migrationMode for a channel in a team is updated to completed instead of being dropped, and the state is permanently marked for chats or channels. Migration mode is a special state that prevented certain operations, such as sending messages and adding members, during the data migration process. The parent team isn't marked with migration mode, as teams can't enter migration mode; only their child channels (general, standard, private, and shared) can.
  • For existing channels that are already in migration mode, the API completes the message migration process by updating migrationMode to completed for a channel in a team.
  • The application that calls completeMigration must be the same application that initiated the migration session by calling startMigration on the target channel. This is the same application that is allowed to call import message during the migration session.
  • Calling completeMigration removes the import mode banner visible to Teams client users, making the channel fully available again.

After a completeMigration request is made for existing or new channels, you can still import more messages into the team by calling channel: startMigration.

This API supportes the following channel types.

Entities Sub type Migration mode support Notes
Channels Standard, Private, Shared New and existing Channels must be created or already be in migration mode.

This API is available in the following national cloud deployments.

Global service US Government L4 US Government L5 (DOD) China operated by 21Vianet
✅ ✅ ✅ ✅

Permissions

Choose the permission or permissions marked as least privileged for this API. Use a higher privileged permission or permissions only if your app requires it. For details about delegated and application permissions, see Permission types. To learn more about these permissions, see the permissions reference.

Permission type Least privileged permissions Higher privileged permissions
Delegated (work or school account) Not supported. Not supported.
Delegated (personal Microsoft account) Not supported. Not supported.
Application Teamwork.Migrate.All Not available.

HTTP request

POST /teams/{team-id}/channels/{channel-id}/completeMigration

Request headers

Header Value
Authorization Bearer {token}. Required. Learn more about authentication and authorization.

Request body

Don't supply a request body for this method.

Response

If successful, this method returns a 204 No Content response code. It doesn't return anything in the response body.

Examples

Example 1: Complete the migration when a channel is in migration mode

The following example shows how to complete the migration when a channel is in migration mode.

Request

The following example shows a request.

POST https://graph.microsoft.com/v1.0/teams/57fb72d0-d811-46f4-8947-305e6072eaa5/channels/19:4b6bed8d24574f6a9e436813cb2617d8@thread.tacv2/completeMigration

Response

The following example shows the response.

HTTP/1.1 204 No Content

Example 2: Complete the migration when a channel isn't in migration mode

The following example shows how to complete the migration when a channel isn't in migration mode. This request fails with a 400 Bad Request response.

Request

The following example shows a request.

POST https://graph.microsoft.com/v1.0/teams/57fb72d0-d811-46f4-8947-305e6072eaa5/channels/19:4b6bed8d24574f6a9e436813cb2617d8@thread.tacv2/completeMigration

Response

The following example shows the response.

HTTP/1.1 400 Bad Request

Related content

  • Last updated on