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.

This API is available in the following national cloud deployments.

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


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.

Permission type Least privileged permissions Higher privileged permissions
Delegated (work or school account) ChatMessage.Send Chat.ReadWrite
Delegated (personal Microsoft account) Not supported. Not supported.
Application Chat.ReadWrite.All Not available.

HTTP request

POST /chats/{chat-Id}/pinnedMessages

Request headers

Name Description
Authorization Bearer {token}. Required. Learn more about authentication and authorization.
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 example shows a request.

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



The following example shows 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"