Resource that represents a custom entity type. These type can be configured to have any combination of fields, permitting businesses to create unique and complex ways to model their data.

$idstring Required

$schemaconst Required

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

descriptionstring

Description of the entity type.

descriptionTranslationarray

Translations of the description for different locale codes.

Each item of this array must be:

Type: object

string Required

The locale code of the translation.

string Required

The value of the translation.

displayNamestring Required

Display name of the type.

displayNameTranslationarray

Translations of the displayName for different locale codes.

Each item of this array must be:

enabledboolean Required

A flag that determines if the entity type is enabled.

fieldarray of object

List of fields in the entity type’s schema.

Each item of this array must be:

Type: object

string Required

ID of a field.

boolean Required

Flag that determines if the field value is required.

pluralDisplayNamestring

Plural display name for multiple entities of this type.

pluralDisplayNameTranslationarray

Translations of the pluralDisplayName for different locale codes.

Each item of this array must be: