distributionList: addMembers

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.

Add members to a distributionList.

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/{distributionList-id}/addMembers
POST /users/{id | userPrincipalName}/distributionLists/{distributionList-id}/addMembers

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 parameters.

The following table lists the parameters that are required when you call this action.

Parameter	Type	Description
members	member collection	The list of members to add to the distribution list. Each member must include an emailAddress. The displayName and recipientType properties are optional. Required.

Response

If successful, this action returns a 200 OK 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/AAMkAGI2THVSAAA=/addMembers
Content-Type: application/json

{
  "members": [
    {
      "displayName": "Megan Bowen",
      "key": "MeganB@contoso.com",
      "routingType": "SMTP",
      "recipientType": "mailbox"
    }
  ]
}

C#

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

// Dependencies
using Microsoft.Graph.Beta.Me.DistributionLists.Item.AddMembers;
using Microsoft.Graph.Beta.Models;

var requestBody = new AddMembersPostRequestBody
{
	Members = new List<Member>
	{
		new Member
		{
			DisplayName = "Megan Bowen",
			Key = "MeganB@contoso.com",
			RoutingType = "SMTP",
			RecipientType = RecipientType.Mailbox,
		},
	},
};

// 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["{distributionList-id}"].AddMembers.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"
	  graphusers "github.com/microsoftgraph/msgraph-beta-sdk-go/users"
	  graphmodels "github.com/microsoftgraph/msgraph-beta-sdk-go/models"
	  //other-imports
)

requestBody := graphusers.NewItemAddMembersPostRequestBody()


member := graphmodels.NewMember()
displayName := "Megan Bowen"
member.SetDisplayName(&displayName) 
key := "MeganB@contoso.com"
member.SetKey(&key) 
routingType := "SMTP"
member.SetRoutingType(&routingType) 
recipientType := graphmodels.MAILBOX_RECIPIENTTYPE 
member.SetRecipientType(&recipientType) 

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

// To initialize your graphClient, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=go
addMembers, err := graphClient.Me().DistributionLists().ByDistributionListId("distributionList-id").AddMembers().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);

com.microsoft.graph.beta.users.item.distributionlists.item.addmembers.AddMembersPostRequestBody addMembersPostRequestBody = new com.microsoft.graph.beta.users.item.distributionlists.item.addmembers.AddMembersPostRequestBody();
LinkedList<Member> members = new LinkedList<Member>();
Member member = new Member();
member.setDisplayName("Megan Bowen");
member.setKey("MeganB@contoso.com");
member.setRoutingType("SMTP");
member.setRecipientType(RecipientType.Mailbox);
members.add(member);
addMembersPostRequestBody.setMembers(members);
var result = graphClient.me().distributionLists().byDistributionListId("{distributionList-id}").addMembers().post(addMembersPostRequestBody);

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 = {
  members: [
    {
      displayName: 'Megan Bowen',
      key: 'MeganB@contoso.com',
      routingType: 'SMTP',
      recipientType: 'mailbox'
    }
  ]
};

await client.api('/me/distributionLists/AAMkAGI2THVSAAA=/addMembers')
	.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\Users\Item\DistributionLists\Item\AddMembers\AddMembersPostRequestBody;
use Microsoft\Graph\Beta\Generated\Models\Member;
use Microsoft\Graph\Beta\Generated\Models\RecipientType;


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

$requestBody = new AddMembersPostRequestBody();
$membersMember1 = new Member();
$membersMember1->setDisplayName('Megan Bowen');
$membersMember1->setKey('MeganB@contoso.com');
$membersMember1->setRoutingType('SMTP');
$membersMember1->setRecipientType(new RecipientType('mailbox'));
$membersArray []= $membersMember1;
$requestBody->setMembers($membersArray);


$result = $graphServiceClient->me()->distributionLists()->byDistributionListId('distributionList-id')->addMembers()->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.users.item.distributionlists.item.add_members.add_members_post_request_body import AddMembersPostRequestBody
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 = AddMembersPostRequestBody(
	members = [
		Member(
			display_name = "Megan Bowen",
			key = "MeganB@contoso.com",
			routing_type = "SMTP",
			recipient_type = RecipientType.Mailbox,
		),
	],
)

result = await graph_client.me.distribution_lists.by_distribution_list_id('distributionList-id').add_members.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 200 OK
Content-Type: application/json

{
  "@odata.context": "https://graph.microsoft.com/beta/$metadata#users('user-id')/distributionLists/$entity",
  "id": "AAMkAGI2THVSAAA=",
  "displayName": "Project Team",
  "lastModifiedDateTime": "2024-03-17T11:00:00Z"
}