Namespace: microsoft.graph
Importante
As APIs na versão /beta no Microsoft Graph estão sujeitas a alterações. Não há suporte para o uso dessas APIs em aplicativos de produção. Para determinar se uma API está disponível na v1.0, use o seletor Versão.
Adicionar membros a um distributionList.
Essa API está disponível nas seguintes implantações de nuvem nacional.
| Serviço global |
Governo dos EUA L4 |
US Government L5 (DOD) |
China operada pela 21Vianet |
| ✅ |
❌ |
❌ |
❌ |
Permissões
Escolha a(s) permissão(s) marcada(s) como menos privilegiada(s) para essa API. Use uma permissão ou permissões com privilégios mais altos somente se o aplicativo exigir. Para obter detalhes sobre permissões delegadas e de aplicativo, consulte Tipos de permissão. Para saber mais sobre essas permissões, consulte a referência de permissões.
| Tipo de permissão |
Permissões menos privilegiadas |
Permissões com privilégios mais elevados |
| Delegado (conta corporativa ou de estudante) |
Contacts.ReadWrite |
Indisponível. |
| Delegado (conta pessoal da Microsoft) |
Contacts.ReadWrite |
Indisponível. |
| Aplicativo |
Contacts.ReadWrite |
Indisponível. |
Solicitação HTTP
POST /me/distributionLists/{distributionList-id}/addMembers
POST /users/{id | userPrincipalName}/distributionLists/{distributionList-id}/addMembers
| Nome |
Descrição |
| Autorização |
{token} de portador. Obrigatório. Saiba mais sobre autenticação e autorização. |
| Content-Type |
application/json. Obrigatório. |
Corpo da solicitação
No corpo da solicitação, forneça uma representação JSON dos parâmetros.
A tabela a seguir lista os parâmetros necessários quando você chama essa ação.
| Parâmetro |
Tipo |
Descrição |
| membros |
coleção de membros |
Os membros a serem adicionados à lista de distribuição. Cada membro deve incluir type e key, memberId ou ambos. Obrigatório. |
Resposta
Se for bem-sucedida, essa ação retornará um código de 200 OK resposta e um objeto distributionList no corpo da resposta.
Exemplos
Solicitação
O exemplo a seguir mostra uma solicitação.
POST https://graph.microsoft.com/beta/me/distributionLists/AAMkAGI2THVSAAA=/addMembers
Content-Type: application/json
{
"members": [
{
"displayName": "Megan Bowen",
"key": "MeganB@contoso.com",
"type": "mailbox"
}
]
}
// 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",
Type = 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);
// 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)
type := graphmodels.MAILBOX_RECIPIENTTYPE
member.SetType(&type)
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)
// 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.setType(RecipientType.Mailbox);
members.add(member);
addMembersPostRequestBody.setMembers(members);
var result = graphClient.me().distributionLists().byDistributionListId("{distributionList-id}").addMembers().post(addMembersPostRequestBody);
const options = {
authProvider,
};
const client = Client.init(options);
const distributionList = {
members: [
{
displayName: 'Megan Bowen',
key: 'MeganB@contoso.com',
type: 'mailbox'
}
]
};
await client.api('/me/distributionLists/AAMkAGI2THVSAAA=/addMembers')
.version('beta')
.post(distributionList);
<?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->setType(new RecipientType('mailbox'));
$membersArray []= $membersMember1;
$requestBody->setMembers($membersArray);
$result = $graphServiceClient->me()->distributionLists()->byDistributionListId('distributionList-id')->addMembers()->post($requestBody)->wait();
# 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",
type = RecipientType.Mailbox,
),
],
)
result = await graph_client.me.distribution_lists.by_distribution_list_id('distributionList-id').add_members.post(request_body)
Resposta
O exemplo a seguir mostra a resposta.
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"
}