Create distributionList

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.

Create a new distributionList in the user's mailbox.

This API is available in the following national cloud deployments.

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

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.

Permission type	Least privileged permissions	Higher privileged permissions
Delegated (work or school account)	Contacts.ReadWrite	Not available.
Delegated (personal Microsoft account)	Contacts.ReadWrite	Not available.
Application	Contacts.ReadWrite	Not available.

HTTP request

POST /me/distributionLists
POST /users/{id | userPrincipalName}/distributionLists

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 the distributionList object.

You can specify the following properties when you create a distributionList.

Property	Type	Description
displayName	String	The display name of the distribution list. Required.
members	member collection	The list of members to add to the distribution list. Optional.

Response

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

Examples

Request

The following example shows a request.

HTTP

POST https://graph.microsoft.com/beta/me/distributionLists
Content-Type: application/json

{
  "displayName": "Project Team",
  "members": [
    {
      "displayName": "Adele Vance",
      "emailAddress": "AdeleV@contoso.com",
      "recipientType": "mailbox"
    },
    {
      "displayName": "Alex Wilber",
      "emailAddress": "AlexW@contoso.com",
      "recipientType": "mailbox"
    }
  ]
}

C#

// Code snippets are only available for the latest version. Current version is 5.x

// Dependencies
using Microsoft.Graph.Beta.Models;

var requestBody = new DistributionList
{
	DisplayName = "Project Team",
	Members = new List<Member>
	{
		new Member
		{
			DisplayName = "Adele Vance",
			RecipientType = RecipientType.Mailbox,
			AdditionalData = new Dictionary<string, object>
			{
				{
					"emailAddress" , "AdeleV@contoso.com"
				},
			},
		},
		new Member
		{
			DisplayName = "Alex Wilber",
			RecipientType = RecipientType.Mailbox,
			AdditionalData = new Dictionary<string, object>
			{
				{
					"emailAddress" , "AlexW@contoso.com"
				},
			},
		},
	},
};

// To initialize your graphClient, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=csharp
var result = await graphClient.Me.DistributionLists.PostAsync(requestBody);

Important

Microsoft Graph SDKs use the v1.0 version of the API by default, and do not support all the types, properties, and APIs available in the beta version. For details about accessing the beta API with the SDK, see Use the Microsoft Graph SDKs with the beta API.

For details about how to add the SDK to your project and create an authProvider instance, see the SDK documentation.

Go

// Code snippets are only available for the latest major version. Current major version is $v0.*

// Dependencies
import (
	  "context"
	  msgraphsdk "github.com/microsoftgraph/msgraph-beta-sdk-go"
	  graphmodels "github.com/microsoftgraph/msgraph-beta-sdk-go/models"
	  //other-imports
)

requestBody := graphmodels.NewDistributionList()
displayName := "Project Team"
requestBody.SetDisplayName(&displayName) 


member := graphmodels.NewMember()
displayName := "Adele Vance"
member.SetDisplayName(&displayName) 
recipientType := graphmodels.MAILBOX_RECIPIENTTYPE 
member.SetRecipientType(&recipientType) 
additionalData := map[string]interface{}{
	"emailAddress" : "AdeleV@contoso.com", 
}
member.SetAdditionalData(additionalData)
member1 := graphmodels.NewMember()
displayName := "Alex Wilber"
member1.SetDisplayName(&displayName) 
recipientType := graphmodels.MAILBOX_RECIPIENTTYPE 
member1.SetRecipientType(&recipientType) 
additionalData := map[string]interface{}{
	"emailAddress" : "AlexW@contoso.com", 
}
member1.SetAdditionalData(additionalData)

members := []graphmodels.Memberable {
	member,
	member1,
}
requestBody.SetMembers(members)

// To initialize your graphClient, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=go
distributionLists, err := graphClient.Me().DistributionLists().Post(context.Background(), requestBody, nil)

Important

Microsoft Graph SDKs use the v1.0 version of the API by default, and do not support all the types, properties, and APIs available in the beta version. For details about accessing the beta API with the SDK, see Use the Microsoft Graph SDKs with the beta API.

For details about how to add the SDK to your project and create an authProvider instance, see the SDK documentation.

Java

// Code snippets are only available for the latest version. Current version is 6.x

GraphServiceClient graphClient = new GraphServiceClient(requestAdapter);

DistributionList distributionList = new DistributionList();
distributionList.setDisplayName("Project Team");
LinkedList<Member> members = new LinkedList<Member>();
Member member = new Member();
member.setDisplayName("Adele Vance");
member.setRecipientType(RecipientType.Mailbox);
HashMap<String, Object> additionalData = new HashMap<String, Object>();
additionalData.put("emailAddress", "AdeleV@contoso.com");
member.setAdditionalData(additionalData);
members.add(member);
Member member1 = new Member();
member1.setDisplayName("Alex Wilber");
member1.setRecipientType(RecipientType.Mailbox);
HashMap<String, Object> additionalData1 = new HashMap<String, Object>();
additionalData1.put("emailAddress", "AlexW@contoso.com");
member1.setAdditionalData(additionalData1);
members.add(member1);
distributionList.setMembers(members);
DistributionList result = graphClient.me().distributionLists().post(distributionList);

Important

Microsoft Graph SDKs use the v1.0 version of the API by default, and do not support all the types, properties, and APIs available in the beta version. For details about accessing the beta API with the SDK, see Use the Microsoft Graph SDKs with the beta API.

For details about how to add the SDK to your project and create an authProvider instance, see the SDK documentation.

JavaScript

const options = {
	authProvider,
};

const client = Client.init(options);

const distributionList = {
  displayName: 'Project Team',
  members: [
    {
      displayName: 'Adele Vance',
      emailAddress: 'AdeleV@contoso.com',
      recipientType: 'mailbox'
    },
    {
      displayName: 'Alex Wilber',
      emailAddress: 'AlexW@contoso.com',
      recipientType: 'mailbox'
    }
  ]
};

await client.api('/me/distributionLists')
	.version('beta')
	.post(distributionList);

Important

Microsoft Graph SDKs use the v1.0 version of the API by default, and do not support all the types, properties, and APIs available in the beta version. For details about accessing the beta API with the SDK, see Use the Microsoft Graph SDKs with the beta API.

For details about how to add the SDK to your project and create an authProvider instance, see the SDK documentation.

PHP

<?php
use Microsoft\Graph\Beta\GraphServiceClient;
use Microsoft\Graph\Beta\Generated\Models\DistributionList;
use Microsoft\Graph\Beta\Generated\Models\Member;
use Microsoft\Graph\Beta\Generated\Models\RecipientType;


$graphServiceClient = new GraphServiceClient($tokenRequestContext, $scopes);

$requestBody = new DistributionList();
$requestBody->setDisplayName('Project Team');
$membersMember1 = new Member();
$membersMember1->setDisplayName('Adele Vance');
$membersMember1->setRecipientType(new RecipientType('mailbox'));
$additionalData = [
	'emailAddress' => 'AdeleV@contoso.com',
];
$membersMember1->setAdditionalData($additionalData);
$membersArray []= $membersMember1;
$membersMember2 = new Member();
$membersMember2->setDisplayName('Alex Wilber');
$membersMember2->setRecipientType(new RecipientType('mailbox'));
$additionalData = [
	'emailAddress' => 'AlexW@contoso.com',
];
$membersMember2->setAdditionalData($additionalData);
$membersArray []= $membersMember2;
$requestBody->setMembers($membersArray);


$result = $graphServiceClient->me()->distributionLists()->post($requestBody)->wait();

Important

Microsoft Graph SDKs use the v1.0 version of the API by default, and do not support all the types, properties, and APIs available in the beta version. For details about accessing the beta API with the SDK, see Use the Microsoft Graph SDKs with the beta API.

For details about how to add the SDK to your project and create an authProvider instance, see the SDK documentation.

Python

# Code snippets are only available for the latest version. Current version is 1.x
from msgraph_beta import GraphServiceClient
from msgraph_beta.generated.models.distribution_list import DistributionList
from msgraph_beta.generated.models.member import Member
from msgraph_beta.generated.models.recipient_type import RecipientType
# To initialize your graph_client, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=python
request_body = DistributionList(
	display_name = "Project Team",
	members = [
		Member(
			display_name = "Adele Vance",
			recipient_type = RecipientType.Mailbox,
			additional_data = {
					"email_address" : "AdeleV@contoso.com",
			}
		),
		Member(
			display_name = "Alex Wilber",
			recipient_type = RecipientType.Mailbox,
			additional_data = {
					"email_address" : "AlexW@contoso.com",
			}
		),
	],
)

result = await graph_client.me.distribution_lists.post(request_body)

Important

Microsoft Graph SDKs use the v1.0 version of the API by default, and do not support all the types, properties, and APIs available in the beta version. For details about accessing the beta API with the SDK, see Use the Microsoft Graph SDKs with the beta API.

For details about how to add the SDK to your project and create an authProvider instance, see the 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#users('user-id')/distributionLists/$entity",
  "id": "AAMkAGI2THVSAAA=",
  "changeKey": "CQAAABYAAABE",
  "createdDateTime": "2024-03-15T10:30:00Z",
  "lastModifiedDateTime": "2024-03-15T10:30:00Z",
  "categories": [],
  "displayName": "Project Team",
  "members": [
    {
      "@odata.type": "#microsoft.graph.member",
      "displayName": "Adele Vance",
      "emailAddress": "AdeleV@contoso.com",
      "recipientType": "mailbox"
    },
    {
      "@odata.type": "#microsoft.graph.member",
      "displayName": "Alex Wilber",
      "emailAddress": "AlexW@contoso.com",
      "recipientType": "mailbox"
    }
  ]
}