Pin a message in a chat

Namespace: microsoft.graph

Important

APIs under the /beta version in Microsoft Graph are subject to change. Use of these APIs in production applications is not supported. To determine whether an API is available in v1.0, use the Version selector.

Pin a chat message in the specified chat. This API cannot create a new chat; you must use the list chats 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.

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

POST /chats/{chat-Id}/pinnedMessages

Request headers

Name Description
Authorization Bearer {token}. Required.
Content-Type application/json. Required.

Request body

The request body should contain the chat message ID.

Response

If successful, this method returns a 201 Created response code and a pinnedChatMessageInfo object in the response body.

Examples

Request

The following is an example of a request.

POST https://graph.microsoft.com/beta/chats/19:2da4c29f6d7041eca70b638b43d45437@thread.v2/pinnedMessages
Content-Type: application/json
Content-length: 63

{
   "message@odata.bind":"https://graph.microsoft.com/beta/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.

HTTP/1.1 201 Created
Content-Type: application/json

{
  "@odata.type": "#microsoft.graph.pinnedChatMessageInfo",
  "id": "1616964509832"
}