conversationThread resource type
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.
A conversationThread is a collection of posts.
The last post's recipients collection is the aggregated recipients of the entire thread. A thread can have a growing collection of recipients. A new thread is created when a recipient is removed from the thread.
Methods
| Method | Return Type | Description |
|---|---|---|
| List threads | conversationThread collection | Get all the threads of a group. |
| Create thread | conversationThread | Start a new conversation by first creating a thread. A new conversation, conversation thread, and post are created in the group. |
| Get conversationThread | conversationThread | Get a specific thread that belongs to a group. |
| Update | conversationThread | Update conversationThread object. |
| Delete | None | Delete conversationThread object. |
| Reply to conversation thread | None | Reply to this thread by creating a new Post entity. |
| List posts | post collection | Get the posts of the specified thread. |
Properties
| Property | Type | Description |
|---|---|---|
| id | String | Read-only. Returned by default. |
| toRecipients | recipient collection | The To: recipients for the thread. Returned only on $select. |
| ccRecipients | recipient collection | The Cc: recipients for the thread. Returned only on $select. |
| topic | String | The topic of the conversation. This property can be set when the conversation is created, but it cannot be updated. Returned by default. |
| hasAttachments | Boolean | Indicates whether any of the posts within this thread has at least one attachment. Returned by default. |
| lastDeliveredDateTime | DateTimeOffset | The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z. Returned by default. |
| uniqueSenders | String collection | All the users that sent a message to this thread. Returned by default. |
| preview | String | A short summary from the body of the latest post in this conversation. Returned by default. |
| isLocked | Boolean | Indicates if the thread is locked. Returned by default. |
Relationships
| Relationship | Type | Description |
|---|---|---|
| posts | post collection | Read-only. Nullable. |
JSON representation
The following JSON representation shows the resource type.
{
"ccRecipients": [{"@odata.type": "microsoft.graph.recipient"}],
"hasAttachments": true,
"id": "string (identifier)",
"isLocked": true,
"lastDeliveredDateTime": "String (timestamp)",
"preview": "string",
"toRecipients": [{"@odata.type": "microsoft.graph.recipient"}],
"topic": "string",
"uniqueSenders": ["string"]
}