Note
Access to this page requires authorization. You can try signing in or changing directories.
Access to this page requires authorization. You can try changing directories.
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.
Represents a personal distribution list in the user's mailbox. A distribution list enables users to group email recipients together so they can send a message to all members at once, without entering each address individually.
Inherits from outlookItem.
Methods
| Method | Return type | Description |
|---|---|---|
| List | distributionList collection | Get a list of the distributionList objects in the user's mailbox. |
| Create | distributionList | Create a new distributionList in the user's mailbox. |
| Get | distributionList | Read the properties and relationships of a distributionList object. |
| Update | distributionList | Update the properties of a distributionList object. |
| Delete | None | Delete a distributionList object. |
| Add members | None | Add members to a distributionList. |
| Delete members | None | Remove members from a distributionList. |
| List members | distributionListMember collection | Get the expanded member list of a distributionList. |
| Get member | distributionListMember | Get a single expanded member of a distributionList. |
Properties
| Property | Type | Description |
|---|---|---|
| categories | String collection | The categories associated with the distribution list. Inherited from outlookItem. |
| changeKey | String | Version identifier used for optimistic concurrency control via the If-Match header. Read-only. Inherited from outlookItem. |
| createdDateTime | DateTimeOffset | The date and time when the distribution list was created. The timestamp type represents date and time information using ISO 8601 format and is always in UTC. For example, midnight UTC on Jan 1, 2024, is 2024-01-01T00:00:00Z. Read-only. Inherited from outlookItem. |
| displayName | String | The display name of the distribution list. |
| id | String | The unique identifier for the distribution list. Read-only. Inherited from outlookItem. |
| lastModifiedDateTime | DateTimeOffset | The date and time when the distribution list was last modified. The timestamp type represents date and time information using ISO 8601 format and is always in UTC. For example, midnight UTC on Jan 1, 2024, is 2024-01-01T00:00:00Z. Read-only. Inherited from outlookItem. |
| members | member collection | The list of members in the distribution list. Not returned by default; use $select=members to include. |
Relationships
| Relationship | Type | Description |
|---|---|---|
| distributionListMembers | distributionListMember collection | The expanded members of the distribution list. Each member contains detailed information including resolved email addresses. Read-only. |
JSON representation
The following JSON representation shows the resource type.
{
"@odata.type": "#microsoft.graph.distributionList",
"id": "string (identifier)",
"createdDateTime": "string (timestamp)",
"lastModifiedDateTime": "string (timestamp)",
"changeKey": "string",
"categories": [
"string"
],
"displayName": "string",
"members": [
{
"@odata.type": "microsoft.graph.member"
}
]
}