Service | Microsoft Docs article | Related commit history on GitHub | Change details |
---|---|---|---|
v1.0 | Application Post Onlinemeetings | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/application-post-onlinemeetings.md | Content-Type: application/json } ``` --### Example 2: Create an online meeting in a Microsoft Teams channel with a user token --#### Request --The following is an example of a request. -->**Note:** The Object ID of the user token passed should be a member of the channel represented by **threadId** in the payload. --```http -POST https://graph.microsoft.com/beta/me/onlineMeetings -Content-Type: application/json --{ - "startDateTime":"2019-07-12T14:30:34.2444915-07:00", - "endDateTime":"2019-07-12T15:00:34.2464912-07:00", - "subject":"User meeting in Microsoft Teams channel.", - "chatInfo": { - "threadId":"19%3A3b5239894b776357c1dd79%40thread.skype" - } -} -``` -#### Response --The following is an example of the response. -->**Note:** The response object shown here might be shortened for readability. --<!-- { - "blockType": "example", - "truncated": true, - "@odata.type": "microsoft.graph.onlineMeeting" -} --> --```http -HTTP/1.1 201 Created -Content-Type: application/json --{ - "@odata.context": "https://graph.microsoft.com/beta/$metadata#users('f40f86-17cc-42e7-85f4-f03880d6')/onlineMeetings/$entity", - "audioConferencing": { - "tollNumber": "+12534478", - "tollFreeNumber": "+18660588", - "ConferenceId": "24229", - "dialinUrl": "https://dialin.teams.microsoft.com/22f12fa0-49f-45b-bc69-b8a330?id=24229" - }, - "chatInfo": { - "threadId": "19%3A3b52398f3c5244b776357c1dd79%40thread.skype", - "messageId": "1563302249053", - "replyChainMessageId": null - }, - "creationDateTime": "2019-07-11T02:17:17.6491364Z", - "startDateTime": "2019-07-11T02:17:17.6491364Z", - "endDateTime": "2019-07-11T02:47:17.651138Z", - "id": "MSpkYzE3Njc0Yy04MWQ5LTRhZGItHRTNaR1F6WGhyZWFkLnYy", - "joinWebUrl": "https://teams.microsoft.com/l/meetup-join/19%3ameeting_M2IzYzczNNlOTY4MGEz%40thread.skype/0?context=%7b%22Tid%22%3a%2288bf-86f1-41af-91ab-2011db47%22%2c%22Oid%22%3a%22fae72-d51-43ec-68c-3704f%22%7d", - "participants": { - "organizer": { - "identity": { - "user": { - "id": "55ae72-d251-43ec-868c-373704f", - "tenantId": "72f98f-86f1-41af-91ab-2d7db47", - "displayName": "Mario Rogers" - } - }, - "role": "presenter", - "upn": "upn-value" - } - }, - "subject": "User meeting in Microsoft Teams channel.", - "joinMeetingIdSettings": { - "isPasscodeRequired": false, - "joinMeetingId": "1234567890", - "passcode": null - } -} -``` --### Example 3: Create a Microsoft Teams live event with a user token +### Example 2: Create a Microsoft Teams live event with a user token #### Request The following is an example of the response. } --> -### Example 4: Create an online meeting that requires a passcode +### Example 3: Create an online meeting that requires a passcode The following example shows how to add a passcode to a meeting. The passcode is used when you join a meeting with a **joinMeetingId**. For more details, see [joinMeetingIdSettings](../resources/joinmeetingidsettings.md). #### Request Content-Type: application/json ``` -### Example 5: Create an online meeting that does not require a passcode +### Example 4: Create an online meeting that does not require a passcode When **isPasscodeRequired** is set to `false` or when **joinMeetingIdSettings** is not specified in the request, the generated online meeting will not have a passcode. #### Request |
v1.0 | Chat Delete Pinnedmessages | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/chat-delete-pinnedmessages.md | One of the following permissions is required to call this API. To learn more, in } --> ``` http-DELETE /chats/{chat-id}/pinnedMessages/{pinnedChatMessageInfoId} +DELETE /chats/{chat-id}/pinnedMessages/{pinnedChatMessageId} ``` ## Request headers |
v1.0 | Chat List Pinnedmessages | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/chat-list-pinnedmessages.md | Title: "List pinned messages in a chat" + Title: "List pinnedChatMessages in a chat" description: "Get a list of pinned messages in a chat." ms.localizationpriority: medium ms.prod: "microsoft-teams" doc_type: apiPageType -# List pinned messages in a chat +# List pinnedChatMessages in a chat Namespace: microsoft.graph [!INCLUDE [beta-disclaimer](../../includes/beta-disclaimer.md)] If successful, this method returns a `200 OK` response code and a collection of ### Example 1: List all the pinned messages in a chat The following example shows a request that lists all the pinned messages in a chat. -### Request +#### Request The following is an example of a request. # [HTTP](#tab/http) GET https://graph.microsoft.com/beta/chats/19:d65713bc498c4a428c71ef9353e6ce20@t -### Response +#### Response The following is an example of the response. >**Note:** The response object shown here might be shortened for readability. <!-- { Content-Type: application/json ### Example 2: List all the pinned messages in a chat along with the associated chat message The following example shows a request that lists all the pinned messages in a chat along with the associated chat message. -### Request +#### Request The following is an example of a request. # [HTTP](#tab/http) GET https://graph.microsoft.com/beta/chats/19:d65713bc498c4a428c71ef9353e6ce20@t -### Response +#### Response The following is an example of the response. >**Note:** The response object shown here might be shortened for readability. <!-- { |
v1.0 | Chat Post Pinnedmessages | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/chat-post-pinnedmessages.md | POST /chats/{chat-Id}/pinnedMessages |Content-Type|application/json. Required.| ## Request body-The request body should contain the chat message ID. +In the request body, supply the ID of a chat message to pin. ## Response |
v1.0 | Device List Registeredowners | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/device-list-registeredowners.md | GET /devices/{id}/registeredOwners > Note: The "id" in the request is the "id" property of the device, not the "deviceId" property. ## Optional query parameters+ This method supports the `$search`, `$count`, and `$filter` [OData query parameters](/graph/query-parameters) to help customize the response. OData cast is also enabled, for example, you can cast to get just the directoryRoles the device is a member of. You can use `$search` on the **displayName** property. Some queries are supported only when you use the **ConsistencyLevel** header set to `eventual` and `$count`. For more information, see [Advanced query capabilities on Azure AD directory objects](/graph/aad-advanced-queries).++When items are added or updated for this resource, they are specially indexed for use with the `$count` and `$search` query parameters. There can be a slight delay between when an item is added or updated and when it is available in the index. + ## Request headers | Name | Description| |:--|:| |
v1.0 | Educationcategory Delete | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/educationcategory-delete.md | One of the following permissions is required to call this API. To learn more, in | Permission type | Permissions (from least to most privileged) | | :- | : | | Delegated (work or school account) | EduAssignments.ReadWriteBasic, EduAssignments.ReadWrite |-| Delegated (personal Microsoft account) | Not Supported. | -| Application | Not Supported. | +| Delegated (personal Microsoft account) | Not supported. | +| Application | Not supported. | ## HTTP request |
v1.0 | Group List Members | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/group-list-members.md | GET /groups/{id}/members ## Optional query parameters -This method supports the [OData query parameters](/graph/query-parameters) to help customize the response, including `$search`, `$count`, and `$filter`. OData cast is also enabled, for example, you can cast to get just the users that are a member of the group. You can use `$search` on the **displayName** property. When items are added or updated for this resource, they are specially indexed for use with the `$count` and `$search` query parameters. There can be a slight delay between when an item is added or updated and when it is available in the index. +This method supports the `$filter`, `$count`, `$select`, `$search`, and `$expand` [OData query parameters](/graph/query-parameters) to help customize the response. OData cast is also enabled, for example, you can cast to get just the group members that are users. You can use `$search` on the **displayName** and **description** properties. When items are added or updated for this resource, they are specially indexed for use with the `$count` and `$search` query parameters. There can be a slight delay between when an item is added or updated and when it is available in the index. ## Request headers |
v1.0 | Group List Owners | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/group-list-owners.md | Title: "List owners" + Title: "List group owners" description: "Retrieve a list of the group's owners." ms.localizationpriority: medium ms.prod: "groups" doc_type: apiPageType -# List owners +# List group owners Namespace: microsoft.graph GET /groups/{id}/owners ## Optional query parameters -This method supports the [OData Query Parameters](/graph/query-parameters) to help customize the response. +This method supports the `$filter`, `$count`, `$select`, `$search`, and `$expand` [OData query parameters](/graph/query-parameters) to help customize the response. OData cast is also enabled, for example, you can cast to get just the group owners that are users. You can use `$search` on the **displayName** and **description** properties. When items are added or updated for this resource, they are specially indexed for use with the `$count` and `$search` query parameters. There can be a slight delay between when an item is added or updated and when it is available in the index. ## Request headers |
v1.0 | Chat | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/resources/chat.md | A chat is a collection of [chatMessages](chatmessage.md) between one or more par |[Pin a message](../api/chat-post-pinnedmessages.md)|[pinnedChatMessageInfo](../resources/pinnedchatmessageinfo.md)|Pin a chat message in a chat.| |[Unpin a message](../api/chat-delete-pinnedmessages.md)|None|Unpin a message from a chat.| ->**Note:** When using application permissions, be sure you know how you're going to get the chat ID. Because listing chats with application permissions is not supported, -not all scenarios are possible. It is possible to get chat IDs with delegated permissions, and from [change notifications for /chats/getAllMessages](../api/subscription-post-subscriptions.md) with application permissions. +>**Note:** When using application permissions, be sure you know how to get the chat ID. Because listing chats with application permissions is not supported, not all scenarios are possible. It is possible to get chat IDs with delegated permissions, and from [change notifications for /chats/getAllMessages](../api/subscription-post-subscriptions.md) with application permissions. ## Properties |
v1.0 | Chat Delete Pinnedmessages | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/v1.0/api/chat-delete-pinnedmessages.md | + + Title: "Unpin a message from a chat" +description: "Unpin a message from a chat." ++ms.localizationpriority: medium +++# Unpin a message from a chat +Namespace: microsoft.graph ++Unpin a message from a [chat](../resources/chat.md). ++## Permissions +One of the following permissions is required to call this API. To learn more, including how to choose permissions, see [Permissions](/graph/permissions-reference). ++|Permission type|Permissions (from least to most privileged)| +|:|:| +|Delegated (work or school account) | Chat.ReadWrite | +|Delegated (personal Microsoft account) | Not supported. | +|Application | Chat.ReadWrite.All | ++## HTTP request ++<!-- { + "blockType": "ignored" +} +--> +``` http +DELETE /chats/{chat-id}/pinnedMessages/{pinnedChatMessageId} +``` ++## Request headers +|Name|Description| +|:|:| +|Authorization|Bearer {token}. Required.| ++## Request body +Do not supply a request body for this method. ++## Response ++If successful, this method returns a `204 No Content` response code. ++## Examples ++### Request +The following is an example of a request. +<!-- { + "blockType": "request", + "name": "delete_pinnedchatmessageinfo", + "sampleKeys": ["19:cf66807577b149cca1b7af0c32eec122@thread.v2", "1616964509832"] +} +--> +``` http +DELETE https://graph.microsoft.com/v1.0/chats/19:cf66807577b149cca1b7af0c32eec122@thread.v2/pinnedMessages/1616964509832 +``` ++### Response +The following is an example of the response. ++<!-- { + "blockType": "response", + "truncated": true +} +--> +``` http +HTTP/1.1 204 No Content +``` |
v1.0 | Chat List Pinnedmessages | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/v1.0/api/chat-list-pinnedmessages.md | + + Title: "List pinnedChatMessages in a chat" +description: "Get a list of pinned messages in a chat." ++ms.localizationpriority: medium +++# List pinnedChatMessages in a chat +Namespace: microsoft.graph ++Get a list of [pinnedChatMessages](../resources/pinnedChatMessageInfo.md) in a [chat](../resources/chat.md). ++## Permissions +One of the following permissions is required to call this API. To learn more, including how to choose permissions, see [Permissions](/graph/permissions-reference). ++|Permission type|Permissions (from least to most privileged)| +|:|:| +|Delegated (work or school account) | Chat.Read, Chat.ReadWrite | +|Delegated (personal Microsoft account) | Not supported. | +|Application | ChatMessage.Read.All, Chat.Read.All, Chat.ReadWrite.All | ++## HTTP request ++<!-- { + "blockType": "ignored" +} +--> +``` http +GET /chats/{chat-id}/pinnedMessages +``` ++## Optional query parameters +This method supports the `$expand` [OData query parameter](/graph/query-parameters) to help customize the response. ++## Request headers +|Name|Description| +|:|:| +|Authorization|Bearer {token}. Required.| ++## Request body +Do not supply a request body for this method. ++## Response ++If successful, this method returns a `200 OK` response code and a collection of [pinnedChatMessageInfo](../resources/pinnedchatmessageinfo.md) objects in the response body. ++## Examples ++### Example 1: List all the pinned messages in a chat +The following example shows a request that lists all the pinned messages in a chat. ++#### Request +The following is an example of a request. +<!-- { + "blockType": "request", + "name": "list_pinnedmessage_for_chat", + "sampleKeys": ["19:d65713bc498c4a428c71ef9353e6ce20@thread.v2"] +} +--> +``` http +GET https://graph.microsoft.com/v1.0/chats/19:d65713bc498c4a428c71ef9353e6ce20@thread.v2/pinnedMessages +``` ++#### Response +The following is an example of the response. +>**Note:** The response object shown here might be shortened for readability. +<!-- { + "blockType": "response", + "truncated": true, + "@odata.type": "microsoft.graph.pinnedChatMessageInfo", + "isCollection": true +} +--> +``` http +HTTP/1.1 200 OK +Content-Type: application/json ++{ + "value": [ + { + "@odata.type": "#microsoft.graph.pinnedChatMessageInfo", + "id": "1616964509832" + }, + { + "@odata.type": "#microsoft.graph.pinnedChatMessageInfo", + "id": "1615971548136" + } + ] +} +``` ++### Example 2: List all the pinned messages in a chat along with the associated chat message +The following example shows a request that lists all the pinned messages in a chat along with the associated chat message. ++#### Request +The following is an example of a request. +<!-- { + "blockType": "request", + "name": "list_pinnedmessage_for_chat_expand_message", + "sampleKeys": ["19:d65713bc498c4a428c71ef9353e6ce20@thread.v2"] +} +--> +``` http +GET https://graph.microsoft.com/v1.0/chats/19:d65713bc498c4a428c71ef9353e6ce20@thread.v2/pinnedMessages?$expand=message +``` ++#### Response +The following is an example of the response. +>**Note:** The response object shown here might be shortened for readability. +<!-- { + "blockType": "response", + "truncated": true, + "@odata.type": "microsoft.graph.pinnedChatMessageInfo", + "isCollection": true +} +--> +``` http +HTTP/1.1 200 OK +Content-Type: application/json ++{ + "value": [ + { + "id": "1616964509832", + "message": { + "id": "1616964509832", + "replyToId": null, + "etag": "1616964509832", + "messageType": "message", + "createdDateTime": "2021-03-28T20:48:29.832Z", + "lastModifiedDateTime": "2021-03-28T20:48:29.832Z", + "lastEditedDateTime": null, + "deletedDateTime": null, + "subject": null, + "summary": null, + "chatId": "19:2da4c29f6d7041eca70b638b43d45437@thread.v2", + "importance": "normal", + "locale": "en-us", + "webUrl": null, + "channelIdentity": null, + "onBehalfOf": null, + "policyViolation": null, + "eventDetail": null, + "from": { + "application": null, + "device": null, + "user": { + "id": "8ea0e38b-efb3-4757-924a-5f94061cf8c2", + "displayName": "Robin Kline", + "userIdentityType": "aadUser" + } + }, + "body": { + "contentType": "text", + "content": "Hello world" + }, + "attachments": [], + "mentions": [], + "reactions": [] + } + }, + { + "id": "1615971548136", + "message": { + "id": "1615971548136", + "replyToId": null, + "etag": "1615971548136", + "messageType": "message", + "createdDateTime": "2021-03-17T08:59:08.136Z", + "lastModifiedDateTime": "2021-03-17T08:59:08.136Z", + "lastEditedDateTime": null, + "deletedDateTime": null, + "subject": null, + "summary": null, + "chatId": "19:2da4c29f6d7041eca70b638b43d45437@thread.v2", + "importance": "normal", + "locale": "en-us", + "webUrl": null, + "channelIdentity": null, + "onBehalfOf": null, + "policyViolation": null, + "eventDetail": null, + "from": { + "application": null, + "device": null, + "user": { + "id": "8ea0e38b-efb3-4757-924a-5f94061cf8c2", + "displayName": "Robin Kline", + "userIdentityType": "aadUser" + } + }, + "body": { + "contentType": "html", + "content": "<div><div><div><span><img height=\"63\" src=\"https://graph.microsoft.com/v1.0/chats/19:2da4c29f6d7041eca70b638b43d45437@thread.v2/messages/1615971548136/hostedContents/aWQ9eF8wLXd1cy1kOS1lNTRmNjM1NWYxYmJkNGQ3ZTNmNGJhZmU4NTI5MTBmNix0eXBlPTEsdXJsPWh0dHBzOi8vdXMtYXBpLmFzbS5za3lwZS5jb20vdjEvb2JqZWN0cy8wLXd1cy1kOS1lNTRmNjM1NWYxYmJkNGQ3ZTNmNGJhZmU4NTI5MTBmNi92aWV3cy9pbWdv/$value\" width=\"67\" style=\"vertical-align:bottom; width:67px; height:63px\"></span></div></div></div>" + }, + "attachments": [], + "mentions": [], + "reactions": [] + } + } + ] +} +``` |
v1.0 | Chat Post Pinnedmessages | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/v1.0/api/chat-post-pinnedmessages.md | + + Title: "Pin a message in a chat" +description: "Pin a chat message in the specified chat." ++ms.localizationpriority: medium +++# Pin a message in a chat +Namespace: microsoft.graph ++Pin a chat message in the specified [chat](../resources/chat.md). This API cannot create a new chat; you must use the [list chats](chat-list.md) method to retrieve the ID of an existing chat before you can pin a chat message. ++## Permissions +One of the following permissions is required to call this API. To learn more, including how to choose permissions, see [Permissions](/graph/permissions-reference). ++|Permission type|Permissions (from least to most privileged)| +|:|:| +| Delegated (work or school account) | ChatMessage.Send, Chat.ReadWrite | +| Delegated (personal Microsoft account) | Not supported. | +| Application | Chat.ReadWrite.All | ++## HTTP request ++<!-- { + "blockType": "ignored" +} +--> +``` http +POST /chats/{chat-Id}/pinnedMessages +``` ++## Request headers +|Name|Description| +|:|:| +|Authorization|Bearer {token}. Required.| +|Content-Type|application/json. Required.| ++## Request body +In the request body, supply the ID of a chat message to pin. ++## Response ++If successful, this method returns a `201 Created` response code and a [pinnedChatMessageInfo](../resources/pinnedchatmessageinfo.md) object in the response body. ++## Examples ++### Request +The following is an example of a request. +<!-- { + "blockType": "request", + "name": "create_pinnedchatmessageinfo_from_", + "sampleKeys": ["19:2da4c29f6d7041eca70b638b43d45437@thread.v2"] +} +--> +``` http +POST https://graph.microsoft.com/v1.0/chats/19:2da4c29f6d7041eca70b638b43d45437@thread.v2/pinnedMessages +Content-Type: application/json +Content-length: 63 ++{ + "message@odata.bind":"https://graph.microsoft.com/v1.0/chats/19:2da4c29f6d7041eca70b638b43d45437@thread.v2/messages/1616964509832" +} +``` ++### Response +The following is an example of the response. +>**Note:** The response object shown here might be shortened for readability. +<!-- { + "blockType": "response", + "truncated": true, + "@odata.type": "microsoft.graph.pinnedChatMessageInfo" +} +--> +``` http +HTTP/1.1 201 Created +Content-Type: application/json ++{ + "@odata.type": "#microsoft.graph.pinnedChatMessageInfo", + "id": "1616964509832" +} +``` |
v1.0 | Device List Registeredowners | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/v1.0/api/device-list-registeredowners.md | One of the following permissions is required to call this API. To learn more, in GET /devices/{id}/registeredOwners ``` ## Optional query parameters+ This method supports the `$search`, `$count`, and `$filter` [OData query parameters](/graph/query-parameters) to help customize the response. OData cast is also enabled, for example, you can cast to get just the directoryRoles the device is a member of. You can use `$search` on the **displayName** property. Some queries are supported only when you use the **ConsistencyLevel** header set to `eventual` and `$count`. For more information, see [Advanced query capabilities on Azure AD directory objects](/graph/aad-advanced-queries). +When items are added or updated for this resource, they are specially indexed for use with the `$count` and `$search` query parameters. There can be a slight delay between when an item is added or updated and when it is available in the index. + ## Request headers | Name | Type | Description| |:--|:|:-| |
v1.0 | Educationcategory Delete | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/v1.0/api/educationcategory-delete.md | One of the following permissions is required to call this API. To learn more, in | Permission type | Permissions (from least to most privileged) | | :- | : | | Delegated (work or school account) | EduAssignments.ReadWriteBasic, EduAssignments.ReadWrite |-| Delegated (personal Microsoft account) | Not Supported. | -| Application | Not Supported. | +| Delegated (personal Microsoft account) | Not supported. | +| Application | Not supported. | ## HTTP request <!-- { "blockType": "ignored" } --> ```http-DELETE /education/classes/acdefc6b-2dc6-4e71-b1e9-6d9810ab1793/assignmentCategories/{id} +DELETE /education/classes/{id}/assignmentCategories/{id} ``` ## Request headers |
v1.0 | Group List Members | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/v1.0/api/group-list-members.md | Title: "List members" + Title: "List group members" description: "Get a list of the group's direct members. A group can have users, organizational contacts, devices, service principals and other groups as members." ms.localizationpriority: high ms.prod: "groups" doc_type: apiPageType -# List members +# List group members Namespace: microsoft.graph GET /groups/{id}/members ## Optional query parameters -This method supports the [OData query parameters](/graph/query-parameters) to help customize the response, including `$search`, `$count`, and `$filter`. OData cast is also enabled, for example, you can cast to get just the users that are a member of the group. You can use `$search` on the **displayName** and **description** properties. When items are added or updated for this resource, they are specially indexed for use with the `$count` and `$search` query parameters. There can be a slight delay between when an item is added or updated and when it is available in the index. +This method supports the `$filter`, `$count`, `$select`, `$search`, and `$expand` [OData query parameters](/graph/query-parameters) to help customize the response. OData cast is also enabled, for example, you can cast to get just the group members that are users. You can use `$search` on the **displayName** and **description** properties. When items are added or updated for this resource, they are specially indexed for use with the `$count` and `$search` query parameters. There can be a slight delay between when an item is added or updated and when it is available in the index. ## Request headers |
v1.0 | Group List Owners | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/v1.0/api/group-list-owners.md | Title: "List owners" + Title: "List group owners" description: "Retrieve a list of the group's owners. The owners are a set of non-admin users who are allowed to modify the group object. " ms.localizationpriority: high ms.prod: "groups" doc_type: apiPageType -# List owners +# List group owners Namespace: microsoft.graph GET /groups/{id}/owners ## Optional query parameters -This method supports the [OData Query Parameters](/graph/query-parameters) to help customize the response. +This method supports the `$filter`, `$count`, `$select`, `$search`, and `$expand` [OData query parameters](/graph/query-parameters) to help customize the response. OData cast is also enabled, for example, you can cast to get just the group owners that are users. You can use `$search` on the **displayName** and **description** properties. When items are added or updated for this resource, they are specially indexed for use with the `$count` and `$search` query parameters. There can be a slight delay between when an item is added or updated and when it is available in the index. ## Request headers |
v1.0 | Chat | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/v1.0/resources/chat.md | A chat is a collection of [chatMessages](chatmessage.md) between one or more par |[Add tab to chat](../api/chat-post-tabs.md) | [teamsTab](teamstab.md) | Add (pin) a tab to a chat (and associated meeting).| |[Update tab in chat](../api/chat-patch-tabs.md) | [teamsTab](teamstab.md) | Update the properties of a tab in a chat (and associated meeting).| |[Remove tab from chat](../api/chat-delete-tabs.md) | None | Remove (unpin) a tab from a chat (and associated meeting).|+| **Pinned messages** ||| +|[List pinned messages](../api/chat-list-pinnedmessages.md)|[pinnedChatMessageInfo](../resources/pinnedchatmessageinfo.md) collection|Get a list of pinned messages in a chat.| +|[Pin a message](../api/chat-post-pinnedmessages.md)|[pinnedChatMessageInfo](../resources/pinnedchatmessageinfo.md)|Pin a chat message in a chat.| +|[Unpin a message](../api/chat-delete-pinnedmessages.md)|None|Unpin a message from a chat.| ->**Note:** When using application permissions, be sure you know how you're going to get the chat ID. Because listing chats with application permissions is not supported, -not all scenarios are possible. It is possible to get chat IDs with delegated permissions, and from [change notifications for /chats/getAllMessages](../api/subscription-post-subscriptions.md) with application permissions. +>**Note:** When using application permissions, be sure you know how to get the chat ID. Because listing chats with application permissions is not supported, not all scenarios are possible. It is possible to get chat IDs with delegated permissions, and from [change notifications for /chats/getAllMessages](../api/subscription-post-subscriptions.md) with application permissions. ## Properties not all scenarios are possible. It is possible to get chat IDs with delegated pe | installedApps | [teamsAppInstallation](teamsappinstallation.md) collection | A collection of all the apps in the chat. Nullable. | | members | [conversationMember](conversationmember.md) collection | A collection of all the members in the chat. Nullable. | | messages | [chatMessage](chatmessage.md) collection | A collection of all the messages in the chat. Nullable. |+| pinnedMessages | [pinnedChatMessageInfo](pinnedchatmessageinfo.md) collection | A collection of all the pinned messages in the chat. Nullable. | | tabs | [teamsTab](teamstab.md) collection | A collection of all the tabs in the chat. Nullable. | ## JSON representation |
v1.0 | Eventmessagedetail | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/v1.0/resources/eventmessagedetail.md | Represents details of a system event message. System messages are messages generated for events such as [members](../resources/conversationMember.md) added to a [channel](../resources/channel.md), **members** added to a [chat](../resources/chat.md), and [team](../resources/team.md) description updated. -List of events supported +### Supported events | Event | Description | | :- | :- | List of events supported | [membersDeletedEventMessageDetail](../resources/membersdeletedeventmessagedetail.md) | **Members** have been removed. | | [membersJoinedEventMessageDetail](../resources/membersjoinedeventmessagedetail.md) | **Members** have joined. | | [membersLeftEventMessageDetail](../resources/memberslefteventmessagedetail.md) | **Members** have left. |+| [messagePinnedEventMessageDetail](../resources/messagepinnedeventmessagedetail.md) | A message has been pinned. | +| [messageUnpinnedEventMessageDetail](../resources/messageunpinnedeventmessagedetail.md) | A message has been unpinned. | | [tabUpdatedEventMessageDetail](../resources/tabupdatedeventmessagedetail.md) | A tab has been updated. | | [teamArchivedEventMessageDetail](../resources/teamarchivedeventmessagedetail.md) | A **team** has been archived. | | [teamCreatedEventMessageDetail](../resources/teamcreatedeventmessagedetail.md) | A **team** has been created. | |
v1.0 | Messagepinnedeventmessagedetail | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/v1.0/resources/messagepinnedeventmessagedetail.md | + + Title: "messagePinnedEventMessageDetail resource type" +description: "Represents the details of an event message about a pinned chat message." ++ms.localizationpriority: medium +++# messagePinnedEventMessageDetail resource type ++Namespace: microsoft.graph ++Represents the details of an event message about a pinned [chatMessage](../resources/chatmessage.md). This message is generated when a chat message is pinned. ++Inherits from [eventMessageDetail](../resources/eventmessagedetail.md). ++## Properties +|Property|Type|Description| +|:|:|:| +|eventDateTime|DateTimeOffset|Date and time when the event occurred.| +|initiator|[identitySet](../resources/identityset.md)|Initiator of the event.| ++## JSON representation +The following is a JSON representation of the resource. +<!-- { + "blockType": "resource", + "@odata.type": "microsoft.graph.messagePinnedEventMessageDetail", + "baseType": "microsoft.graph.eventMessageDetail" +} +--> +``` json +{ + "@odata.type": "#microsoft.graph.messagePinnedEventMessageDetail", + "eventDateTime": "String (timestamp)", + "initiator": { + "@odata.type": "microsoft.graph.identitySet" + } +} +``` ++## See also +- [Example response for an event message about a pinned chat message](/graph/system-messages/#message-pinned) +- [System messages](/graph/system-messages) |
v1.0 | Messageunpinnedeventmessagedetail | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/v1.0/resources/messageunpinnedeventmessagedetail.md | + + Title: "messageUnpinnedEventMessageDetail resource type" +description: "Represents the details of an event message about an unpinned chat message." ++ms.localizationpriority: medium +++# messageUnpinnedEventMessageDetail resource type ++Namespace: microsoft.graph ++Represents the details of an event message about an unpinned [chatMessage](../resources/chatmessage.md). This message is generated when a chat message is unpinned. ++Inherits from [eventMessageDetail](../resources/eventmessagedetail.md). ++## Properties +|Property|Type|Description| +|:|:|:| +|eventDateTime|DateTimeOffset|Date and time when the event occurred.| +|initiator|[identitySet](../resources/identityset.md)|Initiator of the event.| ++## JSON representation +The following is a JSON representation of the resource. +<!-- { + "blockType": "resource", + "@odata.type": "microsoft.graph.messageUnpinnedEventMessageDetail", + "baseType": "microsoft.graph.eventMessageDetail" +} +--> +``` json +{ + "@odata.type": "#microsoft.graph.messageUnpinnedEventMessageDetail", + "eventDateTime": "String (timestamp)", + "initiator": { + "@odata.type": "microsoft.graph.identitySet" + } +} +``` ++## See also +- [Example response for an event message about an unpinned chat message](/graph/system-messages/#message-unpinned) +- [System messages](/graph/system-messages) |
v1.0 | Pinnedchatmessageinfo | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/v1.0/resources/pinnedchatmessageinfo.md | + + Title: "pinnedChatMessageInfo resource type" +description: "Represents an individual pinned message in a chat entity." ++ms.localizationpriority: medium +++# pinnedChatMessageInfo resource type ++Namespace: microsoft.graph ++Represents an individual pinned message in a [chat](chat.md). ++Inherits from [entity](../resources/entity.md). ++## Methods +|Method|Return type|Description| +|:|:|:| +|[List pinned messages](../api/chat-list-pinnedmessages.md)|[pinnedChatMessageInfo](../resources/pinnedchatmessageinfo.md) collection|Get a list of [pinnedChatMessages](../resources/pinnedChatMessageInfo.md) in a [chat](../resources/chat.md).| +|[Pin message](../api/chat-post-pinnedmessages.md)|[pinnedChatMessageInfo](../resources/pinnedchatmessageinfo.md)|Pin a chat message in the specified [chat](../resources/chat.md).| +|[Unpin message](../api/chat-delete-pinnedmessages.md)|None|Unpin a message from a [chat](../resources/chat.md).| ++## Properties +|Property|Type|Description| +|:|:|:| +| id| String| The ID of the [chatMessage](../resources/chatmessage.md). Read-only. | ++## Relationships +|Relationship|Type|Description| +|:|:|:| +| message | [chatMessage](../resources/chatmessage.md) | Represents details about the chat message that is pinned.| ++## JSON representation +The following is a JSON representation of the resource. +<!-- { + "blockType": "resource", + "keyProperty": "id", + "@odata.type": "microsoft.graph.pinnedChatMessageInfo", + "baseType": "microsoft.graph.entity", + "openType": false +} +--> +``` json +{ + "@odata.type": "#microsoft.graph.pinnedChatMessageInfo", + "id": "String (identifier)" +} +``` |
v1.0 | Toc.Yml | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/v1.0/toc.yml | a/api-reference/v1.0/toc.yml items: href: api/chat-post-messages.md - name: Get chat between user and app href: api/userscopeteamsappinstallation-get-chat.md+ - name: List pinned messages + href: api/chat-list-pinnedmessages.md + - name: Pin message + href: api/chat-post-pinnedmessages.md + - name: Unpin message + href: api/chat-delete-pinnedmessages.md - name: Chat message href: resources/chatmessage.md items: items: href: api/chats-getallmessages.md - name: Get hosted content href: api/chatmessagehostedcontent-get.md+ - name: List pinned messages + href: api/chat-list-pinnedmessages.md + - name: Pin message + href: api/chat-post-pinnedmessages.md + - name: Unpin message + href: api/chat-delete-pinnedmessages.md + - name: Pinned chat message + href: resources/pinnedchatmessageinfo.md + items: + - name: List pinned messages + href: api/chat-list-pinnedmessages.md + - name: Pin message + href: api/chat-post-pinnedmessages.md + - name: Unpin message + href: api/chat-delete-pinnedmessages.md - name: Team href: resources/team.md items: |