Pin a message in a chat

Namespace: microsoft.graph

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.


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

In the request body, supply the ID of a chat message to pin.


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



The following is an example of a request.

Content-Type: application/json
Content-length: 63



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"

See also