Yext Publisher Listings APIInstall

Summary

Update a location listing on Yext by specifying its Yext ID and providing any desired changes to fields such as name, address, contact info, business hours, social media handles, images, descriptions, services, and more.

Inputs

• Yext Id (required) — The unique identifier assigned by Yext to the location listing to be updated.
• Partner Id — The identifier assigned to the location by your system, if applicable.
• Name — The display name of the location.
• Address — The structured postal address of the location in JSON format.
• Phones — A JSON list of phone numbers for the location, including exactly one main number.
• Categories — A JSON array of business categories ordered by relevance.
• Description — A textual description of the location, HTML-escaped and with newlines converted to break tags as needed.
• Hours — Structured JSON defining regular business hours and holiday hours.
• Access Hours — JSON specifying daily access hours, holiday hours, and reopen dates.
• Brunch Hours — JSON specifying daily brunch hours, holiday hours, and reopen dates.
• Delivery Hours — JSON specifying daily delivery hours, holiday hours, and reopen dates.
• Drive Through Hours — JSON specifying daily drive-through hours, holiday hours, and reopen dates.
• Happy Hours — JSON specifying daily happy hours, holiday hours, and reopen dates.
• Kitchen Hours — JSON specifying daily kitchen hours, holiday hours, and reopen dates.
• Online Service Hours — JSON specifying daily online service hours, holiday hours, and reopen dates.
• Pickup Hours — JSON specifying daily pickup hours, holiday hours, and reopen dates.
• Senior Hours — JSON specifying daily senior hours, holiday hours, and reopen dates.
• Takeout Hours — JSON specifying daily takeout hours, holiday hours, and reopen dates.
• Images — A JSON array of photos associated with the location (e.g., storefront, logo), each under 5 MB.
• Videos — A JSON array of YouTube video references specified by the business.
• Featured Message — A JSON object containing the featured message of the location.
• Payment Options — A JSON array of payment methods accepted at the location.
• Urls — A JSON array of URLs related to the location such as website or reservation pages.
• Twitter Handle — The location's Twitter username without the leading '@'.
• Facebook Page Url — The full URL of the location's Facebook page.
• Instagram Handle — The location's Instagram username without the leading '@'.
• Attribution — A JSON object indicating listing attribution (e.g., to Yext or partners).
• Keywords — A JSON array of keywords for business discoverability.
• Lists — JSON data describing Enhanced Content Lists (ECLs) associated with the listing.
• Closed — Boolean indicating if the business location is closed (defaults to false).
• Close Date — Date string (YYYY-MM-DD) for the last day the location was or will be open.
• Reopen Date — Date string (YYYY-MM-DD) indicating when a temporarily closed location will reopen.
• Pickup And Delivery Options — JSON array specifying available pickup and delivery options.
• Specialties — JSON array listing the location's specialties.
• Brands — JSON array of brand names sold at the location.
• Products — JSON array of products or product groups available at the location.
• Services — JSON array of services provided at the location.
• Year Established — The year the location opened.
• Associations — JSON array of association memberships relevant to the location.
• Languages — JSON array of languages spoken at the location.
• Frequently Asked Questions — JSON array of frequently asked questions about the business.
• Black Owned Business — Boolean to indicate whether the business is black-owned.
• Price Range — Price tier of the location represented by $, $$, $$$ or $$$$.
• Neighborhood — String indicating the neighborhood of the business location.

Output shape

a JSON response object representing the updated listing or confirmation of update

Supports sending updated data for multiple listings with batching options. The response contains the updated location listing details. Errors will be returned according to the API error structure.