Create addresses

Namespace: microsoft.graph

Create a new itemAddress object in a user's profile.

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)	User.ReadWrite	User.ReadWrite.All
Delegated (personal Microsoft account)	User.ReadWrite	Not available.
Application	Not supported.	Not supported.

HTTP request

POST /me/profile/addresses
POST /users/{id | userPrincipalName}/profile/addresses

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 itemAddress object.

The following table shows the properties that are possible to set when creating a new itemAddress object in a user's profile.

Property	Type	Description
allowedAudiences	String	The audiences that are able to see the values contained within the entity. Inherited from itemFacet. Possible values are: me, family, contacts, groupMembers, organization, federatedOrganizations, everyone, unknownFutureValue.
detail	physicalAddress	Details about the address itself.
displayName	String	Friendly name the user has assigned to this address.
geoCoordinates	geoCoordinates	The geocoordinates of the address.
inference	inferenceData	Contains inference detail if the entity is inferred by the creating or modifying application. Inherited from itemFacet.
source	personDataSource	Where the values originated if synced from another service. Inherited from itemFacet.

Response

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

Examples

HTTP

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

{
  "displayName": "Home",
  "detail": {
    "type": "home",
    "postOfficeBox": null,
    "street": "221B Baker Street",
    "city": "London",
    "state": null,
    "countryOrRegion": "United Kingdom",
    "postalCode": "E14 3TD"
  }
}

C#

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

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

var requestBody = new ItemAddress
{
	DisplayName = "Home",
	Detail = new PhysicalAddress
	{
		Type = PhysicalAddressType.Home,
		PostOfficeBox = null,
		Street = "221B Baker Street",
		City = "London",
		State = null,
		CountryOrRegion = "United Kingdom",
		PostalCode = "E14 3TD",
	},
};

// To initialize your graphClient, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=csharp
var result = await graphClient.Me.Profile.Addresses.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.

CLI

// THE CLI IS IN PREVIEW. NON-PRODUCTION USE ONLY
mgc-beta users profile addresses create --user-id {user-id} --body '{\
  "displayName": "Home",\
  "detail": {\
    "type": "home",\
    "postOfficeBox": null,\
    "street": "221B Baker Street",\
    "city": "London",\
    "state": null,\
    "countryOrRegion": "United Kingdom",\
    "postalCode": "E14 3TD"\
  }\
}\
'

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

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

graphClient := msgraphsdk.NewGraphServiceClientWithCredentials(cred, scopes)


requestBody := graphmodels.NewItemAddress()
displayName := "Home"
requestBody.SetDisplayName(&displayName) 
detail := graphmodels.NewPhysicalAddress()
type := graphmodels.HOME_PHYSICALADDRESSTYPE 
detail.SetType(&type) 
postOfficeBox := null
detail.SetPostOfficeBox(&postOfficeBox) 
street := "221B Baker Street"
detail.SetStreet(&street) 
city := "London"
detail.SetCity(&city) 
state := null
detail.SetState(&state) 
countryOrRegion := "United Kingdom"
detail.SetCountryOrRegion(&countryOrRegion) 
postalCode := "E14 3TD"
detail.SetPostalCode(&postalCode) 
requestBody.SetDetail(detail)

addresses, err := graphClient.Me().Profile().Addresses().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);

ItemAddress itemAddress = new ItemAddress();
itemAddress.setDisplayName("Home");
PhysicalAddress detail = new PhysicalAddress();
detail.setType(PhysicalAddressType.Home);
detail.setPostOfficeBox(null);
detail.setStreet("221B Baker Street");
detail.setCity("London");
detail.setState(null);
detail.setCountryOrRegion("United Kingdom");
detail.setPostalCode("E14 3TD");
itemAddress.setDetail(detail);
ItemAddress result = graphClient.me().profile().addresses().post(itemAddress);

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 itemAddress = {
  displayName: 'Home',
  detail: {
    type: 'home',
    postOfficeBox: null,
    street: '221B Baker Street',
    city: 'London',
    state: null,
    countryOrRegion: 'United Kingdom',
    postalCode: 'E14 3TD'
  }
};

await client.api('/me/profile/addresses')
	.version('beta')
	.post(itemAddress);

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\GraphServiceClient;
use Microsoft\Graph\Generated\Models\ItemAddress;
use Microsoft\Graph\Generated\Models\PhysicalAddress;


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

$requestBody = new ItemAddress();
$requestBody->setDisplayName('Home');
$detail = new PhysicalAddress();
$detail->setType(new PhysicalAddressType('home'));
$detail->setPostOfficeBox(null);
$detail->setStreet('221B Baker Street');
$detail->setCity('London');
$detail->setState(null);
$detail->setCountryOrRegion('United Kingdom');
$detail->setPostalCode('E14 3TD');
$requestBody->setDetail($detail);

$result = $graphServiceClient->me()->profile()->addresses()->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.

PowerShell

Import-Module Microsoft.Graph.Beta.People

$params = @{
	displayName = "Home"
	detail = @{
		type = "home"
		postOfficeBox = $null
		street = "221B Baker Street"
		city = "London"
		state = $null
		countryOrRegion = "United Kingdom"
		postalCode = "E14 3TD"
	}
}

# A UPN can also be used as -UserId.
New-MgBetaUserProfileAddress -UserId $userId -BodyParameter $params

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

from msgraph import GraphServiceClient
from msgraph.generated.models.item_address import ItemAddress
from msgraph.generated.models.physical_address import PhysicalAddress

graph_client = GraphServiceClient(credentials, scopes)

request_body = ItemAddress(
	display_name = "Home",
	detail = PhysicalAddress(
		type = PhysicalAddressType.Home,
		post_office_box = None,
		street = "221B Baker Street",
		city = "London",
		state = None,
		country_or_region = "United Kingdom",
		postal_code = "E14 3TD",
	),
)

result = await graph_client.me.profile.addresses.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

Note: The response object shown here might be shortened for readability.

HTTP/1.1 201 Created
Content-Type: application/json

{
  "id": "0fb4c1e3-c1e3-0fb4-e3c1-b40fe3c1b40f",
  "allowedAudiences": "organization",
  "inference": null,
  "createdDateTime": "2020-07-06T06:34:12.2294868Z",
  "createdBy": {
    "application": null,
    "device": null,
    "user": {
      "displayName": "Innocenty Popov",
      "id": "db789417-4ccb-41d1-a0a9-47b01a09ea49"
    }
  },
  "lastModifiedDateTime": "2020-07-06T06:34:12.2294868Z",
  "lastModifiedBy": {
    "application": null,
    "device": null,
    "user": {
      "displayName": "Innocenty Popov",
      "id": "db789417-4ccb-41d1-a0a9-47b01a09ea49"
    }
  },
  "source": null,
  "displayName": "Home",
  "detail": {
    "type": "home",
    "postOfficeBox": null,
    "street": "221B Baker Street",
    "city": "London",
    "state": null,
    "countryOrRegion": "United Kingdom",
    "postalCode": "E14 3TD"
  },
  "geoCoordinates": null
}