Primary key. Unique alphanumeric (Latin-1) ID assigned by the Customer.

Must refer to an account.id that already exists.

Cannot include:

• inappropriate language
• HTML markup or entities
• a URL or domain name
• a phone number
• control characters ([\x00-\x1F\x7F])

Should be in appropriate letter case (e.g., not in all capital letters)

The first name of the healthcare professional

NOTE: This field is only available to locations whose locationType is HEALTHCARE_PROFESSIONAL.

The middle name of the healthcare professional

NOTE: This field is only available to locations whose locationType is HEALTHCARE_PROFESSIONAL.

The last name of the healthcare professional

NOTE: This field is only available to locations whose locationType is HEALTHCARE_PROFESSIONAL.

The name of the office where the healthcare professional works, if different from locationName

NOTE: This field is only available to locations whose locationType is HEALTHCARE_PROFESSIONAL.

The gender of the healthcare professional

NOTE: This field is only available to locations whose locationType is HEALTHCARE_PROFESSIONAL.

The National Provider Identifier (NPI) of the healthcare provider

NOTE: This field is only available to locations whose locationType is HEALTHCARE_PROFESSIONAL or HEALTHCARE_FACILITY.

Must be a valid address

Cannot be a P.O. Box

Cannot be a P.O. Box

If true, do not show street address on listings. Defaults to false.

Provides additional information to help consumers get to the location. This string appears along with the location's address (e.g., In Menlo Mall, 3rd Floor).

It may also be used in conjunction with a hidden address (i.e., when suppressAddress is true) to give consumers information about where the location is found (e.g., Servicing the New York area).

Cannot be a P.O. Box

For US locations, the two-character code of the location’s state, or DC for the District of Columbia For non-US locations, the name of the location’s province / region / state

The name of the location's sublocality.

The location's postal code. For US locations, this field contains the five- or nine-digit ZIP code (the hyphen is optional). Validations are only done on zip if countryCode is US.

The two-character ISO 3166-1 code of the location's country or region. If omitted, US is used.

Area that is served by this location. It may be specified as a radius from the location's address or as a list of cities and/or postal codes.

Only for Google Business Profile: Currently, serviceArea is only supported by Google Business Profile and will not affect your listings on other sites.

Must be a valid phone number.

Set to true if the number listed in phone is a tracked phone number.

NOTE: When updating isPhoneTracked, you must provide a value for phone in the same request.

Must be a valid, non-toll-free phone number.

Required if:

• isPhoneTracked is true and the non-tracked number is a toll-free number, OR
• isPhoneTracked is false and phone is a toll-free number

Must be a valid phone number, based on the country specified in countryCode. Phone numbers for US locations must contain 10 digits.

Must be a valid phone number, based on the country specified in countryCode. Phone numbers for US locations must contain 10 digits.

Must be a valid phone number, based on the country specified in countryCode. Phone numbers for US locations must contain 10 digits.

Must be a valid phone number, based on the country specified in countryCode. Phone numbers for US locations must contain 10 digits.

Must be a valid phone number, based on the country specified in countryCode. Phone numbers for US locations must contain 10 digits.

Yext Category IDs. A Location must have at least one and at most 10 Categories.

IDs must be valid and selectable (i.e., cannot be parent categories).

NOTE: The list of category IDs that you send us must be comprehensive. For example, if you send us a list of IDs that does not include IDs that you sent in your last update, Yext considers the missing categories to be deleted, and we remove them from your listings.

The Featured Message. Default: Call today!

Cannot include:

• inappropriate language
• HTML markup
• a URL or domain name
• a phone number
• control characters ([\x00-\x1F\x7F])
• insufficient spacing

If you submit a Featured Message that contains profanity or more than 50 characters, it will be ignored. The success response will contain a warning message explaining why your Featured Message wasn't stored in the system.

Valid URL to which the Featured Message is linked

The URL of the location's website. This URL will be shown on your listings unless you specify a value for displayWebsiteUrl.

Must be a valid URL and is required whenever displayWebsiteUrl is specified.

The URL that is shown on your listings in place of websiteUrl. You can use displayWebsiteUrl to display a short, memorable web address that redirects consumers to the URL given in websiteUrl.

Must be a valid URL and be specified along with websiteUrl.

A valid URL used for reservations at this location.

The URL that is shown on your listings in place of reservationUrl. You can use displayReservationUrl to display a short, memorable web address that redirects consumers to the URL given in reservationUrl.

Must be a valid URL and be specified along with reservationUrl.

The URL of the location's menu.

The URL that is shown on your listings in place of menuUrl. You can use displayMenuUrl to display a short, memorable web address that redirects consumers to the URL given in menuUrl.

Must be a valid URL and be specified along with menuUrl.

The URL used to place orders that will be fulfilled at the location.

The URL that is shown on your listings in place of orderUrl. You can use displayOrderUrl to display a short, memorable web address that redirects consumers to the URL given in orderUrl.

Must be a valid URL and be specified along with orderUrl.

Hours should be submitted as a comma-separated list of days, where each day's hours are specified as follows:

d:oh:om:ch:cm

• d = day of the week –
  • 1 – Sunday
  • 2 – Monday
  • 3 – Tuesday
  • 4 – Wednesday
  • 5 – Thursday
  • 6 – Friday
  • 7 – Saturday
• oh:om = opening time in 24-hour format
• ch:cm = closing time in 24-hour format

Times with single-digit hours (e.g., 9 AM) can be submitted with or without a leading zero (9:00 or 09:00).

Example: open 9 AM to 5 PM Monday and Tuesday, open 10 AM to 4 PM on Saturday – 2:9:00:17:00,3:9:00:17:00,7:10:00:16:00

SPECIAL CASES:

• To indicate that a location is open 24 hours on a specific day, set 00:00 as both the opening and closing time for that day.
  • Example: open all day on Saturdays – 7:00:00:00:00
• To indicate that a location is closed on a specific day, omit that day from the list or set it as closed ("closed" is not case sensitive).
  • Example: closed on Sundays – 1:closed
  • NOTE: If a location is closed seven days a week, set at least one day to closed. Otherwise, hours is an empty string, and we assume you are not submitting hours information for that location.
• To indicate that a location has split hours on a specific day, submit a set of hours for each block of time the location is open.
  • Example: open from 9:00 AM to 12:00 PM and again from 1:00 PM to 5:00 PM on Mondays – 2:9:00:12:00,2:13:00:17:00

NOTE: To set hours for specific days of the year rather than days of the week, use holidayHours.

Additional information about business hours that does not fit in hours (e.g., Closed during the winter)

Holiday hours for this location.

NOTE: hours must be set in order for holidayHours to appear on your listings)

A list of the conditions treated by the healthcare provider

NOTE: This field is only available to locations whose locationType is HEALTHCARE_PROFESSIONAL or HEALTHCARE_FACILITY.

A list of the certifications held by the healthcare professional

NOTE: This field is only available to locations whose locationType is HEALTHCARE_PROFESSIONAL.

A list of the types of education and training completed by the healthcare professional

NOTE: This field is only available to locations whose locationType is HEALTHCARE_PROFESSIONAL.

A list of the degrees earned by the healthcare professional

NOTE: This field is only available to locations whose locationType is HEALTHCARE_PROFESSIONAL.

Valid values:

• ANP (Adult Nurse Practitioner)
• APN (Advanced Practice Nurse)
• APRN (Advanced Practice Registered Nurse)
• ARNP (Advanced Registered Nurse Practitioner)
• CNM (Certified Nurse Midwife)
• CNP (Certified Nurse Practitioner)
• CNS (Clinical Nurse Specialist)
• CPNP (Certified Pediatric Nurse Practitioner)
• CRNA (Certified Registered Nurse Anesthetist)
• CRNP (Certified Registered Nurse Practitioner)
• DC (Doctor of Chiropractic)
• DDS (Doctor of Dental Surgery)
• DMD (Doctor of Dental Medicine)
• DO (Doctor of Osteopathy)
• DPM (Doctor of Podiatric Medicine)
• DVM (Doctor of Veterinary Medicine)
• FNP (Family Nurse Practitioner)
• GNP (Geriatric Nurse Practitioner)
• LAC (Licensed Acupuncturist)
• LPN (Licensed Practical Nurse)
• MD (Medical Doctor)
• ND (Naturopathic Doctor)
• NP (Nurse Practitioner)
• OD (Doctor of Optometry)
• PA (Physician Assistant)
• PAC (Physician Assistant Certified)
• PHARMD (Doctor of Pharmacy)
• PHD (Doctor of Philosophy)
• PNP (Pediatric Nurse Practitioner)
• VMD (Veterinary Medical Doctor)
• WHNP (Womens Health Nurse Practitioner)

A list of hospitals where the healthcare professional admits patients

NOTE: This field is only available to locations whose locationType is HEALTHCARE_PROFESSIONAL.

Indicates whether the healthcare provider is accepting new patients

Default is true

NOTE: This field is only available to locations whose locationType is HEALTHCARE_PROFESSIONAL or HEALTHCARE_FACILITY.

A set of field-value pairs indicating whether the location is closed and, if it is closed, the date of its closing.

NOTE: This field does not appear in the GET response unless it has been explicitly set in a PUT request.

The payment methods accepted at this location

Valid elements depend on the location's country. For US locations, valid elements are:

• AMERICANEXPRESS
• CASH
• CHECK
• DINERSCLUB
• DISCOVER
• FINANCING
• INVOICE
• MASTERCARD
• TRAVELERSCHECK
• VISA
• ANDROIDPAY
• APPLEPAY
• SAMSUNGPAY
• BITCOIN
• PAYPAL

A list of insurance policies accepted by the healthcare provider

NOTE: This field is only available to locations whose locationType is HEALTHCARE_PROFESSIONAL.

Up to 50 Photos.

NOTE: The list of photos that you send us must be comprehensive. For example, if you send us a list of photos that does not include photos that you sent in your last update, Yext considers the missing photos to be deleted, and we remove them from your listings.

A portrait of the healthcare professional

NOTE: This field is only available to locations whose locationType is HEALTHCARE_PROFESSIONAL.

Valid YouTube URLs for embedding a video on some publisher sites.

NOTE: Currently, only the first URL in the Array appears in your listings.

Valid Instagram username for the location (e.g., NewCityFiat (without the leading "@"))

Valid Twitter handle for the location (e.g., JohnSmith (without the leading '@')). If you submit an invalid Twitter handle, it will be ignored. The success response will contain a warning message explaining why your Twitter handle wasn't stored in the system.

The URL you would like to submit to Google Business Profile in place of the one given in websiteUrl (if applicable).

For example, if you want to analyze the traffic driven by your Google listings separately from other traffic, enter the alternate URL that you will use for tracking in this field.

The cover photo for your business's Google profile

NOTE: Your cover photo must meet all of the following requirements:

• have a 16:9 aspect ratio
• be at least 480 x 270 pixels
• be no more than 2120 x 1192 pixels

The profile photo for your business's Google profile

NOTE: Your profile picture must meet all of the following requirements:

• be a square
• be at least 250 x 250 pixels

The Google Business Profile attributes for this location.

URL for the location's Facebook Page.

Valid formats:

• facebook.com/profile.php?id=[numId]
• facebook.com/group.php?gid=[numId]
• facebook.com/groups/[numId]
• facebook.com/[Name]
• facebook.com/pages/[Name]/[numId]

where [Name] is a String and [numId] is an Integer

If you submit a URL that is not in one of the valid formats, it will be ignored. The success response will contain a warning message explaining why the URL wasn't stored in the system.

NOTE: This value is automatically set to the location's Facebook Page URL. You can only manually set facebookPageUrl if the location meets one of the following criteria:

• It is not subscribed to a Listings package that contains Facebook.
• It is opted out of Facebook.

Designates the Facebook Call-to-Action button text and value

The cover photo for your business's Facebook profile

Displayed as a 851 x 315 pixel image

You must have a cover photo in order for your listing to appear on Facebook.

NOTE: Your cover photo must be at least 400 pixels wide.

The profile picture for your business's Facebook profile

You must have a profile picture in order for your listing to appear on Facebook.

NOTE: Your profile picture must be larger than 180 x 180 pixels.

Indicates whether the embedded Uber link for this location appears as text or a button

When consumers click on this link on a mobile device, the Uber app (if installed) will open with your location set as the trip destination. If the Uber app is not installed, the consumer will be prompted to download it.

The text of the embedded Uber link

Default is "Ride there with Uber".

NOTE: This field is only available if uberLinkType is LINK.

The text of the call-to-action that will appear in the Uber app during a trip to your location (e.g., Check out our menu!)

NOTE: If a value for uberTripBrandingText is provided, values must also be provided for uberTripBrandingUrl and uberTripBrandingDescription.

The URL that the consumer will be redirected to when tapping on the call-to-action in the Uber app during a trip to your location.

NOTE: If a value for uberTripBrandingUrl is provided, values must also be provided for uberTripBrandingText and uberTripBrandingDescription.

A longer description that will appear near the call-to-action in the Uber app during a trip to your location.

NOTE: If a value for uberTripBrandingDescription is provided, values must also be provided for uberTripBrandingText and uberTripBrandingUrl.

The year that this location was opened, not the number of years it was open

Minimum of 1000, maximum of current year + 10.

Latitude where the map pin should be displayed, as provided by you

Between -90.0 and 90.0, inclusive

Longitude where the map pin should be displayed, as provided by you

Between -180.0 and 180.0, inclusive

Latitude to use for driving directions to the location, as provided by you

Between -90.0 and 90.0, inclusive

Longitude to use for driving directions to the location, as provided by you

Between -180.0 and 180.0, inclusive

Latitude to use for walking directions to the location, as provided by you

Between -90.0 and 90.0, inclusive

Longitude to use for walking directions to the location, as provided by you

Between -180.0 and 180.0, inclusive

Latitude to use for pickup spot for the location, as provided by you

Between -90.0 and 90.0, inclusive

Longitude to use for pickup spot for the location, as provided by you

Between -180.0 and 180.0, inclusive

Latitude to use for drop off spot for the location, as provided by you

Between -90.0 and 90.0, inclusive

Longitude to use for drop off spot for the location, as provided by you

Between -180.0 and 180.0, inclusive

Up to five emails addresses for reaching this location

Must be valid email addresses

Up to 100 specialities (e.g., for food and dining: Chicago style)

All strings must be non-empty when trimmed of whitespace.

Up to 100 association memberships relevant to the location (e.g., New York Doctors Association)

All strings must be non-empty when trimmed of whitespace.

Up to 100 products sold at this location

All strings must be non-empty when trimmed of whitespace.

Up to 100 services offered at this location

All strings must be non-empty when trimmed of whitespace.

Up to 100 brands sold by this location

All strings must be non-empty when trimmed of whitespace.

Language code of the language in which this location's information is provided. This language is considered the Location's primary language in our system.

If you would like to provide your Location data in more than one language, you can create a Language Profile for each of these additional (alternate) languages.

Up to 100 languages spoken at this location.

All strings must be non-empty when trimmed of whitespace.

Up to 100 keywords may be provided

All strings must be non-empty when trimmed of whitespace.

Label to be used for this location’s Menus. This label will appear on your location's listings.

IDs of Menus associated with this location.

Label to be used for this location’s Bio lists. This label will appear on your location's listings.

IDs of Bio lists associated with this location.

Label to be used for this location’s Product & Services lists. This label will appear on your location's listings.

IDs of Product lists associated with this location.

Label to be used for this location’s Event lists. This label will appear on your location's listings.

IDs of Event lists associated with this location.

The folder that this location is in. Must be a valid, existing Yext Folder ID

The IDs of the location labels that have been added to this location. Location labels help you identify locations that share a certain characteristic; they do not appear on your location's listings.

NOTE: You can only add labels that have already been created via our web interface. Currently, it is not possible to create new labels via the API.

In Locations: Update requests:

• If the v parameter is before 20180223: setting the value of labelIds to an empty array has no effect on the current value
• If the v parameter is 20180223 or after: setting the value of labelIds to an empty array deletes the current value

A set of key-value pairs indicating the location's custom fields and their values. The keys are the ids of the custom fields, and the values are the fields' contents for this location.

To retrieve a list of custom fields for your account, use the Custom Fields: List endpoint.

If a field's type is SINGLE_OPTION or MULTI_OPTION, the option or options that apply to this location must be represented by their **key**s.

Examples of each type of custom field:

• BOOLEAN:
  • { "9662": "true" }
• DAILY_TIMES:
  • { "10012": { "dailyTimes": "2:7:00,3:7:00,4:7:00,5:7:00,6:7:00,7:7:00,1:7:00" } }
• DATE:
  • { "7066": "2016-10-12" }
• GALLERY:
  • { "7070": [ { "url": "http://a.mktgcdn.com/p/ounkg7aq6Oy029-sRf4CIH64/128x128.jpg" }, { "url": "http://a.mktgcdn.com/p/YkQGqxK8jFBqOlailQ9QIBsgs/1.0000/316x316.png" } ] }
• HOURS:
  • { "10011": { "hours": "1:7:00:20:00,2:7:00:20:00,3:7:00:20:00,4:7:00:20:00,5:7:00:20:00,6:7:00:20:00,7:7:00:20:00", "additionalHoursText": "Also by appointment" }
• LOCATION_LIST:
  • { "8098" : [ "locationId1", "locationId2" ] }
• MULTILINE_TEXT (up to 4,000 characters):
  • { "1592": "Take Route 13 south. Pass Riverrun Reservoir. At the traffic light before the post office, turn right off of Route 13. Pass the library and community center on your right and then pass a diner on your left. Cross over the bridge and at the third intersection, turn left onto Jones Street. We are located on the right side in the middle of the block." }
• MULTI_OPTION:
  • { "7068": ["2614", "2615"] } ("2614" and "2615" are the options' **key**s)
• NUMBER:
  • { "7078": "123" }
• PHOTO:
  • { "7071": { "url": "http://a.mktgcdn.com/p/bRtQXQZP2kEzgy2C8/800x800.jpg", "description": "New storefront", "details": "A picture of the new storefront" } }
  • { "7071": null } (This setting will clear the existing value of the Photo custom field.)
• SINGLE_OPTION:
  • { "7069": "2617" } ("2617" is the option's key)
• TEXT (up to 255 characters):
  • { "6157": "Buy One, Get One 50% Off" }
• TEXT_LIST:
  • { "7072": [ "Item 1", "Item 2", "Item 3" ] }
• URL:
  • { "9381": "http://www.location.example.com" }
• VIDEO:
  • { "7077": { "url": "http://www.youtube.com/watch?v=6KQPho" } }
• VIDEO_GALLERY:
  • { "8452": [ { "url": "http://www.youtube.com/watch?v=B1EC1U" }, { "url": "http://www.youtube.com/watch?v=SkEtnN" } ] }

Indicates whether Intelligent Search Tracker is enabled.

The Intelligent Search Tracker allows you to understand your performance in local search.

How often we send search queries to track your search performance.

Keywords that we will use to track your search performance. These keywords are based on the location information you've stored in our system.

Additional keywords you would like us to use when tracking your search performance

The ways in which your keywords will be arranged in the search queries we use to track your performance

Other names for your business that you would like us to use when tracking your search performance

Other websites for your business that we should look for when tracking your search performance

The names and websites of the competitors whose search performance you would like to compare to your own

The search engines that we will use to track your performance

Indicates whether the location is the primary location in its group

The formality of clothing typically worn at this location

NOTE: This field is only available to locations whose locationType is RESTAURANT.

The typical price of products sold at this location, on a scale of 1 (low) to 4 (high)

NOTE: This field is only available to locations whose locationType is RESTAURANT.

Types of meals served at this location

NOTE: This field is only available to locations whose locationType is RESTAURANT.

Valid values:

• BREAKFAST
• LUNCH
• BRUNCH
• HAPPY_HOUR
• LATE_NIGHT

For ATMs, the external ID of the location that the ATM is installed in. The location must be in the same business account as the ATM.

NOTE: This field is only available to locations whose locationType is ATM.

ID of the user who is the primary Knowledge Assistant contact for the entity

Indicates whether or not review response conversations are enabled for the Yext Knowledge Assistant