Skip to content

plannertask-post-messages.md

Latest commit

 

History

History
241 lines (187 loc) · 8.29 KB

plannertask-post-messages.md

File metadata and controls

241 lines (187 loc) · 8.29 KB
title Create plannerTaskChatMessage
description Create a new chat message on a planner task.
author pavlodatsiuk
ms.localizationpriority medium
ms.subservice planner
doc_type apiPageType
ms.date 01/23/2026

Create plannerTaskChatMessage

Namespace: microsoft.graph

[!INCLUDE beta-disclaimer]

Create a new plannerTaskChatMessage on a plannerTask.

Important

This method only supports creating a new chat message on a plannerTask that already has at least one existing message.

[!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.

[!INCLUDE permissions-table]

HTTP request

POST /planner/tasks/{task-id}/messages

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 a JSON representation of a plannerTaskChatMessage object.

The following table lists the properties that you can set when you create a plannerTaskChatMessage.

Property Type Description
content String The content of the chat message. This property supports plain text and sanitized HTML. Required.
mentions plannerTaskChatMention collection The list of mentions in the message. Optional.

Response

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

This method can return any of the HTTP status codes. The most common errors that apps should handle for this method are the 400, 403, and 404 responses. For more information about these errors, see Common Planner error conditions.

Examples

Example 1: Create a message

Request

The following example shows a request to create a chat message.

HTTP

POST https://graph.microsoft.com/beta/planner/tasks/01gzSlKkIUSUl6DF_EilrmQAKDhh/messages
Content-type: application/json

{
  "content": "This is a new chat message"
}

C#

[!INCLUDE sample-code] [!INCLUDE sdk-documentation]

Go

[!INCLUDE sample-code] [!INCLUDE sdk-documentation]

Java

[!INCLUDE sample-code] [!INCLUDE sdk-documentation]

JavaScript

[!INCLUDE sample-code] [!INCLUDE sdk-documentation]

PHP

[!INCLUDE sample-code] [!INCLUDE sdk-documentation]

Python

[!INCLUDE sample-code] [!INCLUDE sdk-documentation]

Response

The following example shows the response.

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

{
  "@odata.context": "https://graph.microsoft.com/beta/$metadata#planner/tasks('01gzSlKkIUSUl6DF_EilrmQAKDhh')/messages/$entity",
  "id": "5bde7bc8-d998-4e8a-8159-93d4d7ccc3b5",
  "messageType": "richTextHtml",
  "content": "This is a new chat message",
  "createdDateTime": "2025-12-05T17:49:39.593Z",
  "parentEntityId": "01gzSlKkIUSUl6DF_EilrmQAKDhh",
  "deletedTime": null,
  "editedTime": null,
  "mentions": [],
  "reactions": [],
  "createdBy": {
    "user": {
      "id": "6463a5ce-2119-4198-9f2a-628761df4a62"
    }
  }
}

Example 2: Create a message with mentions

Request

The following example shows a request to create a chat message with a user mention.

HTTP

POST https://graph.microsoft.com/beta/planner/tasks/01gzSlKkIUSUl6DF_EilrmQAKDhh/messages
Content-type: application/json

{
  "content": "<div><span itemid=\"0\" itemtype=\"https://schema.skype.com/Mention/Person\"></span> Please review this task</div>",
  "mentions": [
    {
      "mentioned": "6463a5ce-2119-4198-9f2a-628761df4a62",
      "position": 0,
      "mentionType": "user"
    }
  ]
}

C#

[!INCLUDE sample-code] [!INCLUDE sdk-documentation]

Go

[!INCLUDE sample-code] [!INCLUDE sdk-documentation]

Java

[!INCLUDE sample-code] [!INCLUDE sdk-documentation]

JavaScript

[!INCLUDE sample-code] [!INCLUDE sdk-documentation]

PHP

[!INCLUDE sample-code] [!INCLUDE sdk-documentation]

Python

[!INCLUDE sample-code] [!INCLUDE sdk-documentation]

Response

The following example shows the response.

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

{
  "@odata.context": "https://graph.microsoft.com/beta/$metadata#planner/tasks('01gzSlKkIUSUl6DF_EilrmQAKDhh')/messages/$entity",
  "id": "7cde8bc9-e109-5f9b-9260-04e5e8ddc4c6",
  "messageType": "richTextHtml",
  "content": "<div><span itemid=\"0\" itemtype=\"https://schema.skype.com/Mention/Person\"></span> Please review this task</div>",
  "createdDateTime": "2025-12-05T17:49:39.593Z",
  "parentEntityId": "01gzSlKkIUSUl6DF_EilrmQAKDhh",
  "deletedTime": null,
  "editedTime": null,
  "mentions": [
    {
      "mentioned": "6463a5ce-2119-4198-9f2a-628761df4a62",
      "position": 0,
      "mentionType": "user"
    }
  ],
  "reactions": [],
  "createdBy": {
    "user": {
      "id": "6463a5ce-2119-4198-9f2a-628761df4a62"
    }
  }
}