Skip to content

profile-post-phones.md

Latest commit

 

History

History
152 lines (121 loc) · 5.54 KB

profile-post-phones.md

File metadata and controls

152 lines (121 loc) · 5.54 KB
title Create itemPhone
description Use this API to create a new itemPhone.
ms.localizationpriority medium
author kevinbellinger
ms.subservice people
doc_type apiPageType
ms.date 06/11/2024

Create itemPhoneNumber

Namespace: microsoft.graph

[!INCLUDE beta-disclaimer]

Use this API to create a new itemPhone object in a user's profile.

[!INCLUDE national-cloud-support]

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.

[!INCLUDE permissions-table]

HTTP request

POST /me/profile/phones
POST /users/{userId}/profile/phones

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

The following table shows the properties that are possible to set when you create a new itemPhone object in a users profile.

Property Type Description
allowedAudiences String The audiences that are able to see the values contained within the entity. Inherited from itemFacet. The possible values are: me, family, contacts, groupMembers, organization, federatedOrganizations, everyone, unknownFutureValue.
displayName String Friendly name the user has assigned this phone number.
inference inferenceData Contains inference detail if the entity is inferred by the creating or modifying application. Inherited from itemFacet.
number String Phone number provided by the user.
source personDataSource Where the values originated if synced from another service. Inherited from itemFacet.
type phoneType The type of phone number within the object. The possible values are: home, business, mobile, other, assistant, homeFax, businessFax, otherFax, pager, radio.

Response

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

Examples

Request

HTTP

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

{
  "displayName": "Car Phone",
  "number": "+7 499 342 22 13"
}

C#

[!INCLUDE sample-code] [!INCLUDE sdk-documentation]

Go

[!INCLUDE sample-code] [!INCLUDE sdk-documentation]

Java

[!INCLUDE sample-code] [!INCLUDE sdk-documentation]

JavaScript

[!INCLUDE sample-code] [!INCLUDE sdk-documentation]

PHP

[!INCLUDE sample-code] [!INCLUDE sdk-documentation]

PowerShell

[!INCLUDE sample-code] [!INCLUDE sdk-documentation]

Python

[!INCLUDE sample-code] [!INCLUDE 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"
    }
  },
  "displayName": "Car Phone",
  "type": null,
  "number": "+7 499 342 22 13"
}