PayloadKit

Home Screen Layout

com.apple.homescreenlayout

The payload that configures the Home Screen layout.

iOS 9.3+tvOS 11.0+
Apple schema

Requires supervision on iOS, tvOS · Only one instance per profile

Configuration Keys (2)

KeyTypeTitle
Dock

An array of dictionaries, each of which must conform to the icon dictionary format. If this key isn't present, the user's Dock is empty.

array—
IconItem

An array of dictionaries that conform to the icon dictionary format.

dict—
Typerequired

The type of the Dock item.

Range: Application, Folder, WebClip

string—
DisplayName

The human-readable string shown to the user. This setting is valid only if the type is `Folder`.

string—
BundleID

The bundle identifier of the app. The device requires this setting if the type is `Application`.

string—
Pages

An array of arrays of dictionaries, each conforming to the icon dictionary format. This setting is valid only if the type is `Folder`.

array—
PagesItem
array—
IconItem

An array of dictionaries that conform to the icon dictionary format.

dict—
URL

iOS 11.3+

The URL of the existing web clip for this item. The device requires this setting if `type` is `WebClip`. If more than one web clip exists with the same URL, the behavior is undefined. Specifying a web clip in this payload doesn't create the web clip. Use the `WebClip` payload to create a web clip.

string—
Pagesrequired

An array of arrays of dictionaries, each of which must conform to the icon dictionary format.

array—
PagesItem
array—
IconItem

An array of dictionaries that conform to the icon dictionary format.

dict—
Typerequired

The type of the Dock item.

Range: Application, Folder, WebClip

string—
DisplayName

The human-readable string shown to the user. This setting is valid only if the type is `Folder`.

string—
BundleID

The bundle identifier of the app. The device requires this setting if the type is `Application`.

string—
Pages

An array of arrays of dictionaries, each conforming to the icon dictionary format. This setting is valid only if the type is `Folder`.

array—
PagesItem
array—
URL

iOS 11.3+

The URL of the existing web clip for this item. The device requires this setting if `type` is `WebClip`. If more than one web clip exists with the same URL, the behavior is undefined. Specifying a web clip in this payload doesn't create the web clip. Use the `WebClip` payload to create a web clip.

string—