Contents

Install Application

Install a third-party app on a device.

URL

PUT https://yourmdmhost.example.com/mdm#InstallApplicationCommand

Response Codes

StatusReasonTypeDescription
200OK
Content-Type: application/xml
InstallApplicationResponse

The response object the system returns for the Install Application Command.

Mentioned in

Discussion

The request must contain only one of these keys: iTunesStoreID, Identifier, or ManifestURL.

Installation prompts the user to approve or cancel the update. If the device is supervised, the device only prompts when the app to install is in the foreground.

Set the organization name that appears in this prompt in the OrganizationInfo dictionary using the Settings command.

If the app is a managed app, this command updates it. This command fails if Declarative Device Management is managing the app.

In macOS, the device returns an Acknowledged response after validating the parameters, but before downloading and installing the app. However, it doesn’t notify the MDM server about errors that occur during the installation process.

For macOS VPP app installations, if the app is device licensed, the system must receive the InstallApplication command on the device channel. If the app is user licensed, the system must receive the InstallApplication command on the user channel.

Prior to iOS 16.0 and tvOS 16.0, this command would return NotNow when Setup Assistant was running. Starting in iOS 16.0 and tvOS 16.0, the command may be sent to supervised devices during Setup Assistant. However, you should only attempt to install device-based VPP apps or enterprise apps while in the awaiting configuration state, as it is unlikely the device would have an App Store account configured, and thus commands that depend on one will fail.

Refer to the following sections to determine supported channels and requirements, and to see an example request and response.

Command availability

Device channel

iOS, macOS, Shared iPad, tvOS, visionOS, watchOS

User channel

macOS

Requires supervision

NA

Allowed in user enrollment

iOS, macOS, visionOS

Required access right

AllowAppInstallation

Example request and response

HTTP Body

The request object the server returns for the Install Application Command.

Topics

Commands and responses

See Also

Managed Apps