Home Screen
Configures a home screen.
$idstring Required
The unique identifier for the home screen resource.
$schemaconst Required
Specific value:
“https://schema.yext.com/config/platform/home-screen/v1" namestring Required
The display name of the home screen.
Must be at most 50 characters long
bannerTextstring
Text to display in the banner at the top of the home screen.
Must be at most 255 characters long
modulesarray of object
The ordered list of modules that will appear on the home screen. The order is left to right, with two modules per row.
Must contain a maximum of 20 items
Each item of this array must be:
An individual module to be displayed on the home screen.
Type: object
The following properties are required:
- module
Type: object
The following properties are required:
- insight
string
The name of the module resource.
string
The name of the insight resource.