Locations (Legacy): List
Get multiple Locations (primary profiles only).
path Parameters
accountId required | string |
query Parameters
v required | string A date in |
limit | integer <= 50 Default: 10 Number of results to return. |
offset | integer Default: 0 Number of results to skip. Used to page through results.
Cannot be used together with |
resolvePlaceholders | boolean Default: false Optional parameter to resolve all embedded fields in a Location object response.
|
pageToken | string If a response to a previous request contained the |
Responses
Response samples
- 200
- default
{- "meta": {
- "uuid": "4f72b877-e2d0-4de4-9324-b9cf2c03e1a0"
}, - "response": {
- "count": 0,
- "nextPageToken": "string",
- "locations": [
- {
- "id": "string",
- "uid": "string",
- "accountId": "string",
- "timestamp": 0,
- "timezone": "string",
- "locationType": "LOCATION",
- "locationName": "string",
- "firstName": "string",
- "middleName": "string",
- "lastName": "string",
- "officeName": "string",
- "gender": "FEMALE",
- "npi": "string",
- "address": "string",
- "address2": "string",
- "suppressAddress": true,
- "displayAddress": "string",
- "city": "string",
- "state": "string",
- "sublocality": "string",
- "zip": "string",
- "countryCode": "st",
- "serviceArea": {
- "radius": 0,
- "unit": "string",
- "places": [
- "string"
]
}, - "phone": "string",
- "isPhoneTracked": true,
- "localPhone": "string",
- "alternatePhone": "string",
- "faxPhone": "string",
- "mobilePhone": "string",
- "tollFreePhone": "string",
- "ttyPhone": "string",
- "categoryIds": [
- "string"
], - "featuredMessage": "string",
- "featuredMessageUrl": "string",
- "websiteUrl": "string",
- "displayWebsiteUrl": "string",
- "reservationUrl": "string",
- "displayReservationUrl": "string",
- "menuUrl": "string",
- "displayMenuUrl": "string",
- "orderUrl": "string",
- "displayOrderUrl": "string",
- "hours": "string",
- "additionalHoursText": "string",
- "holidayHours": [
- {
- "hours": "string",
- "date": "2019-08-24",
- "isRegularHours": false
}
], - "description": "stringstri",
- "conditionsTreated": [
- "string"
], - "certifications": [
- "string"
], - "educationList": [
- {
- "type": "FELLOWSHIP",
- "institutionName": "string",
- "yearCompleted": "string"
}
], - "degrees": [
- "string"
], - "admittingHospitals": [
- "string"
], - "acceptingNewPatients": true,
- "closed": {
- "isClosed": true
}, - "paymentOptions": [
- "string"
], - "insuranceAccepted": [
- "string"
], - "logo": {
- "url": "string",
- "sourceUrl": "string",
- "description": "string",
- "details": "string",
- "alternateText": "string",
- "width": 0,
- "height": 0,
- "derivatives": [
- {
- "url": "string",
- "width": 0,
- "height": 0
}
]
}, - "photos": [
- {
- "url": "string",
- "sourceUrl": "string",
- "description": "string",
- "details": "string",
- "alternateText": "string",
- "width": 0,
- "height": 0,
- "derivatives": [
- {
- "url": "string",
- "width": 0,
- "height": 0
}
]
}
], - "headshot": {
- "url": "string",
- "sourceUrl": "string",
- "description": "string",
- "details": "string",
- "alternateText": "string",
- "width": 0,
- "height": 0,
- "derivatives": [
- {
- "url": "string",
- "width": 0,
- "height": 0
}
]
}, - "videoUrls": [
- "string"
], - "instagramHandle": "string",
- "twitterHandle": "string",
- "googleWebsiteOverride": "string",
- "googleCoverPhoto": {
- "url": "string",
- "sourceUrl": "string",
- "description": "string",
- "details": "string",
- "alternateText": "string",
- "width": 0,
- "height": 0,
- "derivatives": [
- {
- "url": "string",
- "width": 0,
- "height": 0
}
]
}, - "googleProfilePhoto": {
- "url": "string",
- "sourceUrl": "string",
- "description": "string",
- "details": "string",
- "alternateText": "string",
- "width": 0,
- "height": 0,
- "derivatives": [
- {
- "url": "string",
- "width": 0,
- "height": 0
}
]
}, - "googleAttributes": [
- {
- "id": "string",
- "optionIds": [
- "string"
]
}
], - "facebookPageUrl": "string",
- "facebookCallToAction": {
- "type": "NONE",
- "value": "string"
}, - "facebookCoverPhoto": {
- "url": "string",
- "sourceUrl": "string",
- "description": "string",
- "details": "string",
- "alternateText": "string",
- "width": 0,
- "height": 0,
- "derivatives": [
- {
- "url": "string",
- "width": 0,
- "height": 0
}
]
}, - "facebookProfilePicture": {
- "url": "string",
- "sourceUrl": "string",
- "description": "string",
- "details": "string",
- "alternateText": "string",
- "width": 0,
- "height": 0,
- "derivatives": [
- {
- "url": "string",
- "width": 0,
- "height": 0
}
]
}, - "uberLinkType": "LINK",
- "uberLinkText": "string",
- "uberTripBrandingText": "string",
- "uberTripBrandingUrl": "string",
- "uberTripBrandingDescription": "string",
- "uberEmbedCode": "string",
- "uberLink": "string",
- "uberLinkRaw": "string",
- "yearEstablished": "stri",
- "displayLat": 0,
- "displayLng": 0,
- "routableLat": 0,
- "routableLng": 0,
- "walkableLat": 0,
- "walkableLng": 0,
- "pickupLat": 0,
- "pickupLng": 0,
- "dropoffLat": 0,
- "dropoffLng": 0,
- "yextDisplayLat": 0,
- "yextDisplayLng": 0,
- "yextRoutableLat": 0,
- "yextRoutableLng": 0,
- "yextWalkableLat": 0,
- "yextWalkableLng": 0,
- "yextPickupLat": 0,
- "yextPickupLng": 0,
- "yextDropoffLat": 0,
- "yextDropoffLng": 0,
- "emails": [
- "string"
], - "specialities": [
- "string"
], - "associations": [
- "string"
], - "products": [
- "string"
], - "services": [
- "string"
], - "brands": [
- "string"
], - "language": "string",
- "languages": [
- "string"
], - "keywords": [
- "string"
], - "menusLabel": "string",
- "menuIds": [
- "string"
], - "bioListsLabel": "string",
- "bioListIds": [
- "string"
], - "productListsLabel": "string",
- "productListIds": [
- "string"
], - "eventListsLabel": "string",
- "eventListIds": [
- "string"
], - "folderId": "string",
- "labelIds": [
- "string"
], - "customFields": {
- "property1": { },
- "property2": { }
}, - "intelligentSearchTrackingEnabled": true,
- "intelligentSearchTrackingFrequency": "WEEKLY",
- "locationKeywords": [
- "NAME"
], - "customKeywords": [
- "string"
], - "queryTemplates": [
- "KEYWORD"
], - "alternateNames": [
- "string"
], - "alternateWebsites": [
- "string"
], - "competitors": [
- {
- "name": "string",
- "website": "string"
}
], - "trackingSites": [
- "GOOGLE_DESKTOP"
], - "isoRegionCode": "string",
- "reviewBalancingURL": "string",
- "firstPartyReviewPage": "string",
- "isClusterPrimary": true,
- "schemaTypes": [
- "string"
], - "attire": "UNSPECIFIED",
- "priceRange": "UNSPECIFIED",
- "mealsServed": [
- "string"
], - "locatedIn": "string",
- "primaryContact": "string",
- "reviewResponseConversationEnabled": true,
- "holidayHoursConfirmationEnabled": true
}
]
}
}
Locations (Legacy): Create
Create a new Location.
Required fields
locationName
address
city
state
zip
Optional fields that trigger warnings
Submitting invalid values for certain optional fields will not trigger an error response. Instead, the success response will contain warning messages explaining why the invalid optional values were not stored in the system. The fields that generate warning messages are:
logo
photos
twitterHandle
facebookPageUrl
languages
path Parameters
accountId required | string |
query Parameters
v required | string A date in |
Request Body schema: application/json
id | string <= 50 characters Primary key. Unique alphanumeric (Latin-1) ID assigned by the Customer. |
accountId | string <= 50 characters Must refer to an account.id that already exists. |
locationType | string Enum: "LOCATION" "HEALTHCARE_PROFESSIONAL" "HEALTHCARE_FACILITY" "RESTAURANT" "ATM" |
locationName | string <= 100 characters Cannot include:
Should be in appropriate letter case (e.g., not in all capital letters) |
firstName | string The first name of the healthcare professional NOTE: This field is only available to locations whose |
middleName | string The middle name of the healthcare professional NOTE: This field is only available to locations whose |
lastName | string The last name of the healthcare professional NOTE: This field is only available to locations whose |
officeName | string The name of the office where the healthcare professional works, if different from locationName NOTE: This field is only available to locations whose |
gender | string Enum: "FEMALE" "F" "MALE" "M" "UNSPECIFIED" The gender of the healthcare professional NOTE: This field is only available to locations whose |
npi | string The National Provider Identifier (NPI) of the healthcare provider NOTE: This field is only available to locations whose |
address | string <= 255 characters Must be a valid address Cannot be a P.O. Box |
address2 | string <= 255 characters Cannot be a P.O. Box |
suppressAddress | boolean If true, do not show street address on listings. Defaults to false. |
displayAddress | string <= 255 characters 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 |
city | string <= 80 characters |
state | string <= 80 characters 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 |
sublocality | string <= 255 characters The name of the location's sublocality. |
zip | string <= 10 characters 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 |
countryCode | string <= 2 characters The two-character ISO 3166-1 code of the location's country or region. If omitted, US is used. |
object 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. | |
phone | string Must be a valid phone number. |
isPhoneTracked | boolean 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. |
localPhone | string Must be a valid, non-toll-free phone number. Required if:
|
alternatePhone | string Must be a valid phone number, based on the country specified in |
faxPhone | string Must be a valid phone number, based on the country specified in |
mobilePhone | string Must be a valid phone number, based on the country specified in |
tollFreePhone | string Must be a valid phone number, based on the country specified in |
ttyPhone | string Must be a valid phone number, based on the country specified in |
categoryIds | Array of strings 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. |
featuredMessage | string <= 50 characters The Featured Message. Default: Call today! Cannot include:
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. |
featuredMessageUrl | string <= 255 characters Valid URL to which the Featured Message is linked |
websiteUrl | string <= 255 characters The URL of the location's website. This URL will be shown on your listings unless you specify a value for Must be a valid URL and is required whenever |
displayWebsiteUrl | string <= 255 characters The URL that is shown on your listings in place of Must be a valid URL and be specified along with |
reservationUrl | string <= 255 characters A valid URL used for reservations at this location. |
displayReservationUrl | string <= 255 characters The URL that is shown on your listings in place of Must be a valid URL and be specified along with |
menuUrl | string <= 255 characters The URL of the location's menu. |
displayMenuUrl | string <= 255 characters The URL that is shown on your listings in place of Must be a valid URL and be specified along with |
orderUrl | string <= 255 characters The URL used to place orders that will be fulfilled at the location. |
displayOrderUrl | string <= 255 characters The URL that is shown on your listings in place of Must be a valid URL and be specified along with |
hours | string <= 255 characters 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
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:
NOTE: To set hours for specific days of the year rather than days of the week, use holidayHours. |
additionalHoursText | string <= 255 characters Additional information about business hours that does not fit in hours (e.g., Closed during the winter) |
Array of objects Holiday hours for this location. NOTE: hours must be set in order for holidayHours to appear on your listings) | |
description | string [ 10 .. 5000 ] characters |
conditionsTreated | Array of strings A list of the conditions treated by the healthcare provider NOTE: This field is only available to locations whose |
certifications | Array of strings A list of the certifications held by the healthcare professional NOTE: This field is only available to locations whose |
Array of objects A list of the types of education and training completed by the healthcare professional NOTE: This field is only available to locations whose | |
degrees | Array of strings A list of the degrees earned by the healthcare professional NOTE: This field is only available to locations whose Valid values:
|
admittingHospitals | Array of strings A list of hospitals where the healthcare professional admits patients NOTE: This field is only available to locations whose |
acceptingNewPatients | boolean Indicates whether the healthcare provider is accepting new patients Default is true NOTE: This field is only available to locations whose |
object 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. | |
paymentOptions | Array of strings The payment methods accepted at this location Valid elements depend on the location's country. For US locations, valid elements are:
|
insuranceAccepted | Array of strings A list of insurance policies accepted by the healthcare provider NOTE: This field is only available to locations whose |
object | |
Array of objects 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. | |
object A portrait of the healthcare professional NOTE: This field is only available to locations whose | |
videoUrls | Array of strings[ items <= 255 characters ] Valid YouTube URLs for embedding a video on some publisher sites. NOTE: Currently, only the first URL in the Array appears in your listings. |
instagramHandle | string Valid Instagram username for the location (e.g., NewCityFiat (without the leading "@")) |
twitterHandle | string <= 15 characters 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. |
googleWebsiteOverride | string <= 255 characters 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. |
object The cover photo for your business's Google profile NOTE: Your cover photo must meet all of the following requirements:
| |
object The profile photo for your business's Google profile NOTE: Your profile picture must meet all of the following requirements:
| |
Array of objects The Google Business Profile attributes for this location. | |
facebookPageUrl | string <= 255 characters URL for the location's Facebook Page. Valid formats:
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:
|
object Designates the Facebook Call-to-Action button text and value | |
object 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. | |
object 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. | |
uberLinkType | string Enum: "LINK" "BUTTON" 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. |
uberLinkText | string <= 100 characters The text of the embedded Uber link Default is "Ride there with Uber". NOTE: This field is only available if uberLinkType is LINK. |
uberTripBrandingText | string <= 28 characters 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. |
uberTripBrandingUrl | string 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. |
uberTripBrandingDescription | string <= 150 characters 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. |
yearEstablished | string <= 4 characters The year that this location was opened, not the number of years it was open Minimum of 1000, maximum of current year + 10. |
displayLat | number <double> Latitude where the map pin should be displayed, as provided by you Between -90.0 and 90.0, inclusive |
displayLng | number <double> Longitude where the map pin should be displayed, as provided by you Between -180.0 and 180.0, inclusive |
routableLat | number <double> Latitude to use for driving directions to the location, as provided by you Between -90.0 and 90.0, inclusive |
routableLng | number <double> Longitude to use for driving directions to the location, as provided by you Between -180.0 and 180.0, inclusive |
walkableLat | number <double> Latitude to use for walking directions to the location, as provided by you Between -90.0 and 90.0, inclusive |
walkableLng | number <double> Longitude to use for walking directions to the location, as provided by you Between -180.0 and 180.0, inclusive |
pickupLat | number <double> Latitude to use for pickup spot for the location, as provided by you Between -90.0 and 90.0, inclusive |
pickupLng | number <double> Longitude to use for pickup spot for the location, as provided by you Between -180.0 and 180.0, inclusive |
dropoffLat | number <double> Latitude to use for drop off spot for the location, as provided by you Between -90.0 and 90.0, inclusive |
dropoffLng | number <double> Longitude to use for drop off spot for the location, as provided by you Between -180.0 and 180.0, inclusive |
emails | Array of strings[ items <= 255 characters ] Up to five emails addresses for reaching this location Must be valid email addresses |
specialities | Array of strings[ items <= 100 characters ] Up to 100 specialities (e.g., for food and dining: Chicago style) All strings must be non-empty when trimmed of whitespace. |
associations | Array of strings[ items <= 100 characters ] 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. |
products | Array of strings[ items <= 100 characters ] Up to 100 products sold at this location All strings must be non-empty when trimmed of whitespace. |
services | Array of strings[ items <= 100 characters ] Up to 100 services offered at this location All strings must be non-empty when trimmed of whitespace. |
brands | Array of strings[ items <= 100 characters ] Up to 100 brands sold by this location All strings must be non-empty when trimmed of whitespace. |
language | string <= 10 characters 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. |
languages | Array of strings[ items <= 100 characters ] Up to 100 languages spoken at this location. All strings must be non-empty when trimmed of whitespace. |
keywords | Array of strings[ items <= 100 characters ] Up to 100 keywords may be provided All strings must be non-empty when trimmed of whitespace. |
menusLabel | string Label to be used for this location’s Menus. This label will appear on your location's listings. |
menuIds | Array of strings IDs of Menus associated with this location. |
bioListsLabel | string Label to be used for this location’s Bio lists. This label will appear on your location's listings. |
bioListIds | Array of strings IDs of Bio lists associated with this location. |
productListsLabel | string Label to be used for this location’s Product & Services lists. This label will appear on your location's listings. |
productListIds | Array of strings IDs of Product lists associated with this location. |
eventListsLabel | string Label to be used for this location’s Event lists. This label will appear on your location's listings. |
eventListIds | Array of strings IDs of Event lists associated with this location. |
folderId | string The folder that this location is in. Must be a valid, existing Yext Folder ID |
labelIds | Array of strings 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:
|
object A set of key-value pairs indicating the location's custom fields and their values. The keys are the To retrieve a list of custom fields for your account, use the Custom Fields: List endpoint. If a field's Examples of each type of custom field:
| |
intelligentSearchTrackingEnabled | boolean Indicates whether Intelligent Search Tracker is enabled. The Intelligent Search Tracker allows you to understand your performance in local search. |
intelligentSearchTrackingFrequency | string Enum: "WEEKLY" "MONTHLY" "QUARTERLY" How often we send search queries to track your search performance. |
locationKeywords | Array of strings Items Enum: "NAME" "PRIMARY_CATEGORY" Keywords that we will use to track your search performance. These keywords are based on the location information you've stored in our system. |
customKeywords | Array of strings Additional keywords you would like us to use when tracking your search performance |
queryTemplates | Array of strings Items Enum: "KEYWORD" "KEYWORD_ZIP" "KEYWORD_CITY" "KEYWORD_IN_CITY" "KEYWORD_NEAR_ME" "KEYWORD_CITY_STATE" The ways in which your keywords will be arranged in the search queries we use to track your performance |
alternateNames | Array of strings Other names for your business that you would like us to use when tracking your search performance |
alternateWebsites | Array of strings Other websites for your business that we should look for when tracking your search performance |
Array of objects The names and websites of the competitors whose search performance you would like to compare to your own | |
trackingSites | Array of strings Items Enum: "GOOGLE_DESKTOP" "GOOGLE_MOBILE" "BING_DESKTOP" "BING_MOBILE" "YAHOO_DESKTOP" "YAHOO_MOBILE" The search engines that we will use to track your performance |
isClusterPrimary | boolean Indicates whether the location is the primary location in its group |
attire | string Enum: "UNSPECIFIED" "DRESSY" "CASUAL" "FORMAL" The formality of clothing typically worn at this location NOTE: This field is only available to locations whose |
priceRange | string Enum: "UNSPECIFIED" "ONE" "TWO" "THREE" "FOUR" 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 |
mealsServed | Array of strings Types of meals served at this location NOTE: This field is only available to locations whose Valid values:
|
locatedIn | string 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 |
primaryContact | string ID of the user who is the primary Knowledge Assistant contact for the entity |
reviewResponseConversationEnabled | boolean Indicates whether or not review response conversations are enabled for the Yext Knowledge Assistant |
holidayHoursConfirmationEnabled | boolean Indicates whether or not holiday hour confirmation alerts are enabled for the Yext Knowledge Assistant |
Responses
Request samples
- Payload
{- "id": "string",
- "accountId": "string",
- "locationType": "LOCATION",
- "locationName": "string",
- "firstName": "string",
- "middleName": "string",
- "lastName": "string",
- "officeName": "string",
- "gender": "FEMALE",
- "npi": "string",
- "address": "string",
- "address2": "string",
- "suppressAddress": true,
- "displayAddress": "string",
- "city": "string",
- "state": "string",
- "sublocality": "string",
- "zip": "string",
- "countryCode": "st",
- "serviceArea": {
- "radius": 0,
- "unit": "string",
- "places": [
- "string"
]
}, - "phone": "string",
- "isPhoneTracked": true,
- "localPhone": "string",
- "alternatePhone": "string",
- "faxPhone": "string",
- "mobilePhone": "string",
- "tollFreePhone": "string",
- "ttyPhone": "string",
- "categoryIds": [
- "string"
], - "featuredMessage": "string",
- "featuredMessageUrl": "string",
- "websiteUrl": "string",
- "displayWebsiteUrl": "string",
- "reservationUrl": "string",
- "displayReservationUrl": "string",
- "menuUrl": "string",
- "displayMenuUrl": "string",
- "orderUrl": "string",
- "displayOrderUrl": "string",
- "hours": "string",
- "additionalHoursText": "string",
- "holidayHours": [
- {
- "hours": "string",
- "date": "2019-08-24",
- "isRegularHours": false
}
], - "description": "stringstri",
- "conditionsTreated": [
- "string"
], - "certifications": [
- "string"
], - "educationList": [
- {
- "type": "FELLOWSHIP",
- "institutionName": "string",
- "yearCompleted": "string"
}
], - "degrees": [
- "string"
], - "admittingHospitals": [
- "string"
], - "acceptingNewPatients": true,
- "closed": {
- "isClosed": true
}, - "paymentOptions": [
- "string"
], - "insuranceAccepted": [
- "string"
], - "logo": {
- "url": "string",
- "description": "string",
- "details": "string",
- "alternateText": "string"
}, - "photos": [
- {
- "url": "string",
- "description": "string",
- "details": "string",
- "alternateText": "string"
}
], - "headshot": {
- "url": "string",
- "description": "string",
- "details": "string",
- "alternateText": "string"
}, - "videoUrls": [
- "string"
], - "instagramHandle": "string",
- "twitterHandle": "string",
- "googleWebsiteOverride": "string",
- "googleCoverPhoto": {
- "url": "string",
- "description": "string",
- "details": "string",
- "alternateText": "string"
}, - "googleProfilePhoto": {
- "url": "string",
- "description": "string",
- "details": "string",
- "alternateText": "string"
}, - "googleAttributes": [
- {
- "id": "string",
- "optionIds": [
- "string"
]
}
], - "facebookPageUrl": "string",
- "facebookCallToAction": {
- "type": "NONE",
- "value": "string"
}, - "facebookCoverPhoto": {
- "url": "string",
- "description": "string",
- "details": "string",
- "alternateText": "string"
}, - "facebookProfilePicture": {
- "url": "string",
- "description": "string",
- "details": "string",
- "alternateText": "string"
}, - "uberLinkType": "LINK",
- "uberLinkText": "string",
- "uberTripBrandingText": "string",
- "uberTripBrandingUrl": "string",
- "uberTripBrandingDescription": "string",
- "yearEstablished": "stri",
- "displayLat": 0,
- "displayLng": 0,
- "routableLat": 0,
- "routableLng": 0,
- "walkableLat": 0,
- "walkableLng": 0,
- "pickupLat": 0,
- "pickupLng": 0,
- "dropoffLat": 0,
- "dropoffLng": 0,
- "emails": [
- "string"
], - "specialities": [
- "string"
], - "associations": [
- "string"
], - "products": [
- "string"
], - "services": [
- "string"
], - "brands": [
- "string"
], - "language": "string",
- "languages": [
- "string"
], - "keywords": [
- "string"
], - "menusLabel": "string",
- "menuIds": [
- "string"
], - "bioListsLabel": "string",
- "bioListIds": [
- "string"
], - "productListsLabel": "string",
- "productListIds": [
- "string"
], - "eventListsLabel": "string",
- "eventListIds": [
- "string"
], - "folderId": "string",
- "labelIds": [
- "string"
], - "customFields": {
- "property1": { },
- "property2": { }
}, - "intelligentSearchTrackingEnabled": true,
- "intelligentSearchTrackingFrequency": "WEEKLY",
- "locationKeywords": [
- "NAME"
], - "customKeywords": [
- "string"
], - "queryTemplates": [
- "KEYWORD"
], - "alternateNames": [
- "string"
], - "alternateWebsites": [
- "string"
], - "competitors": [
- {
- "name": "string",
- "website": "string"
}
], - "trackingSites": [
- "GOOGLE_DESKTOP"
], - "isClusterPrimary": true,
- "attire": "UNSPECIFIED",
- "priceRange": "UNSPECIFIED",
- "mealsServed": [
- "string"
], - "locatedIn": "string",
- "primaryContact": "string",
- "reviewResponseConversationEnabled": true,
- "holidayHoursConfirmationEnabled": true
}
Response samples
- 201
- default
{- "meta": {
- "uuid": "4f72b877-e2d0-4de4-9324-b9cf2c03e1a0"
}, - "response": {
- "id": "string"
}
}
Locations (Legacy): Search
Get multiple Locations (primary profiles only) that match provided filters.
path Parameters
accountId required | string |
query Parameters
v required | string A date in | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
limit | integer <= 50 Default: 10 Number of results to return. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
offset | integer <= 9950 Default: 0 Number of results to skip. Used to page through results. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
filters | string A set of filters that is applied to the set of locations that would otherwise be returned. Should be provided as a URL-encoded string containing a JSON array. The array should have one or more filter objects defined. All filter objects will apply as an intersection (i.e., AND). Field names reference Location fields, as well as custom fields using the format For example, to provide a filter that would match location names containing the word "gourmet", the filter parameter would be NOTE: "x", "xx", and "xxx" are reserved keywords that, when passed in a The filter types are the following. Note there may be multiple available specifications for a given filter type:
The following fields can be specified in the request (Field name/Filter Type/Example(s)):
|
Responses
Response samples
- 200
- default
{- "meta": {
- "uuid": "4f72b877-e2d0-4de4-9324-b9cf2c03e1a0"
}, - "response": {
- "count": 0,
- "locations": [
- {
- "id": "string",
- "uid": "string",
- "accountId": "string",
- "timestamp": 0,
- "timezone": "string",
- "locationType": "LOCATION",
- "locationName": "string",
- "firstName": "string",
- "middleName": "string",
- "lastName": "string",
- "officeName": "string",
- "gender": "FEMALE",
- "npi": "string",
- "address": "string",
- "address2": "string",
- "suppressAddress": true,
- "displayAddress": "string",
- "city": "string",
- "state": "string",
- "sublocality": "string",
- "zip": "string",
- "countryCode": "st",
- "serviceArea": {
- "radius": 0,
- "unit": "string",
- "places": [
- "string"
]
}, - "phone": "string",
- "isPhoneTracked": true,
- "localPhone": "string",
- "alternatePhone": "string",
- "faxPhone": "string",
- "mobilePhone": "string",
- "tollFreePhone": "string",
- "ttyPhone": "string",
- "categoryIds": [
- "string"
], - "featuredMessage": "string",
- "featuredMessageUrl": "string",
- "websiteUrl": "string",
- "displayWebsiteUrl": "string",
- "reservationUrl": "string",
- "displayReservationUrl": "string",
- "menuUrl": "string",
- "displayMenuUrl": "string",
- "orderUrl": "string",
- "displayOrderUrl": "string",
- "hours": "string",
- "additionalHoursText": "string",
- "holidayHours": [
- {
- "hours": "string",
- "date": "2019-08-24",
- "isRegularHours": false
}
], - "description": "stringstri",
- "conditionsTreated": [
- "string"
], - "certifications": [
- "string"
], - "educationList": [
- {
- "type": "FELLOWSHIP",
- "institutionName": "string",
- "yearCompleted": "string"
}
], - "degrees": [
- "string"
], - "admittingHospitals": [
- "string"
], - "acceptingNewPatients": true,
- "closed": {
- "isClosed": true
}, - "paymentOptions": [
- "string"
], - "insuranceAccepted": [
- "string"
], - "logo": {
- "url": "string",
- "sourceUrl": "string",
- "description": "string",
- "details": "string",
- "alternateText": "string",
- "width": 0,
- "height": 0,
- "derivatives": [
- {
- "url": "string",
- "width": 0,
- "height": 0
}
]
}, - "photos": [
- {
- "url": "string",
- "sourceUrl": "string",
- "description": "string",
- "details": "string",
- "alternateText": "string",
- "width": 0,
- "height": 0,
- "derivatives": [
- {
- "url": "string",
- "width": 0,
- "height": 0
}
]
}
], - "headshot": {
- "url": "string",
- "sourceUrl": "string",
- "description": "string",
- "details": "string",
- "alternateText": "string",
- "width": 0,
- "height": 0,
- "derivatives": [
- {
- "url": "string",
- "width": 0,
- "height": 0
}
]
}, - "videoUrls": [
- "string"
], - "instagramHandle": "string",
- "twitterHandle": "string",
- "googleWebsiteOverride": "string",
- "googleCoverPhoto": {
- "url": "string",
- "sourceUrl": "string",
- "description": "string",
- "details": "string",
- "alternateText": "string",
- "width": 0,
- "height": 0,
- "derivatives": [
- {
- "url": "string",
- "width": 0,
- "height": 0
}
]
}, - "googleProfilePhoto": {
- "url": "string",
- "sourceUrl": "string",
- "description": "string",
- "details": "string",
- "alternateText": "string",
- "width": 0,
- "height": 0,
- "derivatives": [
- {
- "url": "string",
- "width": 0,
- "height": 0
}
]
}, - "googleAttributes": [
- {
- "id": "string",
- "optionIds": [
- "string"
]
}
], - "facebookPageUrl": "string",
- "facebookCallToAction": {
- "type": "NONE",
- "value": "string"
}, - "facebookCoverPhoto": {
- "url": "string",
- "sourceUrl": "string",
- "description": "string",
- "details": "string",
- "alternateText": "string",
- "width": 0,
- "height": 0,
- "derivatives": [
- {
- "url": "string",
- "width": 0,
- "height": 0
}
]
}, - "facebookProfilePicture": {
- "url": "string",
- "sourceUrl": "string",
- "description": "string",
- "details": "string",
- "alternateText": "string",
- "width": 0,
- "height": 0,
- "derivatives": [
- {
- "url": "string",
- "width": 0,
- "height": 0
}
]
}, - "uberLinkType": "LINK",
- "uberLinkText": "string",
- "uberTripBrandingText": "string",
- "uberTripBrandingUrl": "string",
- "uberTripBrandingDescription": "string",
- "uberEmbedCode": "string",
- "uberLink": "string",
- "uberLinkRaw": "string",
- "yearEstablished": "stri",
- "displayLat": 0,
- "displayLng": 0,
- "routableLat": 0,
- "routableLng": 0,
- "walkableLat": 0,
- "walkableLng": 0,
- "pickupLat": 0,
- "pickupLng": 0,
- "dropoffLat": 0,
- "dropoffLng": 0,
- "yextDisplayLat": 0,
- "yextDisplayLng": 0,
- "yextRoutableLat": 0,
- "yextRoutableLng": 0,
- "yextWalkableLat": 0,
- "yextWalkableLng": 0,
- "yextPickupLat": 0,
- "yextPickupLng": 0,
- "yextDropoffLat": 0,
- "yextDropoffLng": 0,
- "emails": [
- "string"
], - "specialities": [
- "string"
], - "associations": [
- "string"
], - "products": [
- "string"
], - "services": [
- "string"
], - "brands": [
- "string"
], - "language": "string",
- "languages": [
- "string"
], - "keywords": [
- "string"
], - "menusLabel": "string",
- "menuIds": [
- "string"
], - "bioListsLabel": "string",
- "bioListIds": [
- "string"
], - "productListsLabel": "string",
- "productListIds": [
- "string"
], - "eventListsLabel": "string",
- "eventListIds": [
- "string"
], - "folderId": "string",
- "labelIds": [
- "string"
], - "customFields": {
- "property1": { },
- "property2": { }
}, - "intelligentSearchTrackingEnabled": true,
- "intelligentSearchTrackingFrequency": "WEEKLY",
- "locationKeywords": [
- "NAME"
], - "customKeywords": [
- "string"
], - "queryTemplates": [
- "KEYWORD"
], - "alternateNames": [
- "string"
], - "alternateWebsites": [
- "string"
], - "competitors": [
- {
- "name": "string",
- "website": "string"
}
], - "trackingSites": [
- "GOOGLE_DESKTOP"
], - "isoRegionCode": "string",
- "reviewBalancingURL": "string",
- "firstPartyReviewPage": "string",
- "isClusterPrimary": true,
- "schemaTypes": [
- "string"
], - "attire": "UNSPECIFIED",
- "priceRange": "UNSPECIFIED",
- "mealsServed": [
- "string"
], - "locatedIn": "string",
- "primaryContact": "string",
- "reviewResponseConversationEnabled": true,
- "holidayHoursConfirmationEnabled": true
}
]
}
}
Locations (Legacy): Get
Gets the primary profile for a single Location.
path Parameters
accountId required | string |
locationId required | string |
query Parameters
v required | string A date in |
resolvePlaceholders | boolean Default: false Optional parameter to resolve all embedded fields in a Location object response.
|
Responses
Response samples
- 200
- default
{- "meta": {
- "uuid": "4f72b877-e2d0-4de4-9324-b9cf2c03e1a0"
}, - "response": {
- "id": "string",
- "uid": "string",
- "accountId": "string",
- "timestamp": 0,
- "timezone": "string",
- "locationType": "LOCATION",
- "locationName": "string",
- "firstName": "string",
- "middleName": "string",
- "lastName": "string",
- "officeName": "string",
- "gender": "FEMALE",
- "npi": "string",
- "address": "string",
- "address2": "string",
- "suppressAddress": true,
- "displayAddress": "string",
- "city": "string",
- "state": "string",
- "sublocality": "string",
- "zip": "string",
- "countryCode": "st",
- "serviceArea": {
- "radius": 0,
- "unit": "string",
- "places": [
- "string"
]
}, - "phone": "string",
- "isPhoneTracked": true,
- "localPhone": "string",
- "alternatePhone": "string",
- "faxPhone": "string",
- "mobilePhone": "string",
- "tollFreePhone": "string",
- "ttyPhone": "string",
- "categoryIds": [
- "string"
], - "featuredMessage": "string",
- "featuredMessageUrl": "string",
- "websiteUrl": "string",
- "displayWebsiteUrl": "string",
- "reservationUrl": "string",
- "displayReservationUrl": "string",
- "menuUrl": "string",
- "displayMenuUrl": "string",
- "orderUrl": "string",
- "displayOrderUrl": "string",
- "hours": "string",
- "additionalHoursText": "string",
- "holidayHours": [
- {
- "hours": "string",
- "date": "2019-08-24",
- "isRegularHours": false
}
], - "description": "stringstri",
- "conditionsTreated": [
- "string"
], - "certifications": [
- "string"
], - "educationList": [
- {
- "type": "FELLOWSHIP",
- "institutionName": "string",
- "yearCompleted": "string"
}
], - "degrees": [
- "string"
], - "admittingHospitals": [
- "string"
], - "acceptingNewPatients": true,
- "closed": {
- "isClosed": true
}, - "paymentOptions": [
- "string"
], - "insuranceAccepted": [
- "string"
], - "logo": {
- "url": "string",
- "sourceUrl": "string",
- "description": "string",
- "details": "string",
- "alternateText": "string",
- "width": 0,
- "height": 0,
- "derivatives": [
- {
- "url": "string",
- "width": 0,
- "height": 0
}
]
}, - "photos": [
- {
- "url": "string",
- "sourceUrl": "string",
- "description": "string",
- "details": "string",
- "alternateText": "string",
- "width": 0,
- "height": 0,
- "derivatives": [
- {
- "url": "string",
- "width": 0,
- "height": 0
}
]
}
], - "headshot": {
- "url": "string",
- "sourceUrl": "string",
- "description": "string",
- "details": "string",
- "alternateText": "string",
- "width": 0,
- "height": 0,
- "derivatives": [
- {
- "url": "string",
- "width": 0,
- "height": 0
}
]
}, - "videoUrls": [
- "string"
], - "instagramHandle": "string",
- "twitterHandle": "string",
- "googleWebsiteOverride": "string",
- "googleCoverPhoto": {
- "url": "string",
- "sourceUrl": "string",
- "description": "string",
- "details": "string",
- "alternateText": "string",
- "width": 0,
- "height": 0,
- "derivatives": [
- {
- "url": "string",
- "width": 0,
- "height": 0
}
]
}, - "googleProfilePhoto": {
- "url": "string",
- "sourceUrl": "string",
- "description": "string",
- "details": "string",
- "alternateText": "string",
- "width": 0,
- "height": 0,
- "derivatives": [
- {
- "url": "string",
- "width": 0,
- "height": 0
}
]
}, - "googleAttributes": [
- {
- "id": "string",
- "optionIds": [
- "string"
]
}
], - "facebookPageUrl": "string",
- "facebookCallToAction": {
- "type": "NONE",
- "value": "string"
}, - "facebookCoverPhoto": {
- "url": "string",
- "sourceUrl": "string",
- "description": "string",
- "details": "string",
- "alternateText": "string",
- "width": 0,
- "height": 0,
- "derivatives": [
- {
- "url": "string",
- "width": 0,
- "height": 0
}
]
}, - "facebookProfilePicture": {
- "url": "string",
- "sourceUrl": "string",
- "description": "string",
- "details": "string",
- "alternateText": "string",
- "width": 0,
- "height": 0,
- "derivatives": [
- {
- "url": "string",
- "width": 0,
- "height": 0
}
]
}, - "uberLinkType": "LINK",
- "uberLinkText": "string",
- "uberTripBrandingText": "string",
- "uberTripBrandingUrl": "string",
- "uberTripBrandingDescription": "string",
- "uberEmbedCode": "string",
- "uberLink": "string",
- "uberLinkRaw": "string",
- "yearEstablished": "stri",
- "displayLat": 0,
- "displayLng": 0,
- "routableLat": 0,
- "routableLng": 0,
- "walkableLat": 0,
- "walkableLng": 0,
- "pickupLat": 0,
- "pickupLng": 0,
- "dropoffLat": 0,
- "dropoffLng": 0,
- "yextDisplayLat": 0,
- "yextDisplayLng": 0,
- "yextRoutableLat": 0,
- "yextRoutableLng": 0,
- "yextWalkableLat": 0,
- "yextWalkableLng": 0,
- "yextPickupLat": 0,
- "yextPickupLng": 0,
- "yextDropoffLat": 0,
- "yextDropoffLng": 0,
- "emails": [
- "string"
], - "specialities": [
- "string"
], - "associations": [
- "string"
], - "products": [
- "string"
], - "services": [
- "string"
], - "brands": [
- "string"
], - "language": "string",
- "languages": [
- "string"
], - "keywords": [
- "string"
], - "menusLabel": "string",
- "menuIds": [
- "string"
], - "bioListsLabel": "string",
- "bioListIds": [
- "string"
], - "productListsLabel": "string",
- "productListIds": [
- "string"
], - "eventListsLabel": "string",
- "eventListIds": [
- "string"
], - "folderId": "string",
- "labelIds": [
- "string"
], - "customFields": {
- "property1": { },
- "property2": { }
}, - "intelligentSearchTrackingEnabled": true,
- "intelligentSearchTrackingFrequency": "WEEKLY",
- "locationKeywords": [
- "NAME"
], - "customKeywords": [
- "string"
], - "queryTemplates": [
- "KEYWORD"
], - "alternateNames": [
- "string"
], - "alternateWebsites": [
- "string"
], - "competitors": [
- {
- "name": "string",
- "website": "string"
}
], - "trackingSites": [
- "GOOGLE_DESKTOP"
], - "isoRegionCode": "string",
- "reviewBalancingURL": "string",
- "firstPartyReviewPage": "string",
- "isClusterPrimary": true,
- "schemaTypes": [
- "string"
], - "attire": "UNSPECIFIED",
- "priceRange": "UNSPECIFIED",
- "mealsServed": [
- "string"
], - "locatedIn": "string",
- "primaryContact": "string",
- "reviewResponseConversationEnabled": true,
- "holidayHoursConfirmationEnabled": true
}
}
Locations (Legacy): Update
Updates the primary profile for a Location.
NOTE: Despite using the PUT method, Locations: Update only updates supplied fields. Omitted fields are not modified.
NOTE: The Location's primary profile language can be changed by calling this endpoint with a different, but unused, language code.
path Parameters
accountId required | string |
locationId required | string |
query Parameters
v required | string A date in |
Request Body schema: application/json
id | string <= 50 characters Primary key. Unique alphanumeric (Latin-1) ID assigned by the Customer. |
accountId | string <= 50 characters Must refer to an account.id that already exists. |
locationType | string Enum: "LOCATION" "HEALTHCARE_PROFESSIONAL" "HEALTHCARE_FACILITY" "RESTAURANT" "ATM" |
locationName | string <= 100 characters Cannot include:
Should be in appropriate letter case (e.g., not in all capital letters) |
firstName | string The first name of the healthcare professional NOTE: This field is only available to locations whose |
middleName | string The middle name of the healthcare professional NOTE: This field is only available to locations whose |
lastName | string The last name of the healthcare professional NOTE: This field is only available to locations whose |
officeName | string The name of the office where the healthcare professional works, if different from locationName NOTE: This field is only available to locations whose |
gender | string Enum: "FEMALE" "F" "MALE" "M" "UNSPECIFIED" The gender of the healthcare professional NOTE: This field is only available to locations whose |
npi | string The National Provider Identifier (NPI) of the healthcare provider NOTE: This field is only available to locations whose |
address | string <= 255 characters Must be a valid address Cannot be a P.O. Box |
address2 | string <= 255 characters Cannot be a P.O. Box |
suppressAddress | boolean If true, do not show street address on listings. Defaults to false. |
displayAddress | string <= 255 characters 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 |
city | string <= 80 characters |
state | string <= 80 characters 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 |
sublocality | string <= 255 characters The name of the location's sublocality. |
zip | string <= 10 characters 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 |
countryCode | string <= 2 characters The two-character ISO 3166-1 code of the location's country or region. If omitted, US is used. |
object 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. | |
phone | string Must be a valid phone number. |
isPhoneTracked | boolean 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. |
localPhone | string Must be a valid, non-toll-free phone number. Required if:
|
alternatePhone | string Must be a valid phone number, based on the country specified in |
faxPhone | string Must be a valid phone number, based on the country specified in |
mobilePhone | string Must be a valid phone number, based on the country specified in |
tollFreePhone | string Must be a valid phone number, based on the country specified in |
ttyPhone | string Must be a valid phone number, based on the country specified in |
categoryIds | Array of strings 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. |
featuredMessage | string <= 50 characters The Featured Message. Default: Call today! Cannot include:
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. |
featuredMessageUrl | string <= 255 characters Valid URL to which the Featured Message is linked |
websiteUrl | string <= 255 characters The URL of the location's website. This URL will be shown on your listings unless you specify a value for Must be a valid URL and is required whenever |
displayWebsiteUrl | string <= 255 characters The URL that is shown on your listings in place of Must be a valid URL and be specified along with |
reservationUrl | string <= 255 characters A valid URL used for reservations at this location. |
displayReservationUrl | string <= 255 characters The URL that is shown on your listings in place of Must be a valid URL and be specified along with |
menuUrl | string <= 255 characters The URL of the location's menu. |
displayMenuUrl | string <= 255 characters The URL that is shown on your listings in place of Must be a valid URL and be specified along with |
orderUrl | string <= 255 characters The URL used to place orders that will be fulfilled at the location. |
displayOrderUrl | string <= 255 characters The URL that is shown on your listings in place of Must be a valid URL and be specified along with |
hours | string <= 255 characters 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
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:
NOTE: To set hours for specific days of the year rather than days of the week, use holidayHours. |
additionalHoursText | string <= 255 characters Additional information about business hours that does not fit in hours (e.g., Closed during the winter) |
Array of objects Holiday hours for this location. NOTE: hours must be set in order for holidayHours to appear on your listings) | |
description | string [ 10 .. 5000 ] characters |
conditionsTreated | Array of strings A list of the conditions treated by the healthcare provider NOTE: This field is only available to locations whose |
certifications | Array of strings A list of the certifications held by the healthcare professional NOTE: This field is only available to locations whose |
Array of objects A list of the types of education and training completed by the healthcare professional NOTE: This field is only available to locations whose | |
degrees | Array of strings A list of the degrees earned by the healthcare professional NOTE: This field is only available to locations whose Valid values:
|
admittingHospitals | Array of strings A list of hospitals where the healthcare professional admits patients NOTE: This field is only available to locations whose |
acceptingNewPatients | boolean Indicates whether the healthcare provider is accepting new patients Default is true NOTE: This field is only available to locations whose |
object 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. | |
paymentOptions | Array of strings The payment methods accepted at this location Valid elements depend on the location's country. For US locations, valid elements are:
|
insuranceAccepted | Array of strings A list of insurance policies accepted by the healthcare provider NOTE: This field is only available to locations whose |
object | |
Array of objects 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. | |
object A portrait of the healthcare professional NOTE: This field is only available to locations whose | |
videoUrls | Array of strings[ items <= 255 characters ] Valid YouTube URLs for embedding a video on some publisher sites. NOTE: Currently, only the first URL in the Array appears in your listings. |
instagramHandle | string Valid Instagram username for the location (e.g., NewCityFiat (without the leading "@")) |
twitterHandle | string <= 15 characters 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. |
googleWebsiteOverride | string <= 255 characters 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. |
object The cover photo for your business's Google profile NOTE: Your cover photo must meet all of the following requirements:
| |
object The profile photo for your business's Google profile NOTE: Your profile picture must meet all of the following requirements:
| |
Array of objects The Google Business Profile attributes for this location. | |
facebookPageUrl | string <= 255 characters URL for the location's Facebook Page. Valid formats:
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:
|
object Designates the Facebook Call-to-Action button text and value | |
object 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. | |
object 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. | |
uberLinkType | string Enum: "LINK" "BUTTON" 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. |
uberLinkText | string <= 100 characters The text of the embedded Uber link Default is "Ride there with Uber". NOTE: This field is only available if uberLinkType is LINK. |
uberTripBrandingText | string <= 28 characters 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. |
uberTripBrandingUrl | string 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. |
uberTripBrandingDescription | string <= 150 characters 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. |
yearEstablished | string <= 4 characters The year that this location was opened, not the number of years it was open Minimum of 1000, maximum of current year + 10. |
displayLat | number <double> Latitude where the map pin should be displayed, as provided by you Between -90.0 and 90.0, inclusive |
displayLng | number <double> Longitude where the map pin should be displayed, as provided by you Between -180.0 and 180.0, inclusive |
routableLat | number <double> Latitude to use for driving directions to the location, as provided by you Between -90.0 and 90.0, inclusive |
routableLng | number <double> Longitude to use for driving directions to the location, as provided by you Between -180.0 and 180.0, inclusive |
walkableLat | number <double> Latitude to use for walking directions to the location, as provided by you Between -90.0 and 90.0, inclusive |
walkableLng | number <double> Longitude to use for walking directions to the location, as provided by you Between -180.0 and 180.0, inclusive |
pickupLat | number <double> Latitude to use for pickup spot for the location, as provided by you Between -90.0 and 90.0, inclusive |
pickupLng | number <double> Longitude to use for pickup spot for the location, as provided by you Between -180.0 and 180.0, inclusive |
dropoffLat | number <double> Latitude to use for drop off spot for the location, as provided by you Between -90.0 and 90.0, inclusive |
dropoffLng | number <double> Longitude to use for drop off spot for the location, as provided by you Between -180.0 and 180.0, inclusive |
emails | Array of strings[ items <= 255 characters ] Up to five emails addresses for reaching this location Must be valid email addresses |
specialities | Array of strings[ items <= 100 characters ] Up to 100 specialities (e.g., for food and dining: Chicago style) All strings must be non-empty when trimmed of whitespace. |
associations | Array of strings[ items <= 100 characters ] 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. |
products | Array of strings[ items <= 100 characters ] Up to 100 products sold at this location All strings must be non-empty when trimmed of whitespace. |
services | Array of strings[ items <= 100 characters ] Up to 100 services offered at this location All strings must be non-empty when trimmed of whitespace. |
brands | Array of strings[ items <= 100 characters ] Up to 100 brands sold by this location All strings must be non-empty when trimmed of whitespace. |
language | string <= 10 characters 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. |
languages | Array of strings[ items <= 100 characters ] Up to 100 languages spoken at this location. All strings must be non-empty when trimmed of whitespace. |
keywords | Array of strings[ items <= 100 characters ] Up to 100 keywords may be provided All strings must be non-empty when trimmed of whitespace. |
menusLabel | string Label to be used for this location’s Menus. This label will appear on your location's listings. |
menuIds | Array of strings IDs of Menus associated with this location. |
bioListsLabel | string Label to be used for this location’s Bio lists. This label will appear on your location's listings. |
bioListIds | Array of strings IDs of Bio lists associated with this location. |
productListsLabel | string Label to be used for this location’s Product & Services lists. This label will appear on your location's listings. |
productListIds | Array of strings IDs of Product lists associated with this location. |
eventListsLabel | string Label to be used for this location’s Event lists. This label will appear on your location's listings. |
eventListIds | Array of strings IDs of Event lists associated with this location. |
folderId | string The folder that this location is in. Must be a valid, existing Yext Folder ID |
labelIds | Array of strings 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:
|
object A set of key-value pairs indicating the location's custom fields and their values. The keys are the To retrieve a list of custom fields for your account, use the Custom Fields: List endpoint. If a field's Examples of each type of custom field:
| |
intelligentSearchTrackingEnabled | boolean Indicates whether Intelligent Search Tracker is enabled. The Intelligent Search Tracker allows you to understand your performance in local search. |
intelligentSearchTrackingFrequency | string Enum: "WEEKLY" "MONTHLY" "QUARTERLY" How often we send search queries to track your search performance. |
locationKeywords | Array of strings Items Enum: "NAME" "PRIMARY_CATEGORY" Keywords that we will use to track your search performance. These keywords are based on the location information you've stored in our system. |
customKeywords | Array of strings Additional keywords you would like us to use when tracking your search performance |
queryTemplates | Array of strings Items Enum: "KEYWORD" "KEYWORD_ZIP" "KEYWORD_CITY" "KEYWORD_IN_CITY" "KEYWORD_NEAR_ME" "KEYWORD_CITY_STATE" The ways in which your keywords will be arranged in the search queries we use to track your performance |
alternateNames | Array of strings Other names for your business that you would like us to use when tracking your search performance |
alternateWebsites | Array of strings Other websites for your business that we should look for when tracking your search performance |
Array of objects The names and websites of the competitors whose search performance you would like to compare to your own | |
trackingSites | Array of strings Items Enum: "GOOGLE_DESKTOP" "GOOGLE_MOBILE" "BING_DESKTOP" "BING_MOBILE" "YAHOO_DESKTOP" "YAHOO_MOBILE" The search engines that we will use to track your performance |
isClusterPrimary | boolean Indicates whether the location is the primary location in its group |
attire | string Enum: "UNSPECIFIED" "DRESSY" "CASUAL" "FORMAL" The formality of clothing typically worn at this location NOTE: This field is only available to locations whose |
priceRange | string Enum: "UNSPECIFIED" "ONE" "TWO" "THREE" "FOUR" 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 |
mealsServed | Array of strings Types of meals served at this location NOTE: This field is only available to locations whose Valid values:
|
locatedIn | string 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 |
primaryContact | string ID of the user who is the primary Knowledge Assistant contact for the entity |
reviewResponseConversationEnabled | boolean Indicates whether or not review response conversations are enabled for the Yext Knowledge Assistant |
holidayHoursConfirmationEnabled | boolean Indicates whether or not holiday hour confirmation alerts are enabled for the Yext Knowledge Assistant |
Responses
Request samples
- Payload
{- "id": "string",
- "accountId": "string",
- "locationType": "LOCATION",
- "locationName": "string",
- "firstName": "string",
- "middleName": "string",
- "lastName": "string",
- "officeName": "string",
- "gender": "FEMALE",
- "npi": "string",
- "address": "string",
- "address2": "string",
- "suppressAddress": true,
- "displayAddress": "string",
- "city": "string",
- "state": "string",
- "sublocality": "string",
- "zip": "string",
- "countryCode": "st",
- "serviceArea": {
- "radius": 0,
- "unit": "string",
- "places": [
- "string"
]
}, - "phone": "string",
- "isPhoneTracked": true,
- "localPhone": "string",
- "alternatePhone": "string",
- "faxPhone": "string",
- "mobilePhone": "string",
- "tollFreePhone": "string",
- "ttyPhone": "string",
- "categoryIds": [
- "string"
], - "featuredMessage": "string",
- "featuredMessageUrl": "string",
- "websiteUrl": "string",
- "displayWebsiteUrl": "string",
- "reservationUrl": "string",
- "displayReservationUrl": "string",
- "menuUrl": "string",
- "displayMenuUrl": "string",
- "orderUrl": "string",
- "displayOrderUrl": "string",
- "hours": "string",
- "additionalHoursText": "string",
- "holidayHours": [
- {
- "hours": "string",
- "date": "2019-08-24",
- "isRegularHours": false
}
], - "description": "stringstri",
- "conditionsTreated": [
- "string"
], - "certifications": [
- "string"
], - "educationList": [
- {
- "type": "FELLOWSHIP",
- "institutionName": "string",
- "yearCompleted": "string"
}
], - "degrees": [
- "string"
], - "admittingHospitals": [
- "string"
], - "acceptingNewPatients": true,
- "closed": {
- "isClosed": true
}, - "paymentOptions": [
- "string"
], - "insuranceAccepted": [
- "string"
], - "logo": {
- "url": "string",
- "description": "string",
- "details": "string",
- "alternateText": "string"
}, - "photos": [
- {
- "url": "string",
- "description": "string",
- "details": "string",
- "alternateText": "string"
}
], - "headshot": {
- "url": "string",
- "description": "string",
- "details": "string",
- "alternateText": "string"
}, - "videoUrls": [
- "string"
], - "instagramHandle": "string",
- "twitterHandle": "string",
- "googleWebsiteOverride": "string",
- "googleCoverPhoto": {
- "url": "string",
- "description": "string",
- "details": "string",
- "alternateText": "string"
}, - "googleProfilePhoto": {
- "url": "string",
- "description": "string",
- "details": "string",
- "alternateText": "string"
}, - "googleAttributes": [
- {
- "id": "string",
- "optionIds": [
- "string"
]
}
], - "facebookPageUrl": "string",
- "facebookCallToAction": {
- "type": "NONE",
- "value": "string"
}, - "facebookCoverPhoto": {
- "url": "string",
- "description": "string",
- "details": "string",
- "alternateText": "string"
}, - "facebookProfilePicture": {
- "url": "string",
- "description": "string",
- "details": "string",
- "alternateText": "string"
}, - "uberLinkType": "LINK",
- "uberLinkText": "string",
- "uberTripBrandingText": "string",
- "uberTripBrandingUrl": "string",
- "uberTripBrandingDescription": "string",
- "yearEstablished": "stri",
- "displayLat": 0,
- "displayLng": 0,
- "routableLat": 0,
- "routableLng": 0,
- "walkableLat": 0,
- "walkableLng": 0,
- "pickupLat": 0,
- "pickupLng": 0,
- "dropoffLat": 0,
- "dropoffLng": 0,
- "emails": [
- "string"
], - "specialities": [
- "string"
], - "associations": [
- "string"
], - "products": [
- "string"
], - "services": [
- "string"
], - "brands": [
- "string"
], - "language": "string",
- "languages": [
- "string"
], - "keywords": [
- "string"
], - "menusLabel": "string",
- "menuIds": [
- "string"
], - "bioListsLabel": "string",
- "bioListIds": [
- "string"
], - "productListsLabel": "string",
- "productListIds": [
- "string"
], - "eventListsLabel": "string",
- "eventListIds": [
- "string"
], - "folderId": "string",
- "labelIds": [
- "string"
], - "customFields": {
- "property1": { },
- "property2": { }
}, - "intelligentSearchTrackingEnabled": true,
- "intelligentSearchTrackingFrequency": "WEEKLY",
- "locationKeywords": [
- "NAME"
], - "customKeywords": [
- "string"
], - "queryTemplates": [
- "KEYWORD"
], - "alternateNames": [
- "string"
], - "alternateWebsites": [
- "string"
], - "competitors": [
- {
- "name": "string",
- "website": "string"
}
], - "trackingSites": [
- "GOOGLE_DESKTOP"
], - "isClusterPrimary": true,
- "attire": "UNSPECIFIED",
- "priceRange": "UNSPECIFIED",
- "mealsServed": [
- "string"
], - "locatedIn": "string",
- "primaryContact": "string",
- "reviewResponseConversationEnabled": true,
- "holidayHoursConfirmationEnabled": true
}
Response samples
- 200
- default
{- "meta": {
- "uuid": "4f72b877-e2d0-4de4-9324-b9cf2c03e1a0"
}, - "response": {
- "id": "string"
}
}
Custom Fields: List
Returns a list of Custom Fields in an Account.
NOTE: Custom Fields of unsupported types will be filtered out.
The Custom Fields API will be deprecated in Spring '24. See here for more details.
path Parameters
accountId required | string |
query Parameters
v required | string A date in |
offset | integer Default: 0 Number of results to skip. Used to page through results.
Cannot be used together with |
limit | integer <= 1000 Default: 100 Number of results to return. |
pageToken | string If a response to a previous request contained the |
Responses
Response samples
- 200
- default
{- "meta": {
- "uuid": "4f72b877-e2d0-4de4-9324-b9cf2c03e1a0"
}, - "response": {
- "count": 0,
- "customFields": [
- {
- "name": {
- "value": "string",
- "translations": [
- {
- "languageCode": "string",
- "value": "string"
}
]
}, - "options": [
- {
- "key": "string",
- "value": "string",
- "translations": [
- {
- "languageCode": "string",
- "value": "string"
}
]
}
], - "group": "NONE",
- "description": {
- "value": "string",
- "translations": [
- {
- "languageCode": "string",
- "value": "string"
}
]
}, - "alternateLanguageBehavior": "PRIMARY_ONLY",
- "validation": {
- "minCharLength": 0,
- "maxCharLength": 0,
- "minItemCount": 0,
- "maxItemCount": 0,
- "minValue": 0,
- "maxValue": 0,
- "minDate": "string",
- "maxDate": "string",
- "aspectRatio": "UNCONSTRAINED",
- "minWidth": 0,
- "minHeight": 0,
- "entityTypes": [
- "location"
], - "richTextFormats": [
- "bold"
], - "entityRelationship": {
- "type": "ONE_WAY",
- "relatedFieldId": "string",
- "supportedDestinationEntityTypes": [ ]
}
}, - "entityAvailability": [
- "location"
], - "id": "string",
- "type": "BOOLEAN"
}
], - "pageToken": "string"
}
}
Custom Fields: Create
Creates new Custom Field(s) in an Account.
NOTE: If the v
parameter is on or after 20220615
, the request body must be an array, as to allow multiple field creates per request.
The Custom Fields API will be deprecated in Spring '24. See here for more details.
path Parameters
accountId required | string |
query Parameters
v required | string A date in |
Request Body schema: application/json
required | object The Custom Field's name (including default value and translations). After March 19th 2020, if users Update Custom Field's name using older versions of the API without explicitly specifiying translations, any existing translations will be cleared. Example: "name": { "value": "The promotions", "translations": [ { "languageCode": "fr", "value": "Les promotions" } ] } |
Array of objects Present if and only if List of options (key, value, and translations) for the Custom Field. Example: { { "key": "TEMPORARILY_CLOSED", "value": "Temporarily Closed" }, { "key": "COMING_SOON", "value": "Coming Soon" }, { "key": "CLOSED", "value": "Closed" "translations": [ { "languageCode": "fr", "value": "Fermé" } ] }, { "key": "OPEN", "value": "Open" } } The behavior of the options' keys depends on which Custom Fields endpoint you are using:
| |
group | string Default: "NONE" Enum: "NONE" "GROUP_1" "GROUP_2" "GROUP_3" "GROUP_4" "GROUP_5" "GROUP_6" "GROUP_7" "GROUP_8" "GROUP_9" "GROUP_10" "GROUP_11" "GROUP_12" "GROUP_13" "GROUP_14" "GROUP_15" "GROUP_16" "GROUP_17" "GROUP_18" "GROUP_19" "GROUP_20" "GROUP_21" "GROUP_22" "GROUP_23" "GROUP_24" "GROUP_25" "GROUP_26" "GROUP_27" "GROUP_28" "GROUP_29" "GROUP_30" The Custom Field's group. |
object The Custom Field's description (including value and translations) which, if provided, will be shown as a tooltip next to the Custom Field in the Knowledge Manager. Providing a description is highly recommended when creating apps for the App Directory. After March 19th 2020, if users Update Custom Field's description using older versions of the API without explicitly specifiying translations, any existing translations will be cleared. Example: "description": { "value": "This is the list of promotions", "translations": [ { "languageCode": "fr", "value": "Ceci est la liste des promotions" } ] } | |
alternateLanguageBehavior | string Default: "PRIMARY_ONLY" Custom Field multi-language profile behavior, which is one of:
|
object A Custom Field validation object, describing validation rules when a Custom Field value is set or updated. | |
entityAvailability | Array of strings Items Enum: "location" "event" "healthcareProfessional" "healthcareFacility" "atm" "restaurant" A list of entity types that the Custom Field is available to. |
id | string ID that should be used when referencing the field in API calls. This ID will also serve as the Custom Field's key in our upcoming Entities API endpoints.
Note that in Locations endpoints, Custom Fields are still referenced by their numeric |
type required | string Enum: "BOOLEAN" "CTA" "DAILY_TIMES" "DATE" "GALLERY" "HOURS" "ENTITY_RELATIONSHIP" "MARKDOWN" "MULTILINE_TEXT" "MULTI_OPTION" "NUMBER" "PHOTO" "RICH_TEXT" "RICH_TEXT_V2" "SINGLE_OPTION" "TEXT" "TEXT_LIST" "URL" "VIDEO" "VIDEO_GALLERY" The data type of the Custom Field's contents. Only the types listed here are supported.
Note that the |
Responses
Request samples
- Payload
[- {
- "name": {
- "value": "string",
- "translations": [
- {
- "languageCode": "string",
- "value": "string"
}
]
}, - "options": [
- {
- "key": "string",
- "value": "string",
- "translations": [
- {
- "languageCode": "string",
- "value": "string"
}
]
}
], - "group": "NONE",
- "description": {
- "value": "string",
- "translations": [
- {
- "languageCode": "string",
- "value": "string"
}
]
}, - "alternateLanguageBehavior": "PRIMARY_ONLY",
- "validation": {
- "minCharLength": 0,
- "maxCharLength": 0,
- "minItemCount": 0,
- "maxItemCount": 0,
- "minValue": 0,
- "maxValue": 0,
- "minDate": "string",
- "maxDate": "string",
- "aspectRatio": "UNCONSTRAINED",
- "minWidth": 0,
- "minHeight": 0,
- "entityTypes": [
- "location"
], - "richTextFormats": [
- "bold"
], - "entityRelationship": {
- "type": "ONE_WAY",
- "relatedFieldId": "string",
- "supportedDestinationEntityTypes": [ ]
}
}, - "entityAvailability": [
- "location"
], - "id": "string",
- "type": "BOOLEAN"
}
]
Response samples
- 201
- default
{- "meta": {
- "uuid": "4f72b877-e2d0-4de4-9324-b9cf2c03e1a0"
}, - "response": [
- {
- "id": "string"
}
]
}
Custom Fields: Get
Gets a specific Custom Field in an Account.
The Custom Fields API will be deprecated in Spring '24. See here for more details.
path Parameters
accountId required | string |
customFieldId required | string ID that should be used when referencing the field in API calls. This ID will also serve as the Custom Field's key in our upcoming Entities API endpoints.
Note that the Custom Fields can still be accessed using their numeric |
query Parameters
v required | string A date in |
Responses
Response samples
- 200
- default
{- "meta": {
- "uuid": "4f72b877-e2d0-4de4-9324-b9cf2c03e1a0"
}, - "response": {
- "name": {
- "value": "string",
- "translations": [
- {
- "languageCode": "string",
- "value": "string"
}
]
}, - "options": [
- {
- "key": "string",
- "value": "string",
- "translations": [
- {
- "languageCode": "string",
- "value": "string"
}
]
}
], - "group": "NONE",
- "description": {
- "value": "string",
- "translations": [
- {
- "languageCode": "string",
- "value": "string"
}
]
}, - "alternateLanguageBehavior": "PRIMARY_ONLY",
- "validation": {
- "minCharLength": 0,
- "maxCharLength": 0,
- "minItemCount": 0,
- "maxItemCount": 0,
- "minValue": 0,
- "maxValue": 0,
- "minDate": "string",
- "maxDate": "string",
- "aspectRatio": "UNCONSTRAINED",
- "minWidth": 0,
- "minHeight": 0,
- "entityTypes": [
- "location"
], - "richTextFormats": [
- "bold"
], - "entityRelationship": {
- "type": "ONE_WAY",
- "relatedFieldId": "string",
- "supportedDestinationEntityTypes": [ ]
}
}, - "entityAvailability": [
- "location"
], - "id": "string",
- "type": "BOOLEAN"
}
}
Custom Fields: Update
Updates a single Custom Field in an Account.
Note that the only updatable values in an existing Custom Field are its name, group, description, alternate language behavior, as well as available options if its type
is SINGLE_OPTION
or MULTI_OPTION
.
- If options are modified, every location with that option selected will have the new value.
- If options are deleted, all locations with that option will no longer have that option selected.
- If the deleted options are the only options selected for a location, the location will no longer have a value set for that Custom Field.
The Custom Fields API will be deprecated in Spring '24. See here for more details.
path Parameters
accountId required | string |
customFieldId required | string ID that should be used when referencing the field in API calls. This ID will also serve as the Custom Field's key in our upcoming Entities API endpoints.
Note that the Custom Fields can still be accessed using their numeric |
query Parameters
v required | string A date in |
Request Body schema: application/json
required | object The Custom Field's name (including default value and translations). After March 19th 2020, if users Update Custom Field's name using older versions of the API without explicitly specifiying translations, any existing translations will be cleared. Example: "name": { "value": "The promotions", "translations": [ { "languageCode": "fr", "value": "Les promotions" } ] } |
Array of objects Present if and only if List of options (key, value, and translations) for the Custom Field. Example: { { "key": "TEMPORARILY_CLOSED", "value": "Temporarily Closed" }, { "key": "COMING_SOON", "value": "Coming Soon" }, { "key": "CLOSED", "value": "Closed" "translations": [ { "languageCode": "fr", "value": "Fermé" } ] }, { "key": "OPEN", "value": "Open" } } The behavior of the options' keys depends on which Custom Fields endpoint you are using:
| |
group | string Default: "NONE" Enum: "NONE" "GROUP_1" "GROUP_2" "GROUP_3" "GROUP_4" "GROUP_5" "GROUP_6" "GROUP_7" "GROUP_8" "GROUP_9" "GROUP_10" "GROUP_11" "GROUP_12" "GROUP_13" "GROUP_14" "GROUP_15" "GROUP_16" "GROUP_17" "GROUP_18" "GROUP_19" "GROUP_20" "GROUP_21" "GROUP_22" "GROUP_23" "GROUP_24" "GROUP_25" "GROUP_26" "GROUP_27" "GROUP_28" "GROUP_29" "GROUP_30" The Custom Field's group. |
object The Custom Field's description (including value and translations) which, if provided, will be shown as a tooltip next to the Custom Field in the Knowledge Manager. Providing a description is highly recommended when creating apps for the App Directory. After March 19th 2020, if users Update Custom Field's description using older versions of the API without explicitly specifiying translations, any existing translations will be cleared. Example: "description": { "value": "This is the list of promotions", "translations": [ { "languageCode": "fr", "value": "Ceci est la liste des promotions" } ] } | |
alternateLanguageBehavior | string Default: "PRIMARY_ONLY" Custom Field multi-language profile behavior, which is one of:
|
object A Custom Field validation object, describing validation rules when a Custom Field value is set or updated. | |
entityAvailability | Array of strings Items Enum: "location" "event" "healthcareProfessional" "healthcareFacility" "atm" "restaurant" A list of entity types that the Custom Field is available to. |
Responses
Request samples
- Payload
{- "name": {
- "value": "string",
- "translations": [
- {
- "languageCode": "string",
- "value": "string"
}
]
}, - "options": [
- {
- "key": "string",
- "value": "string",
- "translations": [
- {
- "languageCode": "string",
- "value": "string"
}
]
}
], - "group": "NONE",
- "description": {
- "value": "string",
- "translations": [
- {
- "languageCode": "string",
- "value": "string"
}
]
}, - "alternateLanguageBehavior": "PRIMARY_ONLY",
- "validation": {
- "minCharLength": 0,
- "maxCharLength": 0,
- "minItemCount": 0,
- "maxItemCount": 0,
- "minValue": 0,
- "maxValue": 0,
- "minDate": "string",
- "maxDate": "string",
- "aspectRatio": "UNCONSTRAINED",
- "minWidth": 0,
- "minHeight": 0,
- "entityTypes": [
- "location"
], - "richTextFormats": [
- "bold"
], - "entityRelationship": {
- "type": "ONE_WAY",
- "relatedFieldId": "string",
- "supportedDestinationEntityTypes": [ ]
}
}, - "entityAvailability": [
- "location"
]
}
Response samples
- 200
- default
{- "meta": {
- "uuid": "4f72b877-e2d0-4de4-9324-b9cf2c03e1a0"
}, - "response": {
- "id": "string"
}
}
Custom Fields: Delete
Deletes a Custom Field in an Account.
The Custom Field will be removed from all locations, and all content entered in the Custom Field will be deleted permanently.
The Custom Fields API will be deprecated in Spring '24. See here for more details.
path Parameters
accountId required | string |
customFieldId required | string ID that should be used when referencing the field in API calls. This ID will also serve as the Custom Field's key in our upcoming Entities API endpoints.
Note that the Custom Fields can still be accessed using their numeric |
query Parameters
v required | string A date in |
Responses
Response samples
- 200
- default
{- "meta": {
- "uuid": "4f72b877-e2d0-4de4-9324-b9cf2c03e1a0"
}, - "response": { }
}
Language Profiles (Legacy): List
Get Language Profiles for a Location.
path Parameters
accountId required | string |
locationId required | string |
query Parameters
v required | string A date in |
resolvePlaceholders | boolean Default: false Optional parameter to resolve all embedded fields in a Location object response.
|
Responses
Response samples
- 200
- default
{- "meta": {
- "uuid": "4f72b877-e2d0-4de4-9324-b9cf2c03e1a0"
}, - "response": {
- "languageProfiles": [
- {
- "id": "string",
- "uid": "string",
- "accountId": "string",
- "timestamp": 0,
- "timezone": "string",
- "locationType": "LOCATION",
- "locationName": "string",
- "firstName": "string",
- "middleName": "string",
- "lastName": "string",
- "officeName": "string",
- "gender": "FEMALE",
- "npi": "string",
- "address": "string",
- "address2": "string",
- "suppressAddress": true,
- "displayAddress": "string",
- "city": "string",
- "state": "string",
- "sublocality": "string",
- "zip": "string",
- "countryCode": "st",
- "serviceArea": {
- "radius": 0,
- "unit": "string",
- "places": [
- "string"
]
}, - "phone": "string",
- "isPhoneTracked": true,
- "localPhone": "string",
- "alternatePhone": "string",
- "faxPhone": "string",
- "mobilePhone": "string",
- "tollFreePhone": "string",
- "ttyPhone": "string",
- "categoryIds": [
- "string"
], - "featuredMessage": "string",
- "featuredMessageUrl": "string",
- "websiteUrl": "string",
- "displayWebsiteUrl": "string",
- "reservationUrl": "string",
- "displayReservationUrl": "string",
- "menuUrl": "string",
- "displayMenuUrl": "string",
- "orderUrl": "string",
- "displayOrderUrl": "string",
- "hours": "string",
- "additionalHoursText": "string",
- "holidayHours": [
- {
- "hours": "string",
- "date": "2019-08-24",
- "isRegularHours": false
}
], - "description": "stringstri",
- "conditionsTreated": [
- "string"
], - "certifications": [
- "string"
], - "educationList": [
- {
- "type": "FELLOWSHIP",
- "institutionName": "string",
- "yearCompleted": "string"
}
], - "degrees": [
- "string"
], - "admittingHospitals": [
- "string"
], - "acceptingNewPatients": true,
- "closed": {
- "isClosed": true
}, - "paymentOptions": [
- "string"
], - "insuranceAccepted": [
- "string"
], - "logo": {
- "url": "string",
- "sourceUrl": "string",
- "description": "string",
- "details": "string",
- "alternateText": "string",
- "width": 0,
- "height": 0,
- "derivatives": [
- {
- "url": "string",
- "width": 0,
- "height": 0
}
]
}, - "photos": [
- {
- "url": "string",
- "sourceUrl": "string",
- "description": "string",
- "details": "string",
- "alternateText": "string",
- "width": 0,
- "height": 0,
- "derivatives": [
- {
- "url": "string",
- "width": 0,
- "height": 0
}
]
}
], - "headshot": {
- "url": "string",
- "sourceUrl": "string",
- "description": "string",
- "details": "string",
- "alternateText": "string",
- "width": 0,
- "height": 0,
- "derivatives": [
- {
- "url": "string",
- "width": 0,
- "height": 0
}
]
}, - "videoUrls": [
- "string"
], - "instagramHandle": "string",
- "twitterHandle": "string",
- "googleWebsiteOverride": "string",
- "googleCoverPhoto": {
- "url": "string",
- "sourceUrl": "string",
- "description": "string",
- "details": "string",
- "alternateText": "string",
- "width": 0,
- "height": 0,
- "derivatives": [
- {
- "url": "string",
- "width": 0,
- "height": 0
}
]
}, - "googleProfilePhoto": {
- "url": "string",
- "sourceUrl": "string",
- "description": "string",
- "details": "string",
- "alternateText": "string",
- "width": 0,
- "height": 0,
- "derivatives": [
- {
- "url": "string",
- "width": 0,
- "height": 0
}
]
}, - "googleAttributes": [
- {
- "id": "string",
- "optionIds": [
- "string"
]
}
], - "facebookPageUrl": "string",
- "facebookCallToAction": {
- "type": "NONE",
- "value": "string"
}, - "facebookCoverPhoto": {
- "url": "string",
- "sourceUrl": "string",
- "description": "string",
- "details": "string",
- "alternateText": "string",
- "width": 0,
- "height": 0,
- "derivatives": [
- {
- "url": "string",
- "width": 0,
- "height": 0
}
]
}, - "facebookProfilePicture": {
- "url": "string",
- "sourceUrl": "string",
- "description": "string",
- "details": "string",
- "alternateText": "string",
- "width": 0,
- "height": 0,
- "derivatives": [
- {
- "url": "string",
- "width": 0,
- "height": 0
}
]
}, - "uberLinkType": "LINK",
- "uberLinkText": "string",
- "uberTripBrandingText": "string",
- "uberTripBrandingUrl": "string",
- "uberTripBrandingDescription": "string",
- "uberEmbedCode": "string",
- "uberLink": "string",
- "uberLinkRaw": "string",
- "yearEstablished": "stri",
- "displayLat": 0,
- "displayLng": 0,
- "routableLat": 0,
- "routableLng": 0,
- "walkableLat": 0,
- "walkableLng": 0,
- "pickupLat": 0,
- "pickupLng": 0,
- "dropoffLat": 0,
- "dropoffLng": 0,
- "yextDisplayLat": 0,
- "yextDisplayLng": 0,
- "yextRoutableLat": 0,
- "yextRoutableLng": 0,
- "yextWalkableLat": 0,
- "yextWalkableLng": 0,
- "yextPickupLat": 0,
- "yextPickupLng": 0,
- "yextDropoffLat": 0,
- "yextDropoffLng": 0,
- "emails": [
- "string"
], - "specialities": [
- "string"
], - "associations": [
- "string"
], - "products": [
- "string"
], - "services": [
- "string"
], - "brands": [
- "string"
], - "language": "string",
- "languages": [
- "string"
], - "keywords": [
- "string"
], - "menusLabel": "string",
- "menuIds": [
- "string"
], - "bioListsLabel": "string",
- "bioListIds": [
- "string"
], - "productListsLabel": "string",
- "productListIds": [
- "string"
], - "eventListsLabel": "string",
- "eventListIds": [
- "string"
], - "folderId": "string",
- "labelIds": [
- "string"
], - "customFields": {
- "property1": { },
- "property2": { }
}, - "intelligentSearchTrackingEnabled": true,
- "intelligentSearchTrackingFrequency": "WEEKLY",
- "locationKeywords": [
- "NAME"
], - "customKeywords": [
- "string"
], - "queryTemplates": [
- "KEYWORD"
], - "alternateNames": [
- "string"
], - "alternateWebsites": [
- "string"
], - "competitors": [
- {
- "name": "string",
- "website": "string"
}
], - "trackingSites": [
- "GOOGLE_DESKTOP"
], - "isoRegionCode": "string",
- "reviewBalancingURL": "string",
- "firstPartyReviewPage": "string",
- "isClusterPrimary": true,
- "schemaTypes": [
- "string"
], - "attire": "UNSPECIFIED",
- "priceRange": "UNSPECIFIED",
- "mealsServed": [
- "string"
], - "locatedIn": "string",
- "primaryContact": "string",
- "reviewResponseConversationEnabled": true,
- "holidayHoursConfirmationEnabled": true
}
]
}
}
Language Profiles (Legacy): Get
Gets the the requested Language Profile for a given Location.
path Parameters
accountId required | string |
locationId required | string |
language_code required | string Locale code. |
query Parameters
v required | string A date in |
resolvePlaceholders | boolean Default: false Optional parameter to resolve all embedded fields in a Location object response.
|
Responses
Response samples
- 200
- default
{- "meta": {
- "uuid": "4f72b877-e2d0-4de4-9324-b9cf2c03e1a0"
}, - "response": {
- "id": "string",
- "uid": "string",
- "accountId": "string",
- "timestamp": 0,
- "timezone": "string",
- "locationType": "LOCATION",
- "locationName": "string",
- "firstName": "string",
- "middleName": "string",
- "lastName": "string",
- "officeName": "string",
- "gender": "FEMALE",
- "npi": "string",
- "address": "string",
- "address2": "string",
- "suppressAddress": true,
- "displayAddress": "string",
- "city": "string",
- "state": "string",
- "sublocality": "string",
- "zip": "string",
- "countryCode": "st",
- "serviceArea": {
- "radius": 0,
- "unit": "string",
- "places": [
- "string"
]
}, - "phone": "string",
- "isPhoneTracked": true,
- "localPhone": "string",
- "alternatePhone": "string",
- "faxPhone": "string",
- "mobilePhone": "string",
- "tollFreePhone": "string",
- "ttyPhone": "string",
- "categoryIds": [
- "string"
], - "featuredMessage": "string",
- "featuredMessageUrl": "string",
- "websiteUrl": "string",
- "displayWebsiteUrl": "string",
- "reservationUrl": "string",
- "displayReservationUrl": "string",
- "menuUrl": "string",
- "displayMenuUrl": "string",
- "orderUrl": "string",
- "displayOrderUrl": "string",
- "hours": "string",
- "additionalHoursText": "string",
- "holidayHours": [
- {
- "hours": "string",
- "date": "2019-08-24",
- "isRegularHours": false
}
], - "description": "stringstri",
- "conditionsTreated": [
- "string"
], - "certifications": [
- "string"
], - "educationList": [
- {
- "type": "FELLOWSHIP",
- "institutionName": "string",
- "yearCompleted": "string"
}
], - "degrees": [
- "string"
], - "admittingHospitals": [
- "string"
], - "acceptingNewPatients": true,
- "closed": {
- "isClosed": true
}, - "paymentOptions": [
- "string"
], - "insuranceAccepted": [
- "string"
], - "logo": {
- "url": "string",
- "sourceUrl": "string",
- "description": "string",
- "details": "string",
- "alternateText": "string",
- "width": 0,
- "height": 0,
- "derivatives": [
- {
- "url": "string",
- "width": 0,
- "height": 0
}
]
}, - "photos": [
- {
- "url": "string",
- "sourceUrl": "string",
- "description": "string",
- "details": "string",
- "alternateText": "string",
- "width": 0,
- "height": 0,
- "derivatives": [
- {
- "url": "string",
- "width": 0,
- "height": 0
}
]
}
], - "headshot": {
- "url": "string",
- "sourceUrl": "string",
- "description": "string",
- "details": "string",
- "alternateText": "string",
- "width": 0,
- "height": 0,
- "derivatives": [
- {
- "url": "string",
- "width": 0,
- "height": 0
}
]
}, - "videoUrls": [
- "string"
], - "instagramHandle": "string",
- "twitterHandle": "string",
- "googleWebsiteOverride": "string",
- "googleCoverPhoto": {
- "url": "string",
- "sourceUrl": "string",
- "description": "string",
- "details": "string",
- "alternateText": "string",
- "width": 0,
- "height": 0,
- "derivatives": [
- {
- "url": "string",
- "width": 0,
- "height": 0
}
]
}, - "googleProfilePhoto": {
- "url": "string",
- "sourceUrl": "string",
- "description": "string",
- "details": "string",
- "alternateText": "string",
- "width": 0,
- "height": 0,
- "derivatives": [
- {
- "url": "string",
- "width": 0,
- "height": 0
}
]
}, - "googleAttributes": [
- {
- "id": "string",
- "optionIds": [
- "string"
]
}
], - "facebookPageUrl": "string",
- "facebookCallToAction": {