Module

Configures a module that can be used in Page Builder Templates.

$idstring Required

$schemaconst Required

Specific value: "https://schema.yext.com/config/pages/module/v1"

namestring Required

The name of the module.

displayNamestring Required

The name displayed in the Platform UI. This name is internal only and not displayed to end users of your site.

descriptionstring Required

The module’s description.

apiVersioninteger Required

The api version of the module.

Value must be greater or equal to 0

entityGroupsarray of enum (of string) Required

The entity groups associated with this module.

Each item of this array must be:

Type: enum (of string)

Must be one of:

  • “Locations”
  • “People”
  • “Events”
  • “Organizations”
  • “Categories”
  • “Custom”
  • “Jobs”
  • “FAQs”
  • “Products”

pageSetTypesarray of enum (of string)

The types of page builder template the module can be used with.

Each item of this array must be:

Type: enum (of string)

Must be one of:

  • “TEMPLATE”
  • “SINGLE_PAGE”