Embedded fields enable you to dynamically display entity-specific content in any text field. For example, you can embed a location's City and State fields in its Description. Then, if you make changes to the City or State field, the information will dynamically update within the Description.
This article explains where embedded fields can be used, which types of fields can be embedded, and how to use embedded fields.
Where to use embedded fields
Embedded fields can be used in any text-type field in Yext. This includes:
- Single- and multi-line text fields
- URL fields
- Option and list fields
- Text assets
- Entity templates
- Social posts
- Review responses
- Page Builder content
The types of fields that can be embedded in other content include:
- Any string (text) field
- URL fields
- Option fields
- Text list fields
Insert an embedded field
You can apply an embedded field anywhere you see the embedded field icon:
- Click the embedded field icon on the entity field or content you want to edit.
- In the dropdown menu, search for the name of the field you want to embed.
- Click the desired field.
- When finished editing your content, click Save.
Embedded fields in Entity Upload, Connectors, and API
You can manually input embedded fields when uploading entity data to Yext via Entity Upload, Connectors, or the API.
To do this, input the field's API name in double brackets ([[ ]]).
For example, to upload a Description field for a location that includes the embedded value for that location's Name, you would input [[name]].
For complex fields (fields that contain multiple subfields, such as Address), use the following format to embed a subfield: [[mainField.subfield]]
For example, to manually input only the City subfield as an embedded field, input [[address.city]].
To view the API name for a field:
- Navigate to Knowledge Graph > Configuration and click the Fields tile to view all fields in your account.
- API names are displayed on each field, below the display name.
- API names are displayed on each field, below the display name.
- You can also view field API names on Entity Edit for any entity.