Entity Type Extension

Resource that defines the user-settable properties for built-in entity types.

$idstring Required

$schemaconst Required

Specific value: “https://schema.yext.com/config/km/entity-type-extension/v1"

enabledboolean Required

A flag that determines if the entity type is enabled.

entityTypestring Required

Reference to a built-in entity type.

fieldarray of object

List of custom fields to include in the entity type’s schema.

Each item of this array must be:

Type: object

string Required

ID of a custom field.

boolean Required

Flag that determines if the field value is required.