Edit

distributionList resource type

Namespace: microsoft.graph

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 personal distribution lists in the user's mailbox.
Create distributionList Create a new personal distribution list 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 distributionList Add members to a distributionList.
Delete members distributionList Remove members from 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.
notes String Notes about the distribution list.
personId String The unique identifier of the distribution list in the mailbox. Read-only.

Relationships

Relationship Type Description
members distributionListMember collection The members of the distribution list. Not returned by default; use $expand=members to include. Read-only.
singleValueExtendedProperties singleValueLegacyExtendedProperty collection The collection of single-value extended properties defined for the distribution list. 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",
  "notes": "String",
  "personId": "String"
}