By default, each row of data in a connector run represents the primary language profile of an entity. To create or update alternate language profiles, two additional fields must be mapped:
- Locale Code
-
Is Alternate Profile (
isAlternateProfile)
Locale Code
Specifies the intended language profile for a given row. For example, to ingest data for a Spanish language profile, include a column with the value es and map it as the locale code.
See the Language and Locales reference for a full list of available languages and locale codes.
Is Alternate Profile
A boolean field (true or false) that designates whether a row represents a primary or alternate language profile.
- Set to
trueto create or update an alternate profile. - Set to
false, or leave the column blank, to indicate the row represents the primary profile.
Primary-Only Fields
Some fields in Yext are designated as "primary-only," meaning they cannot be populated on an alternate language profile. When ingesting alternate profile rows via a connector, any columns that map to primary-only fields should be cleared. This can be done with a transform that executes conditionally based on the value of isAlternateProfile.
To see which fields are primary-only, check the Alternate Language Behavior column under Knowledge Graph > Configuration > Fields.
Creating Entities with Alternate Language Profiles
All entities must have a primary language profile. When creating new entities via a connector:
- One row per entity must map
isAlternateProfiletofalse(or blank/null) with the appropriate locale code. This establishes the primary profile. -
Additional rows for the same entity ID should map
isAlternateProfiletotruewith their respective locale codes to create alternate profiles.
Updating Entities with Alternate Language Profiles
When updating an existing entity, mapping isAlternateProfile is not required.
If isAlternateProfile is false or blank/null, existing profiles will be updated and new profiles will be created as needed. Note that a connector cannot be used to switch an entity's primary profile to a different language.
It is also not required that the primary profile be present in the connector run when updating an existing entity.