Skip to content

Latest commit

 

History

History
106 lines (81 loc) · 3.72 KB

channel-patch-tabs.md

File metadata and controls

106 lines (81 loc) · 3.72 KB
Raw
title description author ms.localizationpriority ms.subservice doc_type
Update tab
Update the properties of the specified tab.
nkramer
medium
teams
apiPageType

Update tab

Namespace: microsoft.graph

[!INCLUDE beta-disclaimer]

Update the properties of the specified tab.

This API can be used to configure the content of the tab.

Note

You can't use this API to update a static tab. An attempt to update a static tab returns a 400 Bad Request response code.

[!INCLUDE national-cloud-support]

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.

This API supports admin permissions. Global admins and Microsoft Teams service admins can access teams that they aren't a member of.

[!INCLUDE permissions-table]

Note

  • The TeamsTab.ReadWrite.Group permission uses resource-specific consent.
  • The Group.ReadWrite.All and Directory.ReadWrite.All permissions are supported only for backward compatibility. We recommend that you update your solutions to use an alternative permission listed in the previous table and avoid using these permissions going forward.

HTTP request

PATCH /teams/{team-id}/channels/{channel-id}/tabs/{tab-id}

Request headers

Header Value
Authorization Bearer {token}. Required. Learn more about authentication and authorization.
Content-Type application/json

Request body

In the request body, supply a JSON representation of tab object.

Response

If successful, this method returns a 200 OK response code.

Examples

Request

The following example shows a request.

PATCH https://graph.microsoft.com/beta/teams/{id}/channels/{id}/tabs/{id}
Content-type: application/json

{
  "displayName": "My Contoso Tab - updated"
}

Response

The following example shows the response.

HTTP/1.1 200 OK
Content-type: application/json

{
  "id": "tabId",
  "displayName": "My Contoso Tab - updated",
  "teamsAppId": "06805b9e-77e3-4b93-ac81-525eb87513b8",
  "configuration": {
    "entityId": "2DCA2E6C7A10415CAF6B8AB6661B3154",
    "contentUrl": "https://www.contoso.com/Orders/2DCA2E6C7A10415CAF6B8AB6661B3154/tabView",
    "websiteUrl": "https://www.contoso.com/Orders/2DCA2E6C7A10415CAF6B8AB6661B3154",
    "removeUrl": "https://www.contoso.com/Orders/2DCA2E6C7A10415CAF6B8AB6661B3154/uninstallTab"
  },
  "sortOrderIndex": "20",
  "webUrl": "https://teams.microsoft.com/l/channel/19%3ac2e36757ee744c569e70b385e6dd79b6%40thread.skype/tab%3a%3afd736d46-51ed-4c0b-9b23-e67ca354bb24?label=my%20%contoso%to%tab"
}

See also

Configuring the built-in tab types Microsoft Graph service-specific throttling limits