Add app to chat

Namespace: microsoft.graph

Install a teamsApp to the specified chat.

Notes:

  • If the chat is associated with an onlineMeeting instance, then, effectively, the teamsApp will get installed to the meeting.

This API is supported in the following national cloud deployments.

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

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) TeamsAppInstallation.ReadWriteSelfForChat1, TeamsAppInstallation.ReadWriteForChat1, TeamsAppInstallation.ReadWriteAndConsentSelfForChat, TeamsAppInstallation.ReadWriteAndConsentForChat
Delegated (personal Microsoft account) Not supported.
Application TeamsAppInstallation.ReadWriteSelfForChat.All1, TeamsAppInstallation.ReadWriteForChat.All1, TeamsAppInstallation.ReadWriteAndConsentSelfForChat.All, TeamsAppInstallation.ReadWriteAndConsentForChat.All

Note:
1 These permissions cannot be used to install apps that require consent to resource-specific permissions.

HTTP request

POST /chats/{chat-id}/installedApps

Request headers

Header Value
Authorization Bearer {token}. Required.
Content-Type application/json. Required.

Request body

The request body should include the generated app ID of the catalog app. For more information, see teamsApp properties. The following table lists additional parameters that can be used with the request body.

Parameter Type Description
consentedPermissionSet teamsAppPermissionSet Set of resource-specific permissions that are being consented to.

Note: The permissions consented to during the installation must match the resource-specific permissions defined in the teamsAppDefinition of the app. To get the application and delegated resource-specific permissions, see Example 7.If only delegated resource-specific permissions are specified in the teamsAppDefinition, permissions can be omitted in the request body.

Response

If successful, this method returns a 201 Created response code.

Examples

Example 1: Install app in a chat

Request

POST https://graph.microsoft.com/v1.0/chats/19:ea28e88c00e94c7786b065394a61f296@thread.v2/installedApps
Content-Type: application/json

{
   "teamsApp@odata.bind":"https://graph.microsoft.com/v1.0/appCatalogs/teamsApps/12345678-9abc-def0-123456789a"
}

Response

HTTP/1.1 201 Created

To get the list of resource-specific permissions required by the app, get the app from appCatalog, as shown in Example 7.

Request

POST https://graph.microsoft.com/v1.0/chats/19:ea28e88c00e94c7786b065394a61f296@thread.v2/installedApps
Content-Type: application/json

{
  "teamsApp@odata.bind" : "https://graph.microsoft.com/v1.0/appCatalogs/teamsApps/2b524e28-95ce-4c9b-9773-4a5bd6ec1770",
    "consentedPermissionSet": {
        "resourceSpecificPermissions": [
        {
          "permissionValue": "OnlineMeeting.ReadBasic.Chat",
          "permissionType": "Delegated"
        },
        {
          "permissionValue": "OnlineMeetingIncomingAudio.Detect.Chat",
          "permissionType": "Delegated"
        },
        {
          "permissionValue": "ChatMember.Read.Chat",
          "permissionType": "Application"
        },
        {
          "permissionValue": "ChatMessage.Read.Chat",
          "permissionType": "Application"
        }]
      }
}

Response

HTTP/1.1 201 Created

See also