Yext Knowledge APIInstall

Summary

Upserts a language-specific profile for a location in the Yext Knowledge Manager, optionally setting it as the primary language profile.

Inputs

• primary — Boolean indicating if the specified profile should become the location's primary Language Profile. Defaults to true.
• id (required) — Unique alphanumeric ID assigned by the customer representing the location.
• language (required) — Language code for this location's information, defining its primary language in the system.
• uid — Static globally unique ID for the location, not equivalent to location id for API calls.
• accountId — Existing account ID to which the location belongs.
• timezone — Timezone of the location.
• locationType — Type of the location (e.g., LOCATION, HEALTHCARE_PROFESSIONAL, RESTAURANT).
• locationName — Name of the location with content restrictions (no URLs, phone numbers, inappropriate language).
• address — Valid street address (not a P.O. Box).
• city — City where the location is situated.
• state — State or province code or name for the location.
• zip — Postal code, including US ZIP code formats.
• countryCode — Two-character ISO country code; defaults to US if omitted.
• phone — Valid phone number for the location.
• isPhoneTracked — Whether the phone number is tracked; requires phone number in the same request when updating.
• hours — Business hours formatted as a comma-separated list representing days and opening/closing times.
• photos — JSON array of up to 50 photos representing the location; list must be comprehensive to prevent deletion.
• customFields — JSON object with custom field IDs and their respective values for the location.
• categoryIds — JSON array of valid Yext category IDs applied to the location; must contain 1 to 10 categories.
• description — Description string for the location.
• language-specific other optional fields — Additional profile-specific attributes such as social media handles, website URLs, menus, payments, healthcare professional details (e.g., certifications, specialties), attribute flags, and custom appearance data like logos or videos, provided as per the location type and requirement.

Output shape

a JSON object representing the upserted Location Language Profile including updated fields and warnings if any occur

Operation sends a single request to insert or update the language-specific profile for a location within the Yext Knowledge Manager API. Complex nested data such as photos, custom fields, hours, and others are sent as JSON. The operation supports batch options and proxy settings at the node level. Returned data includes the resulting location language profile record, with warnings if submitted values (like featured message or social handles) are ignored.