Yext Knowledge APIInstall

Summary

Update the details of a specific location in the Yext Knowledge Manager by specifying its unique primary key and providing any number of location-related fields to change.

Inputs

• Id (required) — Unique alphanumeric ID assigned to the location by the customer, used as the primary key to identify which location to update.
• Uid — Static globally unique ID for the location; cannot replace the primary location ID for update calls.
• Account Id — Existing Yext account ID the location belongs to.
• Timestamp — Timestamp of the latest modification; ignored when saving location data.
• Timezone — The timezone of the location.
• Location Type — Type of location like LOCATION, HEALTHCARE_PROFESSIONAL, RESTAURANT, etc.
• Location Name — Name of the location; excludes inappropriate language, HTML, URLs, phone numbers, and control characters.
• First Name — First name of a healthcare professional; only for HEALTHCARE_PROFESSIONAL location type.
• Middle Name — Middle name of a healthcare professional; only for HEALTHCARE_PROFESSIONAL.
• Last Name — Last name of a healthcare professional; only for HEALTHCARE_PROFESSIONAL.
• Office Name — Office name for healthcare professionals if different from location name.
• Gender — Gender of healthcare professional; only for HEALTHCARE_PROFESSIONAL.
• Npi — National Provider Identifier; for healthcare professional or facility location types.
• Address — Valid mailing address excluding P.O. Boxes.
• Address 2 — Additional address line excluding P.O. Boxes.
• Suppress Address — Boolean to indicate if street address should be hidden on listings.
• Display Address — Additional address info to assist visitors, even if address is suppressed.
• City — City name of the location.
• State — State/province code or name depending on country.
• Sublocality — Name of the location's sublocality.
• Zip — Postal or ZIP code.
• Country Code — Two-letter ISO 3166-1 country code; defaults to US if omitted.
• Service Area — Area served by the location, specified as radius or list of places; applies only to Google Business Profile.
• Phone — Valid primary phone number for the location.
• Is Phone Tracked — Boolean indicating if the listed phone number is a tracked number; requires phone to be provided in same request.
• Local Phone — Valid non-toll-free phone number required if tracking or toll-free rules apply.
• Alternate Phone — Additional valid phone number based on location country.
• Fax Phone — Fax phone number.
• Mobile Phone — Mobile phone number.
• Toll Free Phone — Toll-free phone number.
• Tty Phone — TTY phone number.
• Category Ids — Array of 1 to 10 valid Yext category IDs representing the location's categories.
• Featured Message — Short promotional message shown on listings without URLs, phone numbers, or profanity.
• Featured Message Url — URL linked from the featured message.
• Website Url — Main website URL for the location; required if displayWebsiteUrl is set.
• Display Website Url — Alternate short URL shown instead of websiteUrl; must be provided with websiteUrl.
• Reservation Url — URL for making reservations.
• Display Reservation Url — Alternate URL shown instead of reservationUrl; required with reservationUrl.
• Menu Url — URL linking to location's menu.
• Display Menu Url — Alternate URL shown instead of menuUrl; required with menuUrl.
• Order Url — URL used for placing orders fulfilled at the location.
• Display Order Url — Alternate URL shown instead of orderUrl; required with orderUrl.
• Hours — Business hours formatted as a comma-separated list according to Yext's specification.
• Additional Hours Text — Extra information about business hours that doesn't fit the hours field.
• Holiday Hours — JSON array of holiday hours; requires hours to be set.
• Description — General description of the location.
• Conditions Treated — JSON array listing medical conditions treated; only for healthcare professional/facility.
• Certifications — JSON array of certifications held; only for healthcare professional.
• Education List — JSON array of education/training types completed; only healthcare professional.
• Degrees — JSON array of degrees earned; only for healthcare professional.
• Admitting Hospitals — JSON array of hospitals where patients are admitted; only healthcare professional.
• Accepting New Patients — Boolean indicating if location is accepting new patients; only healthcare professional/facility.
• Closed — JSON object indicating if location is closed and its closing date.
• Payment Options — JSON array listing accepted payment methods, varies by country.
• Insurance Accepted — JSON array of insurance policies accepted; only healthcare professional.
• Logo — JSON object describing logo images.
• Photos — JSON array of up to 50 photos; must provide comprehensive list to avoid deletion.
• Headshot — JSON object describing a headshot image.
• Video Urls — JSON array of valid YouTube URLs for embedding video; only the first URL appears.
• Instagram Handle — Valid Instagram username without '@'.
• Twitter Handle — Valid Twitter handle without '@'; invalid handles are ignored with warnings.
• Google Website Override — URL to submit to Google Business Profile instead of websiteUrl.
• Google Cover Photo — JSON object for Google cover photo.
• Google Profile Photo — JSON object for Google profile photo.
• Google Attributes — JSON array of Google Business Profile attributes.
• Facebook Page Url — URL of the location's Facebook page, must be in valid format to be stored.
• Facebook Call To Action — JSON object for Facebook call-to-action button text and value.
• Facebook Cover Photo — JSON object for Facebook cover photo.
• Facebook Profile Picture — JSON object for Facebook profile picture.
• Uber Link Type — Display style for embedded Uber link: 'LINK' text or 'BUTTON'.
• Uber Link Text — Text for the embedded Uber link; only when Uber Link Type is 'LINK'.
• Uber Trip Branding Text — Call-to-action text shown in Uber app during trips; requires related fields if set.
• Uber Trip Branding Url — URL linked from Uber trip branding; requires related fields if set.
• Uber Trip Branding Description — Longer description near Uber trip branding call-to-action; requires related fields if set.
• Uber Embed Code — Code snippet for embedding Uber link in emails or web pages.
• Uber Link — Yext-powered link for Uber integration on web pages.
• Uber Link Raw — Uber universal link; only for US locations and LiveAPI.
• Year Established — Year the location was opened (1000 to current year + 10).
• Display Lat — Latitude coordinate for map pin display (-90 to 90).
• Display Lng — Longitude coordinate for map pin display (-180 to 180).
• Routable Lat — Latitude used for driving directions (-90 to 90).
• Routable Lng — Longitude used for driving directions (-180 to 180).
• Walkable Lat — Latitude used for walking directions (-90 to 90).
• Walkable Lng — Longitude used for walking directions (-180 to 180).
• Pickup Lat — Latitude for pickup spot location (-90 to 90).
• Pickup Lng — Longitude for pickup spot location (-180 to 180).
• Dropoff Lat — Latitude for dropoff spot location (-90 to 90).
• Dropoff Lng — Longitude for dropoff spot location (-180 to 180).
• Yext Display Lat — Latitude for map pin as calculated by Yext (-90 to 90).
• Yext Display Lng — Longitude for map pin as calculated by Yext (-180 to 180).
• Yext Routable Lat — Latitude for driving directions as calculated by Yext (-90 to 90).
• Yext Routable Lng — Longitude for driving directions as calculated by Yext (-180 to 180).
• Yext Walkable Lat — Latitude for walking directions as calculated by Yext (-90 to 90).
• Yext Walkable Lng — Longitude for walking directions as calculated by Yext (-180 to 180).
• Yext Pickup Lat — Latitude for pickup spot as calculated by Yext (-90 to 90).
• Yext Pickup Lng — Longitude for pickup spot as calculated by Yext (-180 to 180).
• Yext Dropoff Lat — Latitude for dropoff spot as calculated by Yext (-90 to 90).
• Yext Dropoff Lng — Longitude for dropoff spot as calculated by Yext (-180 to 180).
• Emails — Up to five valid email addresses for contacting this location.
• Specialities — Up to 100 non-empty speciality strings describing this location.
• Associations — Up to 100 non-empty association memberships relevant to this location.
• Products — Up to 100 non-empty strings representing products sold.
• Services — Up to 100 non-empty strings representing services offered.
• Brands — Up to 100 non-empty strings for brands sold.
• Language — Primary language code of the location's information.
• Languages — Up to 100 non-empty languages spoken at this location.
• Keywords — Up to 100 non-empty keywords associated with this location.
• Menus Label — Label for the location's Menus as shown on listings.
• Menu Ids — JSON array of menu IDs associated with the location.
• Bio Lists Label — Label for the location's bio lists on listings.
• Bio List Ids — JSON array of bio list IDs associated with the location.
• Product Lists Label — Label for product & services lists shown on listings.
• Product List Ids — JSON array of product list IDs associated with the location.
• Event Lists Label — Label for event lists shown on listings.
• Event List Ids — JSON array of event list IDs associated with the location.
• Folder Id — Valid Yext folder ID containing the location.
• Label Ids — JSON array of label IDs for categorizing the location internally.
• Custom Fields — JSON object of key-value pairs for custom fields and their values on the location.
• Intelligent Search Tracking Enabled — Boolean to enable or disable Intelligent Search Tracker for local search performance.
• Intelligent Search Tracking Frequency — Frequency (WEEKLY, MONTHLY, QUARTERLY) for sending search queries to track performance.
• Location Keywords — JSON array of keywords used for tracking search performance from location info.
• Custom Keywords — Additional JSON array of keywords for tracking search performance.
• Query Templates — JSON array specifying keyword arrangement patterns in tracking queries.
• Alternate Names — JSON array of alternate business names for search tracking.
• Alternate Websites — JSON array of alternate websites to track for the business.
• Competitors — JSON array of competitor names and websites for performance comparison.
• Tracking Sites — JSON array of search engines used to track search performance.
• Iso Region Code — ISO 3166-2 region code assigned or updated by Yext.
• Review Balancing URL — URL for auto-directing consumers to sites for leaving reviews.
• First Party Review Page — URL to the review-collection page for first-party reviews.
• Is Cluster Primary — Boolean indicating if this location is the primary in its group.

Output shape

a single record representing the updated location object in JSON format

The output is the JSON response from the Yext Knowledge API confirming the update. It does not contain pagination; errors or warnings are included in the response if any fields are invalid or ignored.