GuidesRecipesAPI ReferenceChangelog
Log In
API Reference

Creates a new mobile device command

The chart below includes additional requirements for usage of specific commands

commandParametersRequirementsValues
DeviceLocationN/ASupervised and in lost modeN/A
DisableLostModeN/ASupervised and in lost modeN/A
EnableLostModelost_mode_messageSupervised device (required if lost_mode_phone is not set)string
EnableLostModelost_mode_phoneSupervised device (required if lost_mode_message is not set)string
EnableLostModelost_mode_footnoteoptionalstring
EnableLostModealways_enforce_lost_modeoptional (defaults to 'true')boolean
EnableLostModelost_mode_with_soundoptional (defaults to 'false')boolean
PasscodeLockGracePeriod (PasscodeLockGracePeriod Deprecated on 2025-06-26)passcode_lock_grace_periodShared iPadseconds (integer)
PlayLostModeSoundN/ASupervised and in lost modeN/A
RestartDevice (deprecated)N/ASupervised deviceN/A
Wallpaperwallpaper_settingsSupervised device1 = Lock screen, 2 = Home screen, 3 = both
Wallpaperwallpaper_idSupervised device (required if wallpaper_content is not set)Jamf Pro icon ID (integer)
Wallpaperwallpaper_contentSupervised device (required if wallpaper_id is not set)base64 encoded PNG or JPEG
RefreshCellularPlans (RefreshCellularPlans deprecated on 2025-07-15)e_sim_server_urlN/AThis URL is obtained from each carrier separately

Below is a complete list of the supported values for the command element.

  • BlankPush (deprecated)
  • ClearPasscode
  • DeviceLocation
  • DisableLostMode
  • EnableLostMode
  • PasscodeLockGracePeriod
  • PlayLostModeSound
  • RefreshCellularPlans
  • RestartDevice (deprecated)
  • UpdateInventory
  • Wallpaper

Below you will find a list of sample request bodies for commands that have additional parameters beyond the command.

<mobile_device_command>
	<general>
		<command>EnableLostMode</command>
		<lost_mode_message>This device has been reported as lost and its location has been identified, please return before authorities arrive.</lost_mode_message>
		<lost_mode_phone>555-555-5555</lost_mode_phone>
		<lost_mode_footnote>This is an optional footnote</lost_mode_footnote>
		<always_enforce_lost_mode>false</always_enforce_lost_mode>
		<lost_mode_with_sound>false</lost_mode_with_sound>
	</general>
	<mobile_devices>
		<mobile_device>
			<id>4</id>
		</mobile_device>
	</mobile_devices>
</mobile_device_command>
<mobile_device_command>
	<general>
		<command>PasscodeLockGracePeriod</command>
		<passcode_lock_grace_period>60</passcode_lock_grace_period>
	</general>
	<mobile_devices>
		<mobile_device>
			<id>4</id>
		</mobile_device>
	</mobile_devices>
</mobile_device_command>
<mobile_device_command>
	<general>
		<command>Wallpaper</command>
		<wallpaper_setting>1</wallpaper_setting>
		<wallpaper_id>1</wallpaper_id>
    <wallpaper_content></wallpaper_content>
	</general>
	<mobile_devices>
		<mobile_device>
			<id>4</id>
		</mobile_device>
	</mobile_devices>
</mobile_device_command>
Language
Credentials
Basic
base64
: