Create personAward

Namespace: microsoft.graph

Create a new personAward 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/awards
POST /users/{id | userPrincipalName}/profile/awards

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

The following table shows the properties that are possible to set when creating a new personAward 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.
description	String	Descpription of the award or honor.
displayName	String	Name of the award or honor.
inference	inferenceData	Contains inference detail if the entity is inferred by the creating or modifying application. Inherited from itemFacet.
issuedDate	Date	The date that the award or honor was granted.
issuingAuthority	String	Authority which granted the award or honor.
source	personDataSource	Where the values originated if synced from another service. Inherited from itemFacet.
thumbnailUrl	String	URL referencing a thumbnail of the award or honor.
webUrl	String	URL referencing the award or honor.

Response

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

Examples

HTTP

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

{
  "description": "Lifetime Achievement award from the International Association of Branding Managers",
  "displayName": "Lifetime Achievement Award For Excellence in Branding",
  "issuedDate": "Date",
  "issuingAuthority": "International Association of Branding Management",
  "thumbnailUrl": "https://iabm.io/sdhdfhsdhshsd.jpg",
  "webUrl": "https://www.iabm.io"
}

C#

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

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

var requestBody = new PersonAward
{
	Description = "Lifetime Achievement award from the International Association of Branding Managers",
	DisplayName = "Lifetime Achievement Award For Excellence in Branding",
	IssuedDate = new Date(DateTime.Parse("Date")),
	IssuingAuthority = "International Association of Branding Management",
	ThumbnailUrl = "https://iabm.io/sdhdfhsdhshsd.jpg",
	WebUrl = "https://www.iabm.io",
};

// 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.Awards.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 awards create --user-id {user-id} --body '{\
  "description": "Lifetime Achievement award from the International Association of Branding Managers",\
  "displayName": "Lifetime Achievement Award For Excellence in Branding",\
  "issuedDate": "Date",\
  "issuingAuthority": "International Association of Branding Management",\
  "thumbnailUrl": "https://iabm.io/sdhdfhsdhshsd.jpg",\
  "webUrl": "https://www.iabm.io"\
}\
'

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.NewPersonAward()
description := "Lifetime Achievement award from the International Association of Branding Managers"
requestBody.SetDescription(&description) 
displayName := "Lifetime Achievement Award For Excellence in Branding"
requestBody.SetDisplayName(&displayName) 
issuedDate := date
requestBody.SetIssuedDate(&issuedDate) 
issuingAuthority := "International Association of Branding Management"
requestBody.SetIssuingAuthority(&issuingAuthority) 
thumbnailUrl := "https://iabm.io/sdhdfhsdhshsd.jpg"
requestBody.SetThumbnailUrl(&thumbnailUrl) 
webUrl := "https://www.iabm.io"
requestBody.SetWebUrl(&webUrl) 

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

PersonAward personAward = new PersonAward();
personAward.setDescription("Lifetime Achievement award from the International Association of Branding Managers");
personAward.setDisplayName("Lifetime Achievement Award For Excellence in Branding");
LocalDate issuedDate = LocalDate.parse("Date");
personAward.setIssuedDate(issuedDate);
personAward.setIssuingAuthority("International Association of Branding Management");
personAward.setThumbnailUrl("https://iabm.io/sdhdfhsdhshsd.jpg");
personAward.setWebUrl("https://www.iabm.io");
PersonAward result = graphClient.me().profile().awards().post(personAward);

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 personAward = {
  description: 'Lifetime Achievement award from the International Association of Branding Managers',
  displayName: 'Lifetime Achievement Award For Excellence in Branding',
  issuedDate: 'Date',
  issuingAuthority: 'International Association of Branding Management',
  thumbnailUrl: 'https://iabm.io/sdhdfhsdhshsd.jpg',
  webUrl: 'https://www.iabm.io'
};

await client.api('/me/profile/awards')
	.version('beta')
	.post(personAward);

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\PersonAward;


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

$requestBody = new PersonAward();
$requestBody->setDescription('Lifetime Achievement award from the International Association of Branding Managers');
$requestBody->setDisplayName('Lifetime Achievement Award For Excellence in Branding');
$requestBody->setIssuedDate(new Date('Date'));
$requestBody->setIssuingAuthority('International Association of Branding Management');
$requestBody->setThumbnailUrl('https://iabm.io/sdhdfhsdhshsd.jpg');
$requestBody->setWebUrl('https://www.iabm.io');

$result = $graphServiceClient->me()->profile()->awards()->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 = @{
	description = "Lifetime Achievement award from the International Association of Branding Managers"
	displayName = "Lifetime Achievement Award For Excellence in Branding"
	issuedDate = "Date"
	issuingAuthority = "International Association of Branding Management"
	thumbnailUrl = "https://iabm.io/sdhdfhsdhshsd.jpg"
	webUrl = "https://www.iabm.io"
}

# A UPN can also be used as -UserId.
New-MgBetaUserProfileAward -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.person_award import PersonAward

graph_client = GraphServiceClient(credentials, scopes)

request_body = PersonAward(
	description = "Lifetime Achievement award from the International Association of Branding Managers",
	display_name = "Lifetime Achievement Award For Excellence in Branding",
	issued_date = "Date",
	issuing_authority = "International Association of Branding Management",
	thumbnail_url = "https://iabm.io/sdhdfhsdhshsd.jpg",
	web_url = "https://www.iabm.io",
)

result = await graph_client.me.profile.awards.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,
  "description": "Lifetime Achievement award from the International Association of Branding Managers",
  "displayName": "Lifetime Achievement Award For Excellence in Branding",
  "issuedDate": "Date",
  "issuingAuthority": "International Association of Branding Management",
  "thumbnailUrl": "https://iabm.io/sdhdfhsdhshsd.jpg",
  "webUrl": "https://www.iabm.io"
}