Update managedIOSStoreApp

Article
08/01/2024

Namespace: microsoft.graph

Note: The Microsoft Graph API for Intune requires an active Intune license for the tenant.

Update the properties of a managedIOSStoreApp object.

This API is available in the following national cloud deployments.

Global service	US Government L4	US Government L5 (DOD)	China operated by 21Vianet
✅	✅	✅	✅

Permissions

One of the following permissions is required to call this API. To learn more, including how to choose permissions, see Permissions.

Permission type	Permissions (from least to most privileged)
Delegated (work or school account)	DeviceManagementApps.ReadWrite.All
Delegated (personal Microsoft account)	Not supported.
Application	DeviceManagementApps.ReadWrite.All

HTTP Request

PATCH /deviceAppManagement/mobileApps/{mobileAppId}

Request headers

Header	Value
Authorization	Bearer {token}. Required. Learn more about authentication and authorization.
Accept	application/json

Request body

In the request body, supply a JSON representation for the managedIOSStoreApp object.

The following table shows the properties that are required when you create the managedIOSStoreApp.

Property	Type	Description
id	String	Key of the entity. Inherited from mobileApp
displayName	String	The admin provided or imported title of the app. Inherited from mobileApp
description	String	The description of the app. Inherited from mobileApp
publisher	String	The publisher of the app. Inherited from mobileApp
largeIcon	mimeContent	The large icon, to be displayed in the app details and used for upload of the icon. Inherited from mobileApp
createdDateTime	DateTimeOffset	The date and time the app was created. Inherited from mobileApp
lastModifiedDateTime	DateTimeOffset	The date and time the app was last modified. Inherited from mobileApp
isFeatured	Boolean	The value indicating whether the app is marked as featured by the admin. Inherited from mobileApp
privacyInformationUrl	String	The privacy statement Url. Inherited from mobileApp
informationUrl	String	The more information Url. Inherited from mobileApp
owner	String	The owner of the app. Inherited from mobileApp
developer	String	The developer of the app. Inherited from mobileApp
notes	String	Notes for the app. Inherited from mobileApp
publishingState	mobileAppPublishingState	The publishing state for the app. The app cannot be assigned unless the app is published. Inherited from mobileApp. Possible values are: `notPublished`, `processing`, `published`.
appAvailability	managedAppAvailability	The Application's availability. Inherited from managedApp. Possible values are: `global`, `lineOfBusiness`.
version	String	The Application's version. Inherited from managedApp
bundleId	String	The app's Bundle ID.
appStoreUrl	String	The Apple AppStoreUrl.
applicableDeviceType	iosDeviceType	The iOS architecture for which this app can run on.
minimumSupportedOperatingSystem	iosMinimumOperatingSystem	The value for the minimum supported operating system.

Response

If successful, this method returns a 200 OK response code and an updated managedIOSStoreApp object in the response body.

Example

Request

Here is an example of the request.

PATCH https://graph.microsoft.com/v1.0/deviceAppManagement/mobileApps/{mobileAppId}
Content-type: application/json
Content-length: 1144

{
  "@odata.type": "#microsoft.graph.managedIOSStoreApp",
  "displayName": "Display Name value",
  "description": "Description value",
  "publisher": "Publisher value",
  "largeIcon": {
    "@odata.type": "microsoft.graph.mimeContent",
    "type": "Type value",
    "value": "dmFsdWU="
  },
  "isFeatured": true,
  "privacyInformationUrl": "https://example.com/privacyInformationUrl/",
  "informationUrl": "https://example.com/informationUrl/",
  "owner": "Owner value",
  "developer": "Developer value",
  "notes": "Notes value",
  "publishingState": "processing",
  "appAvailability": "lineOfBusiness",
  "version": "Version value",
  "bundleId": "Bundle Id value",
  "appStoreUrl": "https://example.com/appStoreUrl/",
  "applicableDeviceType": {
    "@odata.type": "microsoft.graph.iosDeviceType",
    "iPad": true,
    "iPhoneAndIPod": true
  },
  "minimumSupportedOperatingSystem": {
    "@odata.type": "microsoft.graph.iosMinimumOperatingSystem",
    "v8_0": true,
    "v9_0": true,
    "v10_0": true,
    "v11_0": true,
    "v12_0": true,
    "v13_0": true,
    "v14_0": true,
    "v15_0": true
  }
}


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

// Dependencies
using Microsoft.Graph.Models;

var requestBody = new ManagedIOSStoreApp
{
	OdataType = "#microsoft.graph.managedIOSStoreApp",
	DisplayName = "Display Name value",
	Description = "Description value",
	Publisher = "Publisher value",
	LargeIcon = new MimeContent
	{
		OdataType = "microsoft.graph.mimeContent",
		Type = "Type value",
		Value = Convert.FromBase64String("dmFsdWU="),
	},
	IsFeatured = true,
	PrivacyInformationUrl = "https://example.com/privacyInformationUrl/",
	InformationUrl = "https://example.com/informationUrl/",
	Owner = "Owner value",
	Developer = "Developer value",
	Notes = "Notes value",
	PublishingState = MobileAppPublishingState.Processing,
	AppAvailability = ManagedAppAvailability.LineOfBusiness,
	Version = "Version value",
	BundleId = "Bundle Id value",
	AppStoreUrl = "https://example.com/appStoreUrl/",
	ApplicableDeviceType = new IosDeviceType
	{
		OdataType = "microsoft.graph.iosDeviceType",
		IPad = true,
		IPhoneAndIPod = true,
	},
	MinimumSupportedOperatingSystem = new IosMinimumOperatingSystem
	{
		OdataType = "microsoft.graph.iosMinimumOperatingSystem",
		V80 = true,
		V90 = true,
		V100 = true,
		V110 = true,
		V120 = true,
		V130 = true,
		V140 = true,
		V150 = true,
	},
};

// To initialize your graphClient, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=csharp
var result = await graphClient.DeviceAppManagement.MobileApps["{mobileApp-id}"].PatchAsync(requestBody);

For details about how to add the SDK to your project and create an authProvider instance, see the SDK documentation.



mgc device-app-management mobile-apps patch --mobile-app-id {mobileApp-id} --body '{\
  "@odata.type": "#microsoft.graph.managedIOSStoreApp",\
  "displayName": "Display Name value",\
  "description": "Description value",\
  "publisher": "Publisher value",\
  "largeIcon": {\
    "@odata.type": "microsoft.graph.mimeContent",\
    "type": "Type value",\
    "value": "dmFsdWU="\
  },\
  "isFeatured": true,\
  "privacyInformationUrl": "https://example.com/privacyInformationUrl/",\
  "informationUrl": "https://example.com/informationUrl/",\
  "owner": "Owner value",\
  "developer": "Developer value",\
  "notes": "Notes value",\
  "publishingState": "processing",\
  "appAvailability": "lineOfBusiness",\
  "version": "Version value",\
  "bundleId": "Bundle Id value",\
  "appStoreUrl": "https://example.com/appStoreUrl/",\
  "applicableDeviceType": {\
    "@odata.type": "microsoft.graph.iosDeviceType",\
    "iPad": true,\
    "iPhoneAndIPod": true\
  },\
  "minimumSupportedOperatingSystem": {\
    "@odata.type": "microsoft.graph.iosMinimumOperatingSystem",\
    "v8_0": true,\
    "v9_0": true,\
    "v10_0": true,\
    "v11_0": true,\
    "v12_0": true,\
    "v13_0": true,\
    "v14_0": true,\
    "v15_0": true\
  }\
}\
'

For details about how to add the SDK to your project and create an authProvider instance, see the SDK documentation.



// Code snippets are only available for the latest major version. Current major version is $v1.*

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

requestBody := graphmodels.NewMobileApp()
displayName := "Display Name value"
requestBody.SetDisplayName(&displayName) 
description := "Description value"
requestBody.SetDescription(&description) 
publisher := "Publisher value"
requestBody.SetPublisher(&publisher) 
largeIcon := graphmodels.NewMimeContent()
type := "Type value"
largeIcon.SetType(&type) 
value := []byte("dmFsdWU=")
largeIcon.SetValue(&value) 
requestBody.SetLargeIcon(largeIcon)
isFeatured := true
requestBody.SetIsFeatured(&isFeatured) 
privacyInformationUrl := "https://example.com/privacyInformationUrl/"
requestBody.SetPrivacyInformationUrl(&privacyInformationUrl) 
informationUrl := "https://example.com/informationUrl/"
requestBody.SetInformationUrl(&informationUrl) 
owner := "Owner value"
requestBody.SetOwner(&owner) 
developer := "Developer value"
requestBody.SetDeveloper(&developer) 
notes := "Notes value"
requestBody.SetNotes(&notes) 
publishingState := graphmodels.PROCESSING_MOBILEAPPPUBLISHINGSTATE 
requestBody.SetPublishingState(&publishingState) 
appAvailability := graphmodels.LINEOFBUSINESS_MANAGEDAPPAVAILABILITY 
requestBody.SetAppAvailability(&appAvailability) 
version := "Version value"
requestBody.SetVersion(&version) 
bundleId := "Bundle Id value"
requestBody.SetBundleId(&bundleId) 
appStoreUrl := "https://example.com/appStoreUrl/"
requestBody.SetAppStoreUrl(&appStoreUrl) 
applicableDeviceType := graphmodels.NewIosDeviceType()
iPad := true
applicableDeviceType.SetIPad(&iPad) 
iPhoneAndIPod := true
applicableDeviceType.SetIPhoneAndIPod(&iPhoneAndIPod) 
requestBody.SetApplicableDeviceType(applicableDeviceType)
minimumSupportedOperatingSystem := graphmodels.NewIosMinimumOperatingSystem()
v8_0 := true
minimumSupportedOperatingSystem.SetV8_0(&v8_0) 
v9_0 := true
minimumSupportedOperatingSystem.SetV9_0(&v9_0) 
v10_0 := true
minimumSupportedOperatingSystem.SetV10_0(&v10_0) 
v11_0 := true
minimumSupportedOperatingSystem.SetV11_0(&v11_0) 
v12_0 := true
minimumSupportedOperatingSystem.SetV12_0(&v12_0) 
v13_0 := true
minimumSupportedOperatingSystem.SetV13_0(&v13_0) 
v14_0 := true
minimumSupportedOperatingSystem.SetV14_0(&v14_0) 
v15_0 := true
minimumSupportedOperatingSystem.SetV15_0(&v15_0) 
requestBody.SetMinimumSupportedOperatingSystem(minimumSupportedOperatingSystem)

// To initialize your graphClient, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=go
mobileApps, err := graphClient.DeviceAppManagement().MobileApps().ByMobileAppId("mobileApp-id").Patch(context.Background(), requestBody, nil)

For details about how to add the SDK to your project and create an authProvider instance, see the SDK documentation.


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

GraphServiceClient graphClient = new GraphServiceClient(requestAdapter);

ManagedIOSStoreApp mobileApp = new ManagedIOSStoreApp();
mobileApp.setOdataType("#microsoft.graph.managedIOSStoreApp");
mobileApp.setDisplayName("Display Name value");
mobileApp.setDescription("Description value");
mobileApp.setPublisher("Publisher value");
MimeContent largeIcon = new MimeContent();
largeIcon.setOdataType("microsoft.graph.mimeContent");
largeIcon.setType("Type value");
byte[] value = Base64.getDecoder().decode("dmFsdWU=");
largeIcon.setValue(value);
mobileApp.setLargeIcon(largeIcon);
mobileApp.setIsFeatured(true);
mobileApp.setPrivacyInformationUrl("https://example.com/privacyInformationUrl/");
mobileApp.setInformationUrl("https://example.com/informationUrl/");
mobileApp.setOwner("Owner value");
mobileApp.setDeveloper("Developer value");
mobileApp.setNotes("Notes value");
mobileApp.setPublishingState(MobileAppPublishingState.Processing);
mobileApp.setAppAvailability(ManagedAppAvailability.LineOfBusiness);
mobileApp.setVersion("Version value");
mobileApp.setBundleId("Bundle Id value");
mobileApp.setAppStoreUrl("https://example.com/appStoreUrl/");
IosDeviceType applicableDeviceType = new IosDeviceType();
applicableDeviceType.setOdataType("microsoft.graph.iosDeviceType");
applicableDeviceType.setIPad(true);
applicableDeviceType.setIPhoneAndIPod(true);
mobileApp.setApplicableDeviceType(applicableDeviceType);
IosMinimumOperatingSystem minimumSupportedOperatingSystem = new IosMinimumOperatingSystem();
minimumSupportedOperatingSystem.setOdataType("microsoft.graph.iosMinimumOperatingSystem");
minimumSupportedOperatingSystem.setV80(true);
minimumSupportedOperatingSystem.setV90(true);
minimumSupportedOperatingSystem.setV100(true);
minimumSupportedOperatingSystem.setV110(true);
minimumSupportedOperatingSystem.setV120(true);
minimumSupportedOperatingSystem.setV130(true);
minimumSupportedOperatingSystem.setV140(true);
minimumSupportedOperatingSystem.setV150(true);
mobileApp.setMinimumSupportedOperatingSystem(minimumSupportedOperatingSystem);
MobileApp result = graphClient.deviceAppManagement().mobileApps().byMobileAppId("{mobileApp-id}").patch(mobileApp);

For details about how to add the SDK to your project and create an authProvider instance, see the SDK documentation.


const options = {
	authProvider,
};

const client = Client.init(options);

const mobileApp = {
  '@odata.type': '#microsoft.graph.managedIOSStoreApp',
  displayName: 'Display Name value',
  description: 'Description value',
  publisher: 'Publisher value',
  largeIcon: {
    '@odata.type': 'microsoft.graph.mimeContent',
    type: 'Type value',
    value: 'dmFsdWU='
  },
  isFeatured: true,
  privacyInformationUrl: 'https://example.com/privacyInformationUrl/',
  informationUrl: 'https://example.com/informationUrl/',
  owner: 'Owner value',
  developer: 'Developer value',
  notes: 'Notes value',
  publishingState: 'processing',
  appAvailability: 'lineOfBusiness',
  version: 'Version value',
  bundleId: 'Bundle Id value',
  appStoreUrl: 'https://example.com/appStoreUrl/',
  applicableDeviceType: {
    '@odata.type': 'microsoft.graph.iosDeviceType',
    iPad: true,
    iPhoneAndIPod: true
  },
  minimumSupportedOperatingSystem: {
    '@odata.type': 'microsoft.graph.iosMinimumOperatingSystem',
    v8_0: true,
    v9_0: true,
    v10_0: true,
    v11_0: true,
    v12_0: true,
    v13_0: true,
    v14_0: true,
    v15_0: true
  }
};

await client.api('/deviceAppManagement/mobileApps/{mobileAppId}')
	.update(mobileApp);

For details about how to add the SDK to your project and create an authProvider instance, see the SDK documentation.


<?php
use Microsoft\Graph\GraphServiceClient;
use Microsoft\Graph\Generated\Models\ManagedIOSStoreApp;
use Microsoft\Graph\Generated\Models\MimeContent;
use Microsoft\Graph\Generated\Models\MobileAppPublishingState;
use Microsoft\Graph\Generated\Models\ManagedAppAvailability;
use Microsoft\Graph\Generated\Models\IosDeviceType;
use Microsoft\Graph\Generated\Models\IosMinimumOperatingSystem;


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

$requestBody = new ManagedIOSStoreApp();
$requestBody->setOdataType('#microsoft.graph.managedIOSStoreApp');
$requestBody->setDisplayName('Display Name value');
$requestBody->setDescription('Description value');
$requestBody->setPublisher('Publisher value');
$largeIcon = new MimeContent();
$largeIcon->setOdataType('microsoft.graph.mimeContent');
$largeIcon->setType('Type value');
$largeIcon->setValue(\GuzzleHttp\Psr7\Utils::streamFor(base64_decode('dmFsdWU=')));
$requestBody->setLargeIcon($largeIcon);
$requestBody->setIsFeatured(true);
$requestBody->setPrivacyInformationUrl('https://example.com/privacyInformationUrl/');
$requestBody->setInformationUrl('https://example.com/informationUrl/');
$requestBody->setOwner('Owner value');
$requestBody->setDeveloper('Developer value');
$requestBody->setNotes('Notes value');
$requestBody->setPublishingState(new MobileAppPublishingState('processing'));
$requestBody->setAppAvailability(new ManagedAppAvailability('lineOfBusiness'));
$requestBody->setVersion('Version value');
$requestBody->setBundleId('Bundle Id value');
$requestBody->setAppStoreUrl('https://example.com/appStoreUrl/');
$applicableDeviceType = new IosDeviceType();
$applicableDeviceType->setOdataType('microsoft.graph.iosDeviceType');
$applicableDeviceType->setIPad(true);
$applicableDeviceType->setIPhoneAndIPod(true);
$requestBody->setApplicableDeviceType($applicableDeviceType);
$minimumSupportedOperatingSystem = new IosMinimumOperatingSystem();
$minimumSupportedOperatingSystem->setOdataType('microsoft.graph.iosMinimumOperatingSystem');
$minimumSupportedOperatingSystem->setV80(true);
$minimumSupportedOperatingSystem->setV90(true);
$minimumSupportedOperatingSystem->setV100(true);
$minimumSupportedOperatingSystem->setV110(true);
$minimumSupportedOperatingSystem->setV120(true);
$minimumSupportedOperatingSystem->setV130(true);
$minimumSupportedOperatingSystem->setV140(true);
$minimumSupportedOperatingSystem->setV150(true);
$requestBody->setMinimumSupportedOperatingSystem($minimumSupportedOperatingSystem);

$result = $graphServiceClient->deviceAppManagement()->mobileApps()->byMobileAppId('mobileApp-id')->patch($requestBody)->wait();

For details about how to add the SDK to your project and create an authProvider instance, see the SDK documentation.


Import-Module Microsoft.Graph.Devices.CorporateManagement

$params = @{
	"@odata.type" = "#microsoft.graph.managedIOSStoreApp"
	displayName = "Display Name value"
	description = "Description value"
	publisher = "Publisher value"
	largeIcon = @{
		"@odata.type" = "microsoft.graph.mimeContent"
		type = "Type value"
		value = [System.Text.Encoding]::ASCII.GetBytes("dmFsdWU=")
	}
	isFeatured = $true
	privacyInformationUrl = "https://example.com/privacyInformationUrl/"
	informationUrl = "https://example.com/informationUrl/"
	owner = "Owner value"
	developer = "Developer value"
	notes = "Notes value"
	publishingState = "processing"
	appAvailability = "lineOfBusiness"
	version = "Version value"
	bundleId = "Bundle Id value"
	appStoreUrl = "https://example.com/appStoreUrl/"
	applicableDeviceType = @{
		"@odata.type" = "microsoft.graph.iosDeviceType"
		iPad = $true
		iPhoneAndIPod = $true
	}
	minimumSupportedOperatingSystem = @{
		"@odata.type" = "microsoft.graph.iosMinimumOperatingSystem"
		v8_0 = $true
		v9_0 = $true
		v10_0 = $true
		v11_0 = $true
		v12_0 = $true
		v13_0 = $true
		v14_0 = $true
		v15_0 = $true
	}
}

Update-MgDeviceAppManagementMobileApp -MobileAppId $mobileAppId -BodyParameter $params

For details about how to add the SDK to your project and create an authProvider instance, see the SDK documentation.


# Code snippets are only available for the latest version. Current version is 1.x
from msgraph import GraphServiceClient
from msgraph.generated.models.managed_i_o_s_store_app import ManagedIOSStoreApp
from msgraph.generated.models.mime_content import MimeContent
from msgraph.generated.models.mobile_app_publishing_state import MobileAppPublishingState
from msgraph.generated.models.managed_app_availability import ManagedAppAvailability
from msgraph.generated.models.ios_device_type import IosDeviceType
from msgraph.generated.models.ios_minimum_operating_system import IosMinimumOperatingSystem
# To initialize your graph_client, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=python
request_body = ManagedIOSStoreApp(
	odata_type = "#microsoft.graph.managedIOSStoreApp",
	display_name = "Display Name value",
	description = "Description value",
	publisher = "Publisher value",
	large_icon = MimeContent(
		odata_type = "microsoft.graph.mimeContent",
		type = "Type value",
		value = base64.urlsafe_b64decode("dmFsdWU="),
	),
	is_featured = True,
	privacy_information_url = "https://example.com/privacyInformationUrl/",
	information_url = "https://example.com/informationUrl/",
	owner = "Owner value",
	developer = "Developer value",
	notes = "Notes value",
	publishing_state = MobileAppPublishingState.Processing,
	app_availability = ManagedAppAvailability.LineOfBusiness,
	version = "Version value",
	bundle_id = "Bundle Id value",
	app_store_url = "https://example.com/appStoreUrl/",
	applicable_device_type = IosDeviceType(
		odata_type = "microsoft.graph.iosDeviceType",
		i_pad = True,
		i_phone_and_i_pod = True,
	),
	minimum_supported_operating_system = IosMinimumOperatingSystem(
		odata_type = "microsoft.graph.iosMinimumOperatingSystem",
		v8_0 = True,
		v9_0 = True,
		v10_0 = True,
		v11_0 = True,
		v12_0 = True,
		v13_0 = True,
		v14_0 = True,
		v15_0 = True,
	),
)

result = await graph_client.device_app_management.mobile_apps.by_mobile_app_id('mobileApp-id').patch(request_body)

For details about how to add the SDK to your project and create an authProvider instance, see the SDK documentation.

Response

Here is an example of the response. Note: The response object shown here may be truncated for brevity. All of the properties will be returned from an actual call.

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 1316

{
  "@odata.type": "#microsoft.graph.managedIOSStoreApp",
  "id": "51b9830f-830f-51b9-0f83-b9510f83b951",
  "displayName": "Display Name value",
  "description": "Description value",
  "publisher": "Publisher value",
  "largeIcon": {
    "@odata.type": "microsoft.graph.mimeContent",
    "type": "Type value",
    "value": "dmFsdWU="
  },
  "createdDateTime": "2017-01-01T00:02:43.5775965-08:00",
  "lastModifiedDateTime": "2017-01-01T00:00:35.1329464-08:00",
  "isFeatured": true,
  "privacyInformationUrl": "https://example.com/privacyInformationUrl/",
  "informationUrl": "https://example.com/informationUrl/",
  "owner": "Owner value",
  "developer": "Developer value",
  "notes": "Notes value",
  "publishingState": "processing",
  "appAvailability": "lineOfBusiness",
  "version": "Version value",
  "bundleId": "Bundle Id value",
  "appStoreUrl": "https://example.com/appStoreUrl/",
  "applicableDeviceType": {
    "@odata.type": "microsoft.graph.iosDeviceType",
    "iPad": true,
    "iPhoneAndIPod": true
  },
  "minimumSupportedOperatingSystem": {
    "@odata.type": "microsoft.graph.iosMinimumOperatingSystem",
    "v8_0": true,
    "v9_0": true,
    "v10_0": true,
    "v11_0": true,
    "v12_0": true,
    "v13_0": true,
    "v14_0": true,
    "v15_0": true
  }
}

Share via

Update managedIOSStoreApp

Permissions

HTTP Request

Request headers

Request body

Response

Example

Request

Response

Feedback

Additional resources