Built-in vs. Custom Entity Types
What You’ll Learn
In this section, you will learn:
- The difference between Built-in and Custom Entity Types
- Best practices for when to use each type
Differences between a Built-in Type and a Custom Type
Entity types can either be built-in by Yext or custom-defined by you for your specific account(s).
Yext provides a number of “Built-In” Entity Types for common data objects, like Locations, Healthcare Professionals, Products, or Jobs. These entity types are pre-defined by Yext and Yext controls properties like the display name and the API name. You can add additional custom fields to these types, but you cannot remove fields defined on the Entity. Over time, Yext will expose more Built-In Entity Types as we observe common patterns or behavior or as we build out more Entity Types in our Knowledge Network.
Can’t find an entity type that describes what you’re trying to do? Not a problem!
Customers can also define their own objects called “Custom” Entity Types. Custom entity types can be used for any kind of data – each brand can control the name and the properties of these types as needed.
If you can, we recommend that you use Built-In types so that you can take advantage of any pre-built configurations and product-wide compatibility. Unlike Built-In types, Custom Entity Types are not compatible with Listings and may not be compatible with all Third Party systems / integrations.
|Built-in Entity Types||Custom Entity Types|
|Yext defines the core schema, customers can add additional custom fields to it||Customer defines the schema by adding any Built-in or Custom Field to it|
|Compatible with Listings|
|Compatible with Pages|
|Compatible with Answers|
|Can control display name, API name, entity type description & all fields|