openapi: 3.0.0 info: title: Live API version: '2.0' servers: - url: https://cdn.yextapis.com/v2 paths: /accounts/{accountId}/entities: get: operationId: listEntities parameters: - schema: minLength: 0 type: string name: accountId in: path required: true - schema: minLength: 0 type: string description: A date in `YYYYMMDD` format. name: v in: query required: true - schema: minLength: 0 type: string description: | Optional parameter to return fields of type **Markdown** as HTML. - `false`: **Markdown** fields will be returned as JSON - `true`: **Markdown** fields will be returned as HTML name: convertMarkdownToHTML in: query required: false - schema: minLength: 0 type: string description: | Optional parameter to return fields of type **Rich Text** as HTML. - `false`: **Rich Text** fields will be returned as JSON - `true`: **Rich Text** fields will be returned as HTML name: convertRichTextToHTML in: query required: false - schema: minLength: 0 type: string description: | Comma-separated list of Entity types to filter on. Example: `"location,event"` Should be from the following types: * `atm` * `event` * `faq` * `financialProfessional` * `healthcareFacility` * `healthcareProfessional` * `hotel` * `hotelRoomType` * `job` * `location` * `organization` * `product` * `restaurant` OR the API name of a custom entity type. name: entityTypes in: query required: false - schema: minLength: 0 type: string description: Comma-separated list of field names. When present, only the fields listed will be returned. You can use dot notation to specify substructures (e.g., `"address.line1"`). Custom fields are specified in the same way, albeit with their `c_*` name. name: fields in: query required: false - schema: minLength: 0 type: string description: | This parameter represents one or more filtering conditions that are applied to the set of entities that would otherwise be returned. This parameter should be provided as a URL-encoded string containing a JSON object. For example, if the filter JSON is `{"name":{"$eq":"John"}}`, then the filter param after URL-encoding will be: `filter=%7B%22name%22%3A%7B%22%24eq%22%3A%22John%22%7D%7D` **Basic Filter Structure** The filter object at its core consists of a *matcher*, a *field*, and an *argument*. For example, in the following filter JSON: ``` { "name":{ "$eq":"John" } } ``` `$eq` is the *matcher*, or filtering operation (equals, in this example), `name` is the *field* being filtered by, and `John` is *value* to be matched against. **Combining Multiple Filters** Multiple filters can be combined into one object using *combinators*. For example, the following filter JSON combines multiple filters using the combinator `$and`. `$or` is also supported. ``` { "$and":[ { "firstName":{ "$eq":"John" } }, { "countryCode":{ "$in":[ "US", "GB" ] } } ] } ``` **Filter Negation** Certain filter types may be negated. For example: ``` { "$not": { "name": { "$eq": "John" } } } ``` This can also be written more simply with a `!` in the `$eq` parameter. The following filter would have the same effect: ``` { "name":{ "!$eq":"John" } } ``` **Filter Complement** You can also search for the complement of a filter. This filter would match entities that do not contain "hello" in their descriptions, or do not have a description set. This is different from negation which can only match entities who have the negated field set to something. ``` { "$complement":{ "description":{ "$contains":"hello" } } } ``` **Addressing Subfields** Subfields of fields can be addressed using the "dot" notation while filtering. For example, if you have a custom field called **`c_myCustomField`**: ``` { "c_myCustomField":{ "age": 30, "name": "Jim", } } ``` While filtering, subfields may be addressed using the "dot" notation. ``` { "c_myCustomField.name":{ "!$eq":"John" } } ``` Fields that are nested deeper may be addressed using dot notation, as well. For example, if **`name`** in the above example was a compound field with two subfields **`first`** and **`last`**, **`first`** may be addressed as **`c_myCustomField.name.first`**. **Field Support** Entity fields correspond to certain filter types, which support matchers. Going by the example above, the field **`name`** supports the `TEXT` filter type, which supports `$eq` (equals) and `$startsWith` (starts with). **TEXT** The `TEXT` filter type is supported for text fields. (e.g., **`name`**, **`countryCode`**)
Matcher Details
$eq (equals) { "countryCode":{ "$eq":"US" } }, { "countryCode":{ "!$eq":"US" } } Supports negation. Case insensitive.
$startsWith Matches if the field starts with the argument value. e.g., "Amazing" starts with "amaz" { "address.line1":{ "$startsWith": "Jo" } } Supports negation. Case insensitive.
$in Matches if field value is a member of the argument list. { "firstName":{ "$in": ["John", "Jimmy"] } } Does not support negation. Negation can be mimicked by using an "OR" matcher, for example: { "$and":[ { "firstName":{ "!$eq": "John" } }, { "firstName":{ "!$eq": "Jimmy" } } ] }
$contains { "c_myString":{ "$contains":"sample" } } This filter will match if "sample" is contained in any string within **`c_myString`**. Note that this matching is "left-edge n-gram", meaning the argument string must be the beginning of a token. The string "sample" will match strings like "This a sample", "Sample one", and "Sample 2", but not strings like "thisisasamplewithoutspaces". Supports negation.
$containsAny { "c_myString":{ "$containsAny":[ "sample1", "sample2" ] } } This filter will match if either "sample1" or "sample2" is contained in any string within **`c_myString`**. The argument list can contain more than two strings. Note that this matching is "left-edge n-gram", meaning the argument string must be the beginning of a token. The string "sample" will match strings like "This a sample", "Sample one", and "Sample 2", but not strings like "thisisasamplewithoutspaces". Supports negation.
$containsAll { "c_myString":{ "$containsAll":[ "sample1", "sample2" ] } } This filter will match if both "sample1" and "sample2" are contained in any string within **`c_myString`**. The argument list can contain more than two strings. Note that this matching is "left-edge n-gram", meaning the argument string must be the beginning of a token. The string "sample" will match strings like "This a sample", "Sample one", and "Sample 2", but not strings like "thisisasamplewithoutspaces". Supports negation.
**BOOLEAN** The BOOLEAN filter type is supported for boolean fields and Yes / No custom fields.
Matcher Details
$eq { "isFreeEvent": { "$eq": true } } For booleans, the filter takes a boolean value, not a string. Supports negation.
**STRUCT** The STRUCT filter type is supported for compound fields with subfields. *e.g., **`address`**, **`featuredMessage`**, fields of custom types*
Matcher Details
$hasProperty Matches if argument is a key (subfield) of field being filtered by. This filter type is useful for filtering by compound fields or to check if certain fields have a value set. { "address": { "$hasProperty": "line1" } } Note that if a given property of a compound field is not set, the filter will not match. For example, if `line1` of **`address`** is not set for an entity, then the above matcher will not match the entity. Supports negation.
**OPTION** The OPTION filter type is supported for options custom fields and fields that have a predetermined list of valid values. *e.g., **`eventStatus`**, **`gender`**, `SINGLE_OPTION` and `MULTI_OPTION` types of custom fields.*
Matcher Details
$eq Matching is case insensitive and insensitive to consecutive whitespace. e.g., "XYZ 123" matches "xyz 123" { "eventStatus": { "$eq": "SCHEDULED" } } Supports negation. Negating `$eq` on the list will match any field that does not hold any of the provided values.
$in { "eventStatus": { "$in": [ "SCHEDULED", "POSTPONED" ] } } Does not support negation. However, negation can be mimicked by using an `$and` matcher to negate individually over the desired values. For example: { "$and": [ { "eventStatus":{ "!$eq": "SCHEDULED" } }, { "firstName":{ "!$eq": "POSTPONED" } } ] }
**PHONE** The PHONE filter type is supported for phone number fields only. PHONE will support the same matchers as TEXT, except that for `$eq`, the same phone number with or without calling code will match.
Matcher Details
$eq { "mainPhone":{ "$eq":"+18187076189" } }, { "mainPhone":{ "$eq":"8187076189" } }, { "mainPhone":{ "!$eq":"9177076189" } } Supports negation. Case insensitive.
$startsWith Matches if the field starts with the argument value. e.g., "8187076189" starts with "818" { "mainPhone":{ "$startsWith": "818" } } Supports negation. Case insensitive.
$in Matches if field value is a member of the argument list. { "mainPhone":{ "$in": [ "8185551616", "9171112211" ] } } Does not support negation. However, negation can be mimicked by using an `$and` matcher to negate individually over the desired values.
**INTEGER, FLOAT, DATE, DATETIME, and TIME** These filter types are strictly ordered -- therefore, they support the following matchers: - Equals - Less Than / Less Than or Equal To - Greater Than / Greater Than or Equal To
Matcher Details
$eq Equals { "ageRange.maxValue": { "$eq": "80" } } Supports negation.
$lt Less than { "time.start": { "$lt": "2018-08-28T05:56" } }
$gt Greater than { "ageRange.maxValue": { "$gt": "50" } }
$le Less than or equal to { "ageRange.maxValue": { "$le": "40" } }
$ge Greater than or equal to { "time.end": { "$ge": "2018-08-28T05:56" } }
Combinations While we do not support "between" in our filtering syntax, it is possible to combine multiple matchers for a result similar to an "and" operation: { "ageRange.maxValue : { "$gt" : 10, "$lt": 20 } }
**LIST OF TEXT** Any field that has a list of valid values and supports any of the previously mentioned filter types will also support the `$contains` matcher.
Matcher Details
$eq { "c_myStringList": { "$eq": "sample" } } This filter will match if "sample" EXACTLY matches any string within **`c_myStringList`**. Supports negation.
$eqAny { "c_myStringList": { "$eqAny": [ "sample1", "sample2" ] } } This filter will match if any one of "sample1" or "sample2" EXACTLY match a string within **`c_myStringList`** . The argument can have more than two strings. Supports negation.
$eqAll { "c_myStringList": { "$eqAll": [ "sample1", "sample2" ] } } This filter will match if both "sample1" AND "sample2" EXACTLY match a string within **`c_myStringList`**. The argument can have more than two strings. Supports negation.
$contains { "c_myStringList":{ "$contains":"sample" } } This filter will match if "sample" is contained in any string within **`c_myStringList`**. Note that this matching is "left edge n-gram", meaning the argument string must be the beginning of a token. The string "sample" will match strings like "This is a sample", "Sample one", "Sample 2" but not strings like "thisisasamplewithoutspaces". Supports negation.
$containsAny { "c_myStringList": { "$containsAny": [ "sample1", "sample2" ] } } This filter will match if either "sample1" or "sample2" is contained in any string within **`c_myStringList`**. The argument list can have more than two strings. Note that similar to `$contains`, the matching for `$containsAny` is "left edge n-gram", meaning the argument string must be the beginning of a token. The string "sample" will match strings like "This is a sample", "Sample one", "Sample 2" but not strings like "thisisasamplewithoutspaces". Supports negation.
$containsAll { "c_myStringList": { "$containsAll": [ "sample1", "sample2" ] } } This filter will match if BOTH "sample1" and "sample2" are contained in strings within **`c_myStringList`**. The argument list can have more than two strings. Note that similar to `$contains`, the matching for `$containsAll` is "left-edge n-gram", meaning the argument string must be the beginning of a token. The string "sample" will match strings like "This a sample", "Sample one", and "Sample 2", but not strings like "thisisasamplewithoutspaces". Supports negation.
$startsWith { "c_myStringList": { "$startsWith":"sample" } } This filter will match if any string within **`c_myStringList`** starts with "sample". Does not supports negation. Case Insensitive.
**LIST OF BOOLEAN, OPTION, PHONE, INTEGER, FLOAT, DATE, DATETIME, OR TIME**
Matcher Details
$eq { "c_myDateList": { "$eq": "2019-01-01" } } This filter will match if "2019-01-01" EXACTLY matches any date within **`c_myDateList`**. Supports negation.
$eqAny { "c_myIntegerList": { "$eqAny": [1, 2] } } This filter will match if 1 or 2 EXACTLY match any integer within **`c_myIntegerList`**. The argument list can have more than two elements. Supports negation.
$eqAll { "c_myStringList": { "$eqAll": [ "sample1", "sample2" ] } } This filter will match if both "2019-01-01" AND "2019-01-02" EXACTLY match a date within **`c_myDateList`**. The argument list can have more than two elements. Supports negation.
**LIST OF STRUCT** Filtering on lists of struct types is a bit nuanced. Filtering can only be done on lists of structs of the SAME type. For example, if **`c_myStructList`** is a list of compound fields with the subfields **`age`** and **`name`**, then one can address the **`age`** properties of each field in **`c_myStructList`** as a flattened list of integers and filtering upon them. For example, the following filter: ``` { "c_myStructList.age":{ "$eq": 20 } } ``` will match if any field in the list has an **`age`** property equal to 20. Similarly, any filter that can be applied to lists of integers could be applied to **`age`** in this case (`$eq`, `$eqAll`, `$eqAny`). **HOURS** By filtering on an hours field, you can find which entities are open or closed at a specified time or during a certain time range. All of these filters also take an entity’s holiday hours and reopen date into account.
Matcher Details
$openAt { "hours": { "$openAt": "2019-01-06T13:45" } } This filter would match entities open at the specified time.
$closedAt { "hours": { "$closedAt: "2019-01-06T13:45" } }
$openForAllOf { "hours": { "$openForAllOf": { "start": "2019-01-06T13:45", "end": "2019-01-06T15:00" } } } This filter would match only those entities that are open for the entire range between 2019-01-06T13:45 and 2019-01-06T15:00. { "hours": { "$openForAllOf": "2019-05-10" } } This filter would match entities open for the entire 24 hour period on 2019-05-10. You can also supply a year, a month, or an hour to filter for entities open for the entire year, month, or hour, respectively.
$openForAnyOf { "hours": { "$openForAnyOf": { "start": "now", "end": "now+2h" } } } This filter will match any entities that are open for at least a portion of the time range between now and two hours from now.
$closedForAllOf { "hours": { "$closedForAllOf": { "start": "2019-01-06T13:45", "end": "2019-01-06T15:00" } } } This filter will match only those entities that are closed for the entire given time range.
$closedForAnyOf { "hours": { "$closedForAnyOf": { "start": "2019-01-06T13:45", "end": "2019-01-06T15:00" } } } This filter will match any entities that are closed for at least a portion of the given time range.
**Filtering by Dates and Times** **Time zones** The filtering language supports searching both in local time and within a certain time zone. Searching in local time will simply ignore the time zone on the target entities, while providing one will convert the zone of your queried time to the zone of the target entities. To search in local time, simply provide the date or time without any zone: `2019-06-07T15:30` or `2019-06-07`. To conduct a zoned search, provide the name of the time zone in brackets after the time, as it is shown in the tz database: `2019-06-07T15:30[America/New_York]` or `2019-06-06[America/Phoenix]`. **Date and time types** In addition to searching with dates and datetimes, you can also query with years, months, and hours. For example, the filter: ``` { "time.start": { "$eq": "2018" } } ``` would match all start times in the year 2018. The same logic would apply for a month (`2019-05`), a date (`2019-05-01`), or an hour (`2019-05-01T06`). These types also work with ordered searches. For example: ``` { "time.start": { "$lt": "2018" } } ``` would match start times before 2018 (i.e., anything in 2017 or before). On the other hand, the same query with a `$le` matcher would include anything in or before 2018. **"Now" and Date Math** Instead of providing a static date or time, you can also use `now` in place of any date time. When you do so, the system will calculate the time when the query is made and conduct a zoned search. In order to search for a future or past time relative to `now`, you can use date math. For example, you can enter `now+3h` or `now-1d`, which would mean 3 hours from now and 1 day ago, respectively. You can also add and subtract minutes (`m`), months (`M`), and years (`y`). It is also possible to add or subtract time from a static date or datetime. Simply add `||` between the static value and any addition or subtraction. For example, `2019-02-03||+1d` would be the same as `2019-02-04`. You can also convert date and time types to other types. For example, to convert the datetime `2019-05-06T22:15` to a date, use `2019-05-06T22:15||/d`. Doing so would yield the same result as using `2019-05-06`. This method also works with `now`: `now/d` will give you today’s date without the time. **Filtering Across an Entity** It is possible to search for a specific text string across all fields of an entity by using the `$anywhere` matcher.
Matcher Details
$anywhere Matches if the argument text appears anywhere in the entity (including subfields, structs, and lists) { "$anywhere": "hello" } This filter will match all entities that contain the string "hello" or strings that begin with "hello".
**Examples** The following filter will match against entities that: - Are of type `event` (note that entity types can also be filtered by the **`entityTypes`** query parameter) - Have a name that starts with the text "Century" - Have a maximum age between 10 and 20 - Have a minimum age between 5 and 7 - Start after 7 PM (19:00) on August 28, 2018 ``` { "$and":[ { "entityType":{ "$eq":"event" } }, { "name":{ "$startsWith":"Century" } }, { "ageRange.maxValue":{ "$gt":10, "$lt":20 } }, { "ageRange.minValue":{ "$gt":5, "$lt":7 } }, { "time.start":{ "$ge":"2018-08-28T19:00" } } ] } ``` name: filter in: query required: false - schema: minLength: 0 type: string default: markdown description: | Present if and only if at least one field is of type "**Legacy Rich Text**." Valid values: * `markdown` * `html` * `none` name: format in: query required: false - schema: minLength: 0 type: string description: | Comma-separated list of language codes. When present, the system will return Entities that have profiles in one or more of the provided languages. For each Location, only the first available profile from the provided list of languages will be returned. The keyword `"primary"` can be used to refer to a Location’s primary profile without providing a specific language code. If an Entity does not have profiles in any of the languages provided, that Entity's primary profile will be returned. name: languages in: query required: false - schema: multipleOf: 1 maximum: 50 type: number default: '10' description: Number of results to return. name: limit in: query required: false - schema: multipleOf: 1 type: number default: '0' description: | Number of results to skip. Used to page through results. Cannot be used together with **`pageToken`**. For Live API requests, the offset cannot be higher than 9,950. For Knowledge API the maximum limit is only enforced if a filter and/or sortBy parameter are given. name: offset in: query required: false - schema: minLength: 0 type: string description: If a response to a previous request contained the **`pageToken`** field, pass that field's value as the **`pageToken`** parameter to retrieve the next page of data. name: pageToken in: query required: false - schema: minLength: 0 type: string description: | A comma-separated list of saved filter IDs. When present, the system will return entities that are included in the filters matching **all** of the provided IDs. name: savedFilterIds in: query required: false - schema: minLength: 0 type: string description: | A list of fields and sort directions to order results by. Each ordering in the list should be in the format `{"field_name", "sort_direction"}`, where `sort_direction` is either `ASCENDING` or `DESCENDING`. For example, to order by `name` the sort order would be `[{"name":"ASCENDING"}]`. To order by `name` and then `description`, the sort order would be `[{"name":"ASCENDING"},{"description":"ASCENDING"}]`. name: sortBy in: query required: false tags: - Live API summary: 'Entities: List' description: | Retrieve a list of Entities within an account **NOTE:** Responses will contain resolved values for embedded fields responses: '200': description: Success Response content: application/json: schema: additionalProperties: false type: object properties: meta: additionalProperties: false type: object properties: uuid: minLength: 0 type: string description: Unique ID for this request / response. response: additionalProperties: false type: object properties: count: multipleOf: 1 type: number description: Total number of Entities that meet the filter criteria (ignores **``limit``** / **``offset``** parameters) entities: uniqueItems: false type: array items: additionalProperties: false type: object properties: meta: additionalProperties: false type: object properties: accountId: minLength: 0 type: string description: ID of the account associated with this Entity countryCode: minLength: 0 type: string description: |- Country code of this Entity's Language Profile (defaults to the country of the account) Filtering Type: `text` createdTimestamp: minLength: 0 type: string description: The timestamp of when the entity record was created. entityType: minLength: 0 type: string description: |- This Entity's type (e.g., location, event) Filtering Type: `text` folderId: minLength: 0 type: string description: |- The ID of the folder containing this Entity Filtering Type: `text` id: minLength: 0 type: string description: |- ID of this Entity Filtering Type: `text` labels: uniqueItems: false type: array items: minLength: 0 type: string description: 'Filtering Type: `text`' description: |- This Entity's labels. If the **`v`** parameter is before `20211215`, this will be an integer. Filtering Type: `list of text` language: minLength: 0 type: string description: |- Language code of this Entity's Language Profile (defaults to the language code of the account) Filtering Type: `text` timestamp: minLength: 0 type: string description: | The timestamp of the most recent change to this entity record. Will be ignored when the client is saving entity data to Yext. **NOTE:** The timestamp may change even if observable fields stay the same. uid: minLength: 0 type: string description: | The internal ID of the entity. This UID is a static, globally unique ID. Note that this value cannot be used in place of id in API calls to retrieve or edit Entity information. If the v param is before `20221206`, the returned value will be a hashed version of the entity UID (aka internal ID of the entity). description: |- Contains the metadata about the entity. ``` Eligible For: * atm * event * faq * healthcareFacility * healthcareProfessional * hotel * job * location * restaurant ``` name: minLength: 0 maxLength: 5000 type: string description: |- Cannot Include: * HTML markup Filtering Type: `text` ``` Eligible For: * atm * board * brand * card * contactCard * event * faq * financialProfessional * healthcareFacility * healthcareProfessional * helpArticle * hotel * hotelRoomType * job * location * organization * product * restaurant ``` address: additionalProperties: false type: object properties: city: minLength: 0 maxLength: 255 type: string description: |- The city the entity (or the entity's location) is in Cannot Include: * a URL or domain name Filtering Type: `text` countryCode: minLength: 0 pattern: ^[a-zA-Z]{2}$ type: string description: 'Filtering Type: `text`' extraDescription: minLength: 0 maxLength: 255 type: string description: |- Provides additional information to help consumers get to the entity. This string appears along with the entity's address (e.g., `In Menlo Mall, 3rd Floor`). It may also be used in conjunction with a hidden address (i.e., when **`addressHidden`** is `true`) to give consumers information about where the entity can be found (e.g., `Servicing the New York area`). Filtering Type: `text` line1: minLength: 0 maxLength: 255 type: string description: |- Cannot Include: * a URL or domain name Filtering Type: `text` line2: minLength: 0 maxLength: 255 type: string description: |- Cannot Include: * a URL or domain name Filtering Type: `text` postalCode: minLength: 0 maxLength: 10 type: string description: |- The entity's postal code. The postal code must be valid for the entity's country. Cannot include a URL or domain name. Cannot Include: * a URL or domain name Filtering Type: `text` region: minLength: 0 maxLength: 255 type: string description: |- The name of the entity's region or state. Cannot Include: * a URL or domain name Filtering Type: `text` sublocality: minLength: 0 maxLength: 255 type: string description: |- The name of the entity's sublocality Cannot Include: * a URL or domain name Filtering Type: `text` description: |- Contains the address of the entity (or where the entity is located) Must be a valid address Cannot be a P.O. Box If the entity is an `event`, either an **`address`** value or a **`linkedLocation`** value can be provided. Filtering Type: `object` ``` Eligible For: * atm * event * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` acceptingNewPatients: type: boolean description: |- Indicates whether the healthcare provider is accepting new patients. Filtering Type: `boolean` ``` Eligible For: * healthcareFacility * healthcareProfessional ``` acceptsReservations: type: boolean description: |- Indicates whether the entity accepts reservations. Filtering Type: `boolean` ``` Eligible For: * restaurant ``` accessHours: additionalProperties: false type: object properties: friday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the access hours are "closed" on Friday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is open on Friday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' holidayHours: description: |- **NOTE:** The list of Holiday Hours that you send us must be comprehensive. For example, if you send us a list of Holiday Hours that does not include Holiday Hours that you sent in your last update, Yext considers the missing Holiday Hours to be deleted, and we remove them. Array must be ordered. Filtering Type: `list of object` uniqueItems: true type: array items: required: - date additionalProperties: false type: object properties: date: format: date type: string description: |- Date on which the holiday hours will be in effect. Cannot be in the past. Date must be on or after 1970-01-01 Date must be before or on 2038-01-01 Filtering Type: `date` isClosed: type: boolean description: |- Indicates if the access hours are "closed" on on the given date. Filtering Type: `boolean` isRegularHours: type: boolean description: |- Indicates whether the holiday hours are the same as the regular business hours for the given date. If set to true, we will update the holiday hours if the regular business hours change for the date's day of the week. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is open on the specified date. Filtering Type: `list of object` description: 'Filtering Type: `object`' monday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the access hours are "closed" on Monday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is open on Monday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' reopenDate: format: date type: string description: |- Date must be on or after 1970-01-01 Date must be before or on 2038-01-01 Filtering Type: `date` saturday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the access hours are "closed" on Saturday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is open on Saturday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' sunday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the access hours are "closed" on Sunday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is open on Sunday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' thursday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the access hours are "closed" on Thursday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is open on Thursday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' tuesday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the access hours are "closed" on Tuesday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is open on Tuesday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' wednesday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the access hours are "closed" on Wednesday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is open on Wednesday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' description: |- Contains the daily access hours, holiday access hours, and reopen date for the Entity. Each day is represented by a sub-field of `accessHours`. (e.g. `monday`, `tuesday`, etc.) Open times can be specified per day through the `openIntervals` field and the `isClosed` flag. Similarly, holiday access hours are represented by the `holidayHours` sub-field. Setting the `reopenDate` sub-field indicates that the business is temporarily closed and will reopen on the specified date. SPECIAL CASES: * To indicate that an Entity is open 24 hours on a specific day, set start to 00:00 and end to 23:59 in `openIntervals` for that day. * To indicate that an Entity has split hours on a specific day (e.g., open from 9:00 AM to 12:00 PM and again from 1:00 PM to 5:00 PM), supply two or more `openIntervals` values with non-overlapping sets of hours. * If you are providing `openIntervals`, you may not set `isClosed` to true for that day. Filtering Type: `hours` ``` Eligible For: * atm * healthcareFacility * hotel * location * restaurant ``` additionalHoursText: minLength: 0 maxLength: 255 type: string description: |- Additional information about hours that does not fit in **`hours`** (e.g., `"Closed during the winter"`) Filtering Type: `text` ``` Eligible For: * atm * contactCard * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` additionalPromotingLocations: description: |- If other locations are promoting this event, a list of those locations' **`id`**s in the Yext Knowledge Manager Array must be ordered. Filtering Type: `list of entityId` ``` Eligible For: * event ``` uniqueItems: true type: array items: type: string description: 'Filtering Type: `entityId`' addressHidden: type: boolean description: |- If `true`, the entity's street address will not be shown on listings. Defaults to `false`. Filtering Type: `boolean` ``` Eligible For: * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` admittingHospitals: description: |- A list of hospitals where the healthcare professional admits patients Array must be ordered. Array may have a maximum of 100 elements. Array item description: >Cannot Include: >* HTML markup Filtering Type: `list of text` ``` Eligible For: * healthcareProfessional ``` uniqueItems: true type: array items: minLength: 0 maxLength: 100 type: string description: |- Cannot Include: * HTML markup Filtering Type: `text` adultPool: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity has a pool for adults only. Filtering Type: `option` ``` Eligible For: * hotel ``` ageRange: additionalProperties: false type: object properties: maxValue: multipleOf: 1 type: number description: |- Maximum age for the event Filtering Type: `integer` minValue: multipleOf: 1 type: number description: |- Minimum age for the event Filtering Type: `integer` description: |- Contains the age range for the event Filtering Type: `object` ``` Eligible For: * event ``` airportShuttle: enum: - AIRPORT_SHUTTLE_AVAILABLE - AIRPORT_SHUTTLE_AVAILABLE_FOR_FREE - NOT_APPLICABLE type: string description: |- Indicates whether the entity offers a shuttle to/from the airport. Filtering Type: `option` ``` Eligible For: * hotel ``` airportTransfer: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity offers a shuttle service of car service to/from nearby airports or train stations. Filtering Type: `option` ``` Eligible For: * hotel ``` allInclusive: enum: - ALL_INCLUSIVE_RATES_AVAILABLE - ALL_INCLUSIVE_RATES_ONLY - NOT_APPLICABLE type: string description: |- Indicates whether the entity offers all-inclusive rates. Filtering Type: `option` ``` Eligible For: * hotel ``` alternateNames: description: |- Other names for your business that you would like us to use when tracking your search performance Array must be ordered. Array may have a maximum of 3 elements. Array item description: >Cannot Include: >* HTML markup Filtering Type: `list of text` ``` Eligible For: * atm * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * organization * restaurant ``` uniqueItems: true type: array items: minLength: 0 maxLength: 100 type: string description: |- Cannot Include: * HTML markup Filtering Type: `text` alternatePhone: minLength: 0 type: string description: |- Must be a valid phone number. If the phone number's calling code is for a country other than the one given in the entity's **`countryCode`**, the phone number provided must contain the calling code (e.g., `+44` in `+442038083831`). Otherwise, the calling code is optional. Filtering Type: `text` ``` Eligible For: * atm * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` alternateWebsites: description: |- Other websites for your business that we should search for when tracking your search performance Array must be ordered. Array may have a maximum of 3 elements. Array item description: >Cannot Include: >* common domain names, e.g., google.com, youtube.com, etc. Filtering Type: `list of text` ``` Eligible For: * atm * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * organization * restaurant ``` uniqueItems: true type: array items: minLength: 0 maxLength: 255 format: uri type: string description: |- Cannot Include: * common domain names, e.g., google.com, youtube.com, etc. Filtering Type: `text` androidAppUrl: minLength: 0 type: string description: |- The URL where consumers can download the entity's Android app Filtering Type: `text` ``` Eligible For: * brand * financialProfessional * hotel * location * restaurant ``` answer: description: |- The answer to the frequently asked question represented by this entity Character limit: 0 .. 15000 Supported formats include: * BOLD * ITALICS * UNDERLINE * BULLETED_LIST * NUMBERED_LIST * HYPERLINK * IMAGE * CODE_SPAN * HEADINGS ``` Eligible For: * faq ``` type: string format: rich-text appleActionLinks: description: |- Use this field to add action links to your Apple Listings. The call to action category will be displayed on the action link button. The App Store URL should contain a valid link to the landing page of an App in the Apple App Store. The Quick Link URL is where a user is taken when an action link is clicked by a user. The App Name sub-field is not displayed on Apple Listings and is only used to distinguish the call-to-action type when utilizing action links in Apple posts. Array must be ordered. Filtering Type: `list of object` ``` Eligible For: * atm * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` uniqueItems: true type: array items: required: - category - quickLinkUrl - appName additionalProperties: false type: object properties: appName: minLength: 0 maxLength: 18 type: string description: 'Filtering Type: `text`' appStoreUrl: minLength: 0 maxLength: 2000 format: uri type: string description: 'Filtering Type: `text`' category: enum: - BOOK_TRAVEL - CHECK_IN - FEES_POLICIES - FLIGHT_STATUS - TICKETS - TICKETING - AMENITIES - FRONT_DESK - PARKING - GIFT_CARD - WAITLIST - DELIVERY - ORDER - TAKEOUT - PICKUP - RESERVE - MENU - APPOINTMENT - PORTFOLIO - QUOTE - SERVICES - STORE_ORDERS - STORE_SHOP - STORE_SUPPORT - SCHEDULE - SHOWTIMES - AVAILABILITY - PRICING - ACTIVITIES - BOOK - BOOK_(HOTEL) - BOOK_(RIDE) - BOOK_(TOUR) - CAREERS - CHARGE - COUPONS - DELIVERY_(RETAIL) - DONATE - EVENTS - ORDER_(RETAIL) - OTHER_MENU - PICKUP_(RETAIL) - RESERVE_(PARKING) - SHOWS - SPORTS - SUPPORT - TEE_TIME - GIFT_CARD_(RESTAURANT) type: string description: 'Filtering Type: `option`' quickLinkUrl: minLength: 0 maxLength: 2000 format: uri type: string description: 'Filtering Type: `text`' description: 'Filtering Type: `object`' appleBusinessDescription: minLength: 0 maxLength: 500 type: string description: |- The business description to be sent to Apple Filtering Type: `text` ``` Eligible For: * atm * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` appleBusinessId: minLength: 0 pattern: ^\d*\.?\d*$ type: string description: |- The ID associated with an individual Business Folder in your Apple account Filtering Type: `text` ``` Eligible For: * atm * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` appleCompanyId: minLength: 0 pattern: ^\d*\.?\d*$ type: string description: |- The ID associated with your Apple account. Numerical values only Filtering Type: `text` ``` Eligible For: * atm * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` appleCoverPhoto: required: - url additionalProperties: false type: object description: |- The cover photo for the entity''s Apple profile Image must be at least 1600 x 1040 pixels Image may be no more than 4864 x 3163 pixels Supported Aspect Ratios: * 154 x 100 **NOTE**: Maximum image size is 5mb after normalization and padding (if applicable). As well, there is a 6 second download limit from the image host. Filtering Type: `object` ``` Eligible For: * atm * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` properties: alternateText: minLength: 0 type: string description: 'Filtering Type: `text`' url: minLength: 0 format: uri type: string description: 'Filtering Type: `text`' appleDisplayName: minLength: 0 maxLength: 5000 type: string description: |- The name to be displayed on Apple for the entity. NOTE: The names of Brands and their respective Locations within an Apple Business Connect Account must match identically. Cannot Include: HTML markup Cannot Include: * HTML markup Filtering Type: `text` ``` Eligible For: * atm * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` applicationUrl: minLength: 0 format: uri type: string description: |- The application URL Filtering Type: `text` ``` Eligible For: * job ``` associations: description: |- Association memberships relevant to the entity (e.g., `"New York Doctors Association"`) All strings must be non-empty when trimmed of whitespace. Array must be ordered. Array may have a maximum of 100 elements. Array item description: >Cannot Include: >* HTML markup Filtering Type: `list of text` ``` Eligible For: * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` uniqueItems: true type: array items: minLength: 0 maxLength: 100 type: string description: |- Cannot Include: * HTML markup Filtering Type: `text` attendance: required: - attendanceMode additionalProperties: false type: object properties: attendanceMode: enum: - OFFLINE - ONLINE - MIXED type: string description: 'Filtering Type: `option`' virtualLocationUrl: minLength: 0 format: uri type: string description: 'Filtering Type: `text`' description: |- Indicates whether the event is online, offline, or a mix. A `virtualLocationUrl` must be specified for online and mixed events. Filtering Type: `object` ``` Eligible For: * event ``` attire: enum: - UNSPECIFIED - DRESSY - CASUAL - FORMAL type: string description: |- The formality of clothing typically worn at this restaurant Filtering Type: `option` ``` Eligible For: * restaurant ``` babysittingOffered: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity offers babysitting. Filtering Type: `option` ``` Eligible For: * hotel ``` baggageStorage: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity offers baggage storage pre check-in and post check-out. Filtering Type: `option` ``` Eligible For: * hotel ``` bar: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity has an indoor or outdoor bar onsite. Filtering Type: `option` ``` Eligible For: * hotel ``` beachAccess: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity has access to a beach. Filtering Type: `option` ``` Eligible For: * hotel ``` beachFrontProperty: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity is physically located next to a beach. Filtering Type: `option` ``` Eligible For: * hotel ``` bicycles: enum: - BICYCLE_RENTALS - BICYCLE_RENTALS_FOR_FREE - NOT_APPLICABLE type: string description: |- Indicates whether the entity offers bicycles for rent or for free. Filtering Type: `option` ``` Eligible For: * hotel ``` bios: additionalProperties: false type: object properties: ids: description: |- IDs of the Bio Lists associated with this entity Array must be ordered. Array may have a maximum of 40 elements. Filtering Type: `list of text` uniqueItems: true type: array items: minLength: 0 type: string description: 'Filtering Type: `text`' label: minLength: 0 maxLength: 30 type: string description: |- Label to be used for this entity's Bio Lists. This label will appear on your entity's listings. Filtering Type: `text` description: |- Information about the Bio Content Lists associated with this entity Filtering Type: `object` ``` Eligible For: * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * organization * restaurant ``` boutiqueStores: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity has a boutique store. Gift shop or convenience store are not eligible. Filtering Type: `option` ``` Eligible For: * hotel ``` brands: description: |- Brands sold by this entity All strings must be non-empty when trimmed of whitespace. Array must be ordered. Array may have a maximum of 100 elements. Array item description: >Cannot Include: >* HTML markup Filtering Type: `list of text` ``` Eligible For: * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` uniqueItems: true type: array items: minLength: 0 maxLength: 100 type: string description: |- Cannot Include: * HTML markup Filtering Type: `text` breakfast: enum: - BREAKFAST_AVAILABLE - BREAKFAST_AVAILABLE_FOR_FREE - NOT_APPLICABLE type: string description: |- Indicates whether the entity offers breakfast. Filtering Type: `option` ``` Eligible For: * hotel ``` brunchHours: additionalProperties: false type: object properties: friday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the brunch hours are "closed" on Friday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is open for brunch on Friday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' holidayHours: description: |- **NOTE:** The list of Holiday Hours that you send us must be comprehensive. For example, if you send us a list of Holiday Hours that does not include Holiday Hours that you sent in your last update, Yext considers the missing Holiday Hours to be deleted, and we remove them. Array must be ordered. Filtering Type: `list of object` uniqueItems: true type: array items: required: - date additionalProperties: false type: object properties: date: format: date type: string description: |- Date on which the holiday hours will be in effect. Cannot be in the past. Date must be on or after 1970-01-01 Date must be before or on 2038-01-01 Filtering Type: `date` isClosed: type: boolean description: |- Indicates if the brunch hours are "closed" on on the given date. Filtering Type: `boolean` isRegularHours: type: boolean description: |- Indicates whether the holiday hours are the same as the regular business hours for the given date. If set to true, we will update the holiday hours if the regular business hours change for the date's day of the week. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is open on the specified date. Filtering Type: `list of object` description: 'Filtering Type: `object`' monday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the brunch hours are "closed" on Monday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is open for brunch on Monday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' reopenDate: format: date type: string description: |- Date must be on or after 1970-01-01 Date must be before or on 2038-01-01 Filtering Type: `date` saturday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the brunch hours are "closed" on Saturday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is open for brunch on Saturday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' sunday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the brunch hours are "closed" on Sunday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is open for brunch on Sunday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' thursday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the brunch hours are "closed" on Thursday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is open for brunch on Thursday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' tuesday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the brunch hours are "closed" on Tuesday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is open for brunch on Tuesday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' wednesday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the brunch hours are "closed" on Wednesday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is open for brunch on Wednesday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' description: |- Contains the daily brunch hours, holiday brunch hours, and reopen date for the Entity. Each day is represented by a sub-field of `brunchHours`. (e.g. `monday`, `tuesday`, etc.) Open times can be specified per day through the `openIntervals` field and the `isClosed` flag. Similarly, holiday brunch hours are represented by the `holidayHours` sub-field. Setting the `reopenDate` sub-field indicates that the business is temporarily closed and will reopen on the specified date. SPECIAL CASES: * To indicate that an Entity is open 24 hours on a specific day, set start to 00:00 and end to 23:59 in `openIntervals` for that day. * To indicate that an Entity has split hours on a specific day (e.g., open from 9:00 AM to 12:00 PM and again from 1:00 PM to 5:00 PM), supply two or more `openIntervals` values with non-overlapping sets of hours. * If you are providing `openIntervals`, you may not set `isClosed` to true for that day. Filtering Type: `hours` ``` Eligible For: * hotel * location * restaurant ``` businessCenter: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity has a business center. Filtering Type: `option` ``` Eligible For: * hotel ``` calendars: additionalProperties: false type: object properties: ids: description: |- IDs of the Calendars associated with this entity Array must be ordered. Array may have a maximum of 40 elements. Filtering Type: `list of text` uniqueItems: true type: array items: minLength: 0 type: string description: 'Filtering Type: `text`' label: minLength: 0 maxLength: 30 type: string description: |- Label to be used for this entity's Calendars. This label will appear on your entity's listings. Filtering Type: `text` description: |- Information about the events Content Lists (Calendars) associated with this entity Filtering Type: `object` ``` Eligible For: * financialProfessional * healthcareFacility * hotel * location * restaurant ``` carRental: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity offers car rental. Filtering Type: `option` ``` Eligible For: * hotel ``` casino: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity has a casino on premise or nearby. Filtering Type: `option` ``` Eligible For: * hotel ``` categories: additionalProperties: false type: object properties: {} description: |- Yext Categories. (Supported for versions > 20240220) A map of category list external IDs (i.e. "yext") to a list of category IDs. IDs must be valid and selectable (i.e., cannot be parent categories). Partial updates are accepted, meaning sending only the "yext" property will have no effect on any category list except the "yext" category. Filtering Type: `object` ``` Eligible For: * atm * event * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` categoryIds: uniqueItems: false type: array items: minLength: 0 type: string description: 'Filtering Type: `text`' description: |- Yext Category IDs. (Deprecated: For versions > 20240220) 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. Filtering Type: `list of text` ``` Eligible For: * atm * event * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` catsAllowed: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates if the entity is cat friendly. Filtering Type: `option` ``` Eligible For: * hotel ``` certifications: description: |- A list of the certifications held by the healthcare professional **NOTE:** This field is only available to locations whose **`entityType`** is `healthcareProfessional`. Array must be ordered. Array may have a maximum of 100 elements. Array item description: >Cannot Include: >* HTML markup Filtering Type: `list of text` ``` Eligible For: * financialProfessional * healthcareProfessional ``` uniqueItems: true type: array items: minLength: 0 maxLength: 200 type: string description: |- Cannot Include: * HTML markup Filtering Type: `text` checkInTime: format: time type: string description: |- The check-in time Filtering Type: `time` ``` Eligible For: * hotel ``` checkOutTime: format: time type: string description: |- The check-out time Filtering Type: `time` ``` Eligible For: * hotel ``` classificationRating: pattern: ^\d*\.?\d*$ type: string description: |- The 1 to 5 star rating of the entitiy based on its services and facilities. Filtering Type: `decimal` ``` Eligible For: * hotel ``` closed: type: boolean description: |- Indicates whether the entity is closed Filtering Type: `boolean` ``` Eligible For: * atm * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` concierge: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity offers concierge service. Filtering Type: `option` ``` Eligible For: * hotel ``` conditionsTreated: description: |- A list of the conditions treated by the healthcare provider Array must be ordered. Array may have a maximum of 100 elements. Array item description: >Cannot Include: >* HTML markup Filtering Type: `list of text` ``` Eligible For: * healthcareFacility * healthcareProfessional ``` uniqueItems: true type: array items: minLength: 0 maxLength: 100 type: string description: |- Cannot Include: * HTML markup Filtering Type: `text` convenienceStore: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity has a convenience store. Filtering Type: `option` ``` Eligible For: * hotel ``` covidMessaging: minLength: 0 maxLength: 15000 type: string description: |- Information or messaging related to COVID-19. Filtering Type: `text` ``` Eligible For: * healthcareFacility * healthcareProfessional * location ``` covidTestAppointmentUrl: minLength: 0 format: uri type: string description: |- An appointment URL for scheduling a COVID-19 test. Filtering Type: `text` ``` Eligible For: * healthcareFacility * location ``` covidTestingAppointmentRequired: type: boolean description: |- Indicates whether an appointment is required for a COVID-19 test. Filtering Type: `boolean` ``` Eligible For: * healthcareFacility * location ``` covidTestingDriveThroughSite: type: boolean description: |- Indicates whether location is a drive-through site for COVID-19 tests. Filtering Type: `boolean` ``` Eligible For: * healthcareFacility * location ``` covidTestingIsFree: type: boolean description: |- Indicates whether location offers free COVID-19 testing. Filtering Type: `boolean` ``` Eligible For: * healthcareFacility * location ``` covidTestingPatientRestrictions: type: boolean description: |- Indicates whether there are patient restrictions for COVID-19 testing. Filtering Type: `boolean` ``` Eligible For: * healthcareFacility * location ``` covidTestingReferralRequired: type: boolean description: |- Indicates whether a referral is required for COVID-19 testing. Filtering Type: `boolean` ``` Eligible For: * healthcareFacility * location ``` covidTestingSiteInstructions: minLength: 0 maxLength: 15000 type: string description: |- Information or instructions for the COVID-19 testing site. Filtering Type: `text` ``` Eligible For: * healthcareFacility * location ``` covidVaccineAppointmentRequired: type: boolean description: |- Indicates whether an appointment is required for a COVID-19 vaccine. Filtering Type: `boolean` ``` Eligible For: * healthcareFacility * location ``` covidVaccineDriveThroughSite: type: boolean description: |- Indicates whether location is a drive-through site for COVID-19 vaccines. Filtering Type: `boolean` ``` Eligible For: * healthcareFacility * location ``` covidVaccineInformationUrl: minLength: 0 format: uri type: string description: |- An information URL for more information about COVID-19 vaccines. Filtering Type: `text` ``` Eligible For: * healthcareFacility * location ``` covidVaccinePatientRestrictions: type: boolean description: |- Indicates whether there are patient restrictions for a COVID-19 vaccine. Filtering Type: `boolean` ``` Eligible For: * healthcareFacility * location ``` covidVaccineReferralRequired: type: boolean description: |- Indicates whether a referral is required for a COVID-19 vaccine. Filtering Type: `boolean` ``` Eligible For: * healthcareFacility * location ``` covidVaccineSiteInstructions: minLength: 0 maxLength: 15000 type: string description: |- Information or instructions for the COVID-19 vaccination site. Filtering Type: `text` ``` Eligible For: * healthcareFacility * location ``` covidVaccinesOffered: uniqueItems: true type: array items: enum: - PFIZER - MODERNA - JOHNSON_&_JOHNSON type: string description: 'Filtering Type: `option`' description: |- Indicates which COVID-19 vaccines the location offers. Filtering Type: `list of option` ``` Eligible For: * healthcareFacility * location ``` currencyExchange: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity offers currency exchange services. Filtering Type: `option` ``` Eligible For: * hotel ``` customKeywords: description: |- Additional keywords you would like us to use when tracking your search performance Array must be ordered. Array may have a maximum of 5 elements. Filtering Type: `list of text` ``` Eligible For: * atm * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * organization * restaurant ``` uniqueItems: true type: array items: minLength: 0 maxLength: 100 type: string description: 'Filtering Type: `text`' datePosted: format: date type: string description: |- The date this entity was posted Filtering Type: `date` ``` Eligible For: * job ``` degrees: description: |- A list of the degrees earned by the healthcare professional Array must be ordered. Filtering Type: `list of option` ``` Eligible For: * healthcareProfessional ``` uniqueItems: true type: array items: enum: - ANP - APN - APRN - ARNP - AUD - BSW - CCCA - CNM - CNP - CNS - CPNP - CRNA - CRNP - DC - DDS - DMD - DNP - DO - DPM - DPT - DSW - DVM - FNP - GNP - LAC - LCSW - LPN - MBA - MBBS - MD - MPAS - MPH - MSW - ND - NNP - NP - OD - PA - PAC - PHARMD - PHD - PNP - PSYD - RD - RSW - VMD - WHNP type: string description: 'Filtering Type: `option`' deliveryHours: additionalProperties: false type: object properties: friday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the delivery hours are "closed" on Friday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is delivering on Friday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' holidayHours: description: |- **NOTE:** The list of Holiday Hours that you send us must be comprehensive. For example, if you send us a list of Holiday Hours that does not include Holiday Hours that you sent in your last update, Yext considers the missing Holiday Hours to be deleted, and we remove them. Array must be ordered. Filtering Type: `list of object` uniqueItems: true type: array items: required: - date additionalProperties: false type: object properties: date: format: date type: string description: |- Date on which the holiday hours will be in effect. Cannot be in the past. Date must be on or after 1970-01-01 Date must be before or on 2038-01-01 Filtering Type: `date` isClosed: type: boolean description: |- Indicates if the delivery hours are "closed" on on the given date. Filtering Type: `boolean` isRegularHours: type: boolean description: |- Indicates whether the holiday hours are the same as the regular business hours for the given date. If set to true, we will update the holiday hours if the regular business hours change for the date's day of the week. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is delivering on the specified date. Filtering Type: `list of object` description: 'Filtering Type: `object`' monday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the delivery hours are "closed" on Monday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is delivering on Monday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' reopenDate: format: date type: string description: |- Date must be on or after 1970-01-01 Date must be before or on 2038-01-01 Filtering Type: `date` saturday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the delivery hours are "closed" on Saturday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is delivering on Saturday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' sunday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the delivery hours are "closed" on Sunday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is delivering on Sunday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' thursday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the delivery hours are "closed" on Thursday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is delivering on Thursday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' tuesday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the delivery hours are "closed" on Tuesday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is delivering on Tuesday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' wednesday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the delivery hours are "closed" on Wednesday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is delivering on Wednesday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' description: |- Contains the daily delivery hours, holiday delivery hours, and reopen date for the Entity. Each day is represented by a sub-field of `deliveryHours`. (e.g. `monday`, `tuesday`, etc.) Open times can be specified per day through the `openIntervals` field and the `isClosed` flag. Similarly, holiday delivery hours are represented by the `holidayHours` sub-field. Setting the `reopenDate` sub-field indicates that the business is temporarily closed and will reopen on the specified date. SPECIAL CASES: * To indicate that an Entity is open 24 hours on a specific day, set start to 00:00 and end to 23:59 in `openIntervals` for that day. * To indicate that an Entity has split hours on a specific day (e.g., open from 9:00 AM to 12:00 PM and again from 1:00 PM to 5:00 PM), supply two or more `openIntervals` values with non-overlapping sets of hours. * If you are providing `openIntervals`, you may not set `isClosed` to true for that day. Filtering Type: `hours` ``` Eligible For: * location * restaurant ``` description: minLength: 10 maxLength: 15000 type: string description: |- A description of the entity Cannot Include: * HTML markup Filtering Type: `text` ``` Eligible For: * atm * contactCard * event * financialProfessional * healthcareFacility * healthcareProfessional * hotel * job * location * organization * restaurant ``` displayCoordinate: additionalProperties: false type: object properties: latitude: minimum: -90 maximum: 90 type: number description: 'Filtering Type: `float`' longitude: minimum: -180 maximum: 180 type: number description: 'Filtering Type: `float`' description: |- Coordinates where the map pin for the entity should be displayed, as provided by you Filtering Type: `object` ``` Eligible For: * atm * event * financialProfessional * healthcareFacility * healthcareProfessional * hotel * job * location * restaurant ``` doctorOnCall: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity has a doctor on premise or on call. Filtering Type: `option` ``` Eligible For: * hotel ``` dogsAllowed: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates if the entity is dog friendly. Filtering Type: `option` ``` Eligible For: * hotel ``` driveThroughHours: additionalProperties: false type: object properties: friday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the drive-through hours are "closed" on Friday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity's drive-through is open on Friday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' holidayHours: description: |- **NOTE:** The list of Holiday Hours that you send us must be comprehensive. For example, if you send us a list of Holiday Hours that does not include Holiday Hours that you sent in your last update, Yext considers the missing Holiday Hours to be deleted, and we remove them. Array must be ordered. Filtering Type: `list of object` uniqueItems: true type: array items: required: - date additionalProperties: false type: object properties: date: format: date type: string description: |- Date on which the holiday hours will be in effect. Cannot be in the past. Date must be on or after 1970-01-01 Date must be before or on 2038-01-01 Filtering Type: `date` isClosed: type: boolean description: |- Indicates if the drive-through hours are "closed" on on the given date. Filtering Type: `boolean` isRegularHours: type: boolean description: |- Indicates whether the holiday hours are the same as the regular business hours for the given date. If set to true, we will update the holiday hours if the regular business hours change for the date's day of the week. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity's drive-through is open on the specified date. Filtering Type: `list of object` description: 'Filtering Type: `object`' monday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the drive-through hours are "closed" on Monday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity's drive-through is open on Monday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' reopenDate: format: date type: string description: |- Date must be on or after 1970-01-01 Date must be before or on 2038-01-01 Filtering Type: `date` saturday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the drive-through hours are "closed" on Saturday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity's drive-through is open on Saturday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' sunday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the drive-through hours are "closed" on Sunday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity's drive-through is open on Sunday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' thursday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the drive-through hours are "closed" on Thursday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity's drive-through is open on Thursday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' tuesday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the drive-through hours are "closed" on Tuesday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity's drive-through is open on Tuesday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' wednesday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the drive-through hours are "closed" on Wednesday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity's drive-through is open on Wednesday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' description: |- Contains the daily drive-through hours, holiday drive-through hours, and reopen date for the Entity. Each day is represented by a sub-field of `driveThroughHours`. (e.g. `monday`, `tuesday`, etc.) Open times can be specified per day through the `openIntervals` field and the `isClosed` flag. Similarly, holiday drive-through hours are represented by the `holidayHours` sub-field. Setting the `reopenDate` sub-field indicates that the business is temporarily closed and will reopen on the specified date. SPECIAL CASES: * To indicate that an Entity is open 24 hours on a specific day, set start to 00:00 and end to 23:59 in `openIntervals` for that day. * To indicate that an Entity has split hours on a specific day (e.g., open from 9:00 AM to 12:00 PM and again from 1:00 PM to 5:00 PM), supply two or more `openIntervals` values with non-overlapping sets of hours. * If you are providing `openIntervals`, you may not set `isClosed` to true for that day. Filtering Type: `hours` ``` Eligible For: * atm * location * restaurant ``` dropoffCoordinate: additionalProperties: false type: object properties: latitude: minimum: -90 maximum: 90 type: number description: 'Filtering Type: `float`' longitude: minimum: -180 maximum: 180 type: number description: 'Filtering Type: `float`' description: |- Coordinates of the drop-off area for the entity, as provided by you Filtering Type: `object` ``` Eligible For: * atm * event * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` educationList: description: |- Information about the education or training completed by the healthcare professional Array must be ordered. Filtering Type: `list of object` ``` Eligible For: * healthcareProfessional ``` uniqueItems: true type: array items: required: - type - institutionName - yearCompleted additionalProperties: false type: object properties: institutionName: minLength: 0 maxLength: 100 type: string description: 'Filtering Type: `text`' type: enum: - FELLOWSHIP - RESIDENCY - INTERNSHIP - MEDICAL_SCHOOL type: string description: 'Filtering Type: `option`' yearCompleted: multipleOf: 1 minimum: 1900 maximum: 2100 type: number description: 'Filtering Type: `integer`' description: 'Filtering Type: `object`' electricChargingStation: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity has electric car chargine stations on premise. Filtering Type: `option` ``` Eligible For: * hotel ``` elevator: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity has an elevator. Filtering Type: `option` ``` Eligible For: * hotel ``` ellipticalMachine: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity has an elliptical machine. Filtering Type: `option` ``` Eligible For: * hotel ``` emails: description: |- Emails addresses for this entity's point of contact Must be valid email addresses Array must be ordered. Array may have a maximum of 5 elements. Filtering Type: `list of text` ``` Eligible For: * contactCard * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * organization * restaurant ``` uniqueItems: true type: array items: minLength: 0 format: email type: string description: 'Filtering Type: `text`' employmentType: enum: - FULL_TIME - PART_TIME - CONTRACTOR - TEMPORARY - INTERN - VOLUNTEER - PER_DIEM - OTHER type: string description: |- The employment type for the open job. Indicates whether the job is full-time, part-time, temporary, etc. Filtering Type: `option` ``` Eligible For: * job ``` eventStatus: enum: - SCHEDULED - RESCHEDULED - POSTPONED - CANCELED - EVENT_MOVED_ONLINE type: string description: |- Information on whether the event will take place as scheduled Filtering Type: `option` ``` Eligible For: * event ``` facebookAbout: minLength: 0 maxLength: 255 type: string description: |- A description of the entity to be used in the "About You" section on Facebook Filtering Type: `text` ``` Eligible For: * atm * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` facebookCallToAction: required: - type additionalProperties: false type: object properties: type: enum: - NONE - BOOK_NOW - CALL_NOW - CONTACT_US - SEND_MESSAGE - USE_APP - PLAY_GAME - SHOP_NOW - SIGN_UP - WATCH_VIDEO - SEND_EMAIL - LEARN_MORE - PURCHASE_GIFT_CARDS - ORDER_NOW - FOLLOW_PAGE type: string description: |- The action the consumer is being prompted to take by the button's text Filtering Type: `option` value: minLength: 0 type: string description: |- Indicates where consumers will be directed to upon clicking the Call-to-Action button (e.g., a URL). It can be a free-form string or an embedded value, depending on what the user specifies. For example, if the user sets the Facebook Call-to-Action as " 'Sign Up' using 'Website URL' " in the Yext platform, **`type`** will be `SIGN_UP` and **`value`** will be `[[websiteUrl]]`. The Call-to-Action will have the same behavior if the user sets the value to "Custom Value" in the platform and embeds a field. Filtering Type: `text` description: |- Designates the Facebook Call-to-Action button text and value Valid contents of **`value`** depends on the Call-to-Action's **`type`**: * `NONE`: (optional) * `BOOK_NOW`: URL * `CALL_NOW`: Phone number * `CONTACT_US`: URL * `SEND_MESSAGE`: Any string * `USE_APP`: URL * `PLAY_GAME`: URL * `SHOP_NOW`: URL * `SIGN_UP`: URL * `WATCH_VIDEO`: URL * `SEND_EMAIL`: Email address * `LEARN_MORE`: URL * `PURCHASE_GIFT_CARDS`: URL * `ORDER_NOW`: URL * `FOLLOW_PAGE`: Any string Filtering Type: `object` ``` Eligible For: * atm * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` facebookCoverPhoto: required: - url additionalProperties: false type: object description: |- The cover photo for the entity's Facebook profile Displayed as a 851 x 315 pixel image You may need a cover photo in order for your listing to appear on Facebook. Please check your listings tab to learn more. Image must be at least 400 x 150 pixels Image area (width x height) may be no more than 41000000 pixels Image may be no more than 30000 x 30000 pixels Supported Aspect Ratios: * 1 x 1 * 4 x 3 * 3 x 2 * 5 x 3 * 16 x 9 * 3 x 1 * 2 x 3 * 5 x 7 * 4 x 5 * 4 x 1 **NOTE**: Maximum image size is 5mb after normalization and padding (if applicable). As well, there is a 6 second download limit from the image host. Filtering Type: `object` ``` Eligible For: * atm * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` properties: alternateText: minLength: 0 type: string description: 'Filtering Type: `text`' url: minLength: 0 format: uri type: string description: 'Filtering Type: `text`' facebookDescriptor: minLength: 3 maxLength: 75 type: string description: |- Location Descriptors are used for Enterprise businesses that sync Facebook listings using brand page location structure. The Location Descriptor is typically an additional geographic description (e.g. geomodifier) that will appear in parentheses after the name on the Facebook listing. Cannot Include: * HTML markup Filtering Type: `text` ``` Eligible For: * atm * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` facebookName: minLength: 0 type: string description: |- The name for this entity's Facebook profile. A separate name may be specified to send only to Facebook in order to comply with any specific Facebook rules or naming conventions. Filtering Type: `text` ``` Eligible For: * atm * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` facebookOverrideCity: minLength: 0 type: string description: |- The city to be displayed on this entity's Facebook profile Filtering Type: `text` ``` Eligible For: * atm * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` facebookPageUrl: minLength: 0 type: string description: |- URL for the entity's Facebook Page. Valid formats: - facebook.com/profile.php?id=[numId] - facebook.com/group.php?gid=[numId] - facebook.com/groups/[numId] - facebook.com/[Name] - facebook.com/pages/[Name]/[numId] - facebook.com/people/[Name]/[numId] where [Name] is a String and [numId] is an Integer The success response will contain a warning message explaining why the URL wasn't stored in the system. Filtering Type: `text` ``` Eligible For: * atm * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * organization * restaurant ``` facebookParentPageId: minLength: 0 maxLength: 65 type: string description: |- The Facebook Page ID of this entity's brand page if in a brand page location structure Filtering Type: `text` ``` Eligible For: * atm * brand * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` facebookProfilePhoto: required: - url additionalProperties: false type: object description: |- The profile picture for the entity's Facebook profile You must have a profile picture in order for your listing to appear on Facebook. Image must be at least 180 x 180 pixels Image area (width x height) may be no more than 41000000 pixels Image may be no more than 30000 x 30000 pixels Supported Aspect Ratios: * 1 x 1 * 4 x 3 * 3 x 2 * 5 x 3 * 16 x 9 * 3 x 1 * 2 x 3 * 5 x 7 * 4 x 5 * 4 x 1 **NOTE**: Maximum image size is 5mb after normalization and padding (if applicable). As well, there is a 6 second download limit from the image host. Filtering Type: `object` ``` Eligible For: * atm * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` properties: alternateText: minLength: 0 type: string description: 'Filtering Type: `text`' url: minLength: 0 format: uri type: string description: 'Filtering Type: `text`' facebookStoreId: minLength: 0 type: string description: |- The Store ID used for this entity in a brand page location structure Filtering Type: `text` ``` Eligible For: * atm * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` facebookVanityUrl: minLength: 0 maxLength: 50 type: string description: |- The username that appear's in the Facebook listing URL to help customers find and remember a brand’s Facebook page. The username is also be used for tagging the Facebook page in other users’ posts, and searching for the Facebook page. Filtering Type: `text` ``` Eligible For: * atm * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` facebookWebsiteOverride: minLength: 0 format: uri type: string description: |- The URL you would like to submit to Facebook in place of the one given in **`websiteUrl`** (if applicable). Filtering Type: `text` ``` Eligible For: * atm * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` fax: minLength: 0 type: string description: |- Must be a valid fax number. If the fax number's calling code is for a country other than the one given in the entity's **`countryCode`**, the fax number provided must contain the calling code (e.g., `+44` in `+442038083831`). Otherwise, the calling code is optional. Filtering Type: `text` ``` Eligible For: * atm * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` featuredMessage: additionalProperties: false type: object properties: description: minLength: 0 maxLength: 50 type: string description: |- The text of Featured Message. Default: `Call today!` Cannot include: - inappropriate language - HTML markup - a URL or domain name - a phone number - control characters ([\x00-\x1F\x7F]) - insufficient spacing If you submit a Featured Message that contains profanity or more than 50 characters, it will be ignored. The success response will contain a warning message explaining why your Featured Message wasn't stored in the system. Cannot Include: * HTML markup Filtering Type: `text` url: minLength: 0 maxLength: 255 format: uri type: string description: |- Valid URL linked to the Featured Message text Filtering Type: `text` description: |- Information about the entity's Featured Message Filtering Type: `object` ``` Eligible For: * atm * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` firstName: minLength: 0 maxLength: 35 type: string description: |- The first name of the healthcare professional Cannot Include: * a URL or domain name * HTML markup Filtering Type: `text` ``` Eligible For: * healthcareProfessional ``` firstPartyReviewPage: minLength: 0 type: string description: |- Link to the review-collection page, where consumers can leave first-party reviews ``` Eligible For: * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` fitnessCenter: enum: - FITNESS_CENTER_AVAILABLE - FITNESS_CENTER_AVAILABLE_FOR_FREE - NOT_APPLICABLE type: string description: |- Indicates whether the entity has a fitness center. Filtering Type: `option` ``` Eligible For: * hotel ``` floorCount: multipleOf: 1 minimum: 0 type: number description: |- The number of floors the entity has from ground floor to top floor. Filtering Type: `integer` ``` Eligible For: * hotel ``` freeWeights: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity has free weights. Filtering Type: `option` ``` Eligible For: * hotel ``` frequentlyAskedQuestions: description: |- A list of questions that are frequently asked about this entity Array must be ordered. Array may have a maximum of 100 elements. Filtering Type: `list of object` ``` Eligible For: * atm * event * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` uniqueItems: true type: array items: required: - question additionalProperties: false type: object properties: answer: minLength: 1 maxLength: 4096 type: string description: 'Filtering Type: `text`' question: minLength: 1 maxLength: 4096 type: string description: 'Filtering Type: `text`' description: 'Filtering Type: `object`' frontDesk: enum: - FRONT_DESK_AVAILABLE - FRONT_DESK_AVAILABLE_24_HOURS - NOT_APPLICABLE type: string description: |- Indicates whether the entity has a front desk. Filtering Type: `option` ``` Eligible For: * hotel ``` fullyVaccinatedStaff: type: boolean description: |- Indicates whether the staff is vaccinated against COVID-19. Filtering Type: `boolean` ``` Eligible For: * healthcareFacility * hotel * location * restaurant ``` gameRoom: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity has a game room. Filtering Type: `option` ``` Eligible For: * hotel ``` gender: enum: - UNSPECIFIED - FEMALE - MALE - NONBINARY - TRANSGENDER_FEMALE - TRANSGENDER_MALE - OTHER - PREFER_NOT_TO_DISCLOSE type: string description: |- The gender of the healthcare professional Filtering Type: `option` ``` Eligible For: * healthcareProfessional ``` geomodifier: minLength: 0 type: string description: |- Provides additional information on where the entity can be found (e.g., `Times Square`, `Global Center Mall`) Filtering Type: `text` ``` Eligible For: * atm * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` giftShop: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity has a gift shop. Filtering Type: `option` ``` Eligible For: * hotel ``` golf: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity has a golf couse on premise or nearby. The golf course may be independently run. Filtering Type: `option` ``` Eligible For: * hotel ``` googleAttributes: additionalProperties: false type: object properties: {} description: |- The unique IDs of the entity's Google Business Profile keywords, as well as the unique IDs of any values selected for each keyword. Valid keywords (e.g., `has_drive_through`, `has_fitting_room`, `kitchen_in_room`) are determined by the entity's primary category. A full list of keywords can be retrieved with the Google Fields: List endpoint. Keyword values provide more details on how the keyword applies to the entity (e.g., if the keyword is `has_drive_through`, its values may be `true` or `false`). * If the **`v`** parameter is before `20181204`: **`googleAttributes`** is formatted as a map of key-value pairs (e.g., `[{ "id": "has_wheelchair_accessible_entrance", "values": [ "true" ] }]`) * If the **`v`** parameter is on or after `20181204`: the contents are formatted as a list of objects (e.g., `{ "has_wheelchair_accessible_entrance": [ "true" ]}`) **NOTE:** The latest Google Attributes are available via the Google Fields: List endpoint. Google Attributes are managed by Google and are subject to change without notice. To prevent errors, make sure your API implementation is not dependent on the presence of specific attributes. Filtering Type: `object` ``` Eligible For: * atm * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` googleCoverPhoto: required: - url additionalProperties: false type: object description: |- The cover photo for the entity's Google profile Image must be at least 250 x 250 pixels Filtering Type: `object` ``` Eligible For: * atm * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` properties: alternateText: minLength: 0 type: string description: 'Filtering Type: `text`' url: minLength: 0 format: uri type: string description: 'Filtering Type: `text`' googleMessaging: additionalProperties: false type: object properties: smsNumber: minLength: 0 type: string description: |- The SMS phone number of the entity's point of contact for messaging/ chat functionality. Must be a valid phone number. If the phone number's calling code is for a country other than the one given in the entity's countryCode, the phone number provided must contain the calling code (e.g., +44 in +442038083831). Otherwise, the calling code is optional. Filtering Type: `text` whatsappMessagingUrl: minLength: 0 maxLength: 2000 format: uri type: string description: |- A valid URL for this entity's WhatsApp account. Must be a valid URL Filtering Type: `text` description: |- Information about Google Messaging, WhatsApp and SMS, for the entity’s point of contact for messaging/chat functionality. NOTE: Only one, either WhatsApp or SMS is displayed on the Google listing. If both SMS Number and WhatsApp URL are provided only SMS Number will be displayed on the listing. Filtering Type: `object` ``` Eligible For: * atm * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` googleMyBusinessLabels: description: |- Google Business Profile Labels help users organize their locations into groups within GBP. Array must be ordered. Array may have a maximum of 10 elements. Array item description: >Cannot Include: >* HTML markup Filtering Type: `list of text` ``` Eligible For: * atm * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` uniqueItems: true type: array items: minLength: 0 maxLength: 50 type: string description: |- Cannot Include: * HTML markup Filtering Type: `text` googlePlaceId: minLength: 0 type: string description: |- The unique identifier of this entity on Google Maps. Filtering Type: `text` ``` Eligible For: * atm * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` googleProfilePhoto: required: - url additionalProperties: false type: object description: |- The profile photo for the entity's Google profile Image must be at least 250 x 250 pixels Image may be no more than 5000 x 5000 pixels Supported Aspect Ratios: * 1 x 1 **NOTE**: Maximum image size is 5mb after normalization and padding (if applicable). As well, there is a 6 second download limit from the image host. Filtering Type: `object` ``` Eligible For: * atm * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` properties: alternateText: minLength: 0 type: string description: 'Filtering Type: `text`' url: minLength: 0 format: uri type: string description: 'Filtering Type: `text`' googleWebsiteOverride: minLength: 0 format: uri type: string description: |- 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. Filtering Type: `text` ``` Eligible For: * atm * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` happyHours: additionalProperties: false type: object properties: friday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the happy hours are "closed" on Friday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity's happy hours on Friday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' holidayHours: description: |- **NOTE:** The list of Holiday Hours that you send us must be comprehensive. For example, if you send us a list of Holiday Hours that does not include Holiday Hours that you sent in your last update, Yext considers the missing Holiday Hours to be deleted, and we remove them. Array must be ordered. Filtering Type: `list of object` uniqueItems: true type: array items: required: - date additionalProperties: false type: object properties: date: format: date type: string description: |- Date on which the holiday hours will be in effect. Cannot be in the past. Date must be on or after 1970-01-01 Date must be before or on 2038-01-01 Filtering Type: `date` isClosed: type: boolean description: |- Indicates if the happy hours are "closed" on on the given date. Filtering Type: `boolean` isRegularHours: type: boolean description: |- Indicates whether the holiday hours are the same as the regular business hours for the given date. If set to true, we will update the holiday hours if the regular business hours change for the date's day of the week. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for the Entity's happy hours on the specified date. Filtering Type: `list of object` description: 'Filtering Type: `object`' monday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the happy hours are "closed" on Monday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for the Entity's happy hours on Monday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' reopenDate: format: date type: string description: |- Date must be on or after 1970-01-01 Date must be before or on 2038-01-01 Filtering Type: `date` saturday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the happy hours are "closed" on Saturday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for the Entity's happy hours on Saturday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' sunday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the happy hours are "closed" on Sunday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for the Entity's happy hours on Sunday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' thursday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the happy hours are "closed" on Thursday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for the Entity's happy hours on Thursday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' tuesday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the happy hours are "closed" on Tuesday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for the Entity's happy hours on Tuesday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' wednesday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the happy hours are "closed" on Wednesday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for the Entity's happy hours on Wednesday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' description: |- Contains the daily happy hours, holiday happy hours, and reopen date for the Entity. Each day is represented by a sub-field of `happyHours`. (e.g. `monday`, `tuesday`, etc.) Open times can be specified per day through the `openIntervals` field and the `isClosed` flag. Similarly, holiday happy hours are represented by the `holidayHours` sub-field. Setting the `reopenDate` sub-field indicates that the business is temporarily closed and will reopen on the specified date. SPECIAL CASES: * To indicate that an Entity is open 24 hours on a specific day, set start to 00:00 and end to 23:59 in `openIntervals` for that day. * To indicate that an Entity has split hours on a specific day (e.g., open from 9:00 AM to 12:00 PM and again from 1:00 PM to 5:00 PM), supply two or more `openIntervals` values with non-overlapping sets of hours. * If you are providing `openIntervals`, you may not set `isClosed` to true for that day. Filtering Type: `hours` ``` Eligible For: * hotel * location * restaurant ``` headshot: required: - url additionalProperties: false type: object description: |- A portrait of the healthcare professional Filtering Type: `object` ``` Eligible For: * contactCard * financialProfessional * healthcareProfessional ``` properties: alternateText: minLength: 0 type: string description: 'Filtering Type: `text`' url: minLength: 0 format: uri type: string description: 'Filtering Type: `text`' hiringOrganization: minLength: 0 type: string description: |- The organization that is hiring for the open job Filtering Type: `text` ``` Eligible For: * job ``` holidayHoursConversationEnabled: type: boolean description: |- Indicates whether holiday-hour confirmation alerts are enabled for the Yext Knowledge Assistant for this entity Filtering Type: `boolean` ``` Eligible For: * atm * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` horsebackRiding: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity offers horseback riding. Filtering Type: `option` ``` Eligible For: * hotel ``` hotTub: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity has a hot tub. Filtering Type: `option` ``` Eligible For: * hotel ``` hours: additionalProperties: false type: object properties: friday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the hours of operation are "closed" on Friday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is open on Friday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' holidayHours: description: |- **NOTE:** The list of Holiday Hours that you send us must be comprehensive. For example, if you send us a list of Holiday Hours that does not include Holiday Hours that you sent in your last update, Yext considers the missing Holiday Hours to be deleted, and we remove them. Array must be ordered. Filtering Type: `list of object` uniqueItems: true type: array items: required: - date additionalProperties: false type: object properties: date: format: date type: string description: |- Date on which the holiday hours will be in effect. Cannot be in the past. Date must be on or after 1970-01-01 Date must be before or on 2038-01-01 Filtering Type: `date` isClosed: type: boolean description: |- Indicates if the hours of operation are "closed" on on the given date. Filtering Type: `boolean` isRegularHours: type: boolean description: |- Indicates whether the holiday hours are the same as the regular business hours for the given date. If set to true, we will update the holiday hours if the regular business hours change for the date's day of the week. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is open on the specified date. Filtering Type: `list of object` description: 'Filtering Type: `object`' monday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the hours of operation are "closed" on Monday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is open on Monday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' reopenDate: format: date type: string description: |- Date must be on or after 1970-01-01 Date must be before or on 2038-01-01 Filtering Type: `date` saturday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the hours of operation are "closed" on Saturday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is open on Saturday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' sunday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the hours of operation are "closed" on Sunday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is open on Sunday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' thursday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the hours of operation are "closed" on Thursday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is open on Thursday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' tuesday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the hours of operation are "closed" on Tuesday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is open on Tuesday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' wednesday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the hours of operation are "closed" on Wednesday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is open on Wednesday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' description: |- Contains the daily hours, holiday hours, and reopen date for the Entity. Each day is represented by a sub-field of `hours`. (e.g. `monday`, `tuesday`, etc.) Open times can be specified per day through the `openIntervals` field and the `isClosed` flag. Similarly, holiday hours are represented by the `holidayHours` sub-field. Setting the `reopenDate` sub-field indicates that the business is temporarily closed and will reopen on the specified date. SPECIAL CASES: * To indicate that an Entity is open 24 hours on a specific day, set start to 00:00 and end to 23:59 in `openIntervals` for that day. * To indicate that an Entity has split hours on a specific day (e.g., open from 9:00 AM to 12:00 PM and again from 1:00 PM to 5:00 PM), supply two or more `openIntervals` values with non-overlapping sets of hours. * If you are providing `openIntervals`, you may not set `isClosed` to true for that day. Filtering Type: `hours` ``` Eligible For: * atm * contactCard * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` housekeeping: enum: - HOUSEKEEPING_AVAILABLE - HOUSEKEEPING_AVAILABLE_DAILY - NOT_APPLICABLE type: string description: |- Indicates whether the entity offers housekeeping services. Filtering Type: `option` ``` Eligible For: * hotel ``` impressum: minLength: 0 maxLength: 2000 type: string description: |- A statement of the ownership and authorship of a document. Individuals or organizations based in many German-speaking countries are required by law to include an Impressum in published media. Filtering Type: `text` ``` Eligible For: * atm * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` indoorPoolCount: multipleOf: 1 minimum: 0 type: number description: |- A count of the number of indoor pools Filtering Type: `integer` ``` Eligible For: * hotel ``` instagramHandle: minLength: 0 maxLength: 30 type: string description: |- Valid Instagram username for the entity without the leading "@" (e.g., `NewCityAuto`) Filtering Type: `text` ``` Eligible For: * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * organization * restaurant ``` insuranceAccepted: description: |- A list of insurance policies accepted by the healthcare provider Array must be ordered. Array may have a maximum of 100 elements. Array item description: >Cannot Include: >* HTML markup Filtering Type: `list of text` ``` Eligible For: * healthcareFacility * healthcareProfessional ``` uniqueItems: true type: array items: minLength: 0 maxLength: 100 type: string description: |- Cannot Include: * HTML markup Filtering Type: `text` iosAppUrl: minLength: 0 type: string description: |- The URL where consumers can download the entity's app to their iPhone or iPad Filtering Type: `text` ``` Eligible For: * brand * financialProfessional * hotel * location * restaurant ``` isClusterPrimary: type: boolean description: |- Indicates whether the healthcare entity is the primary entity in its group Filtering Type: `boolean` ``` Eligible For: * healthcareProfessional ``` isFreeEvent: type: boolean description: |- Indicates whether or not the event is free Filtering Type: `boolean` ``` Eligible For: * event ``` isoRegionCode: minLength: 0 type: string description: |- The ISO 3166-2 region code for the entity Yext will determine the entity's code and update **`isoRegionCode`** with that value. If Yext is unable to determine the code for the entity, the entity'ss ISO 3166-1 alpha-2 country code will be used. Filtering Type: `text` ``` Eligible For: * atm * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` keywords: description: |- Keywords that describe the entity. All strings must be non-empty when trimmed of whitespace. Array must be ordered. Array may have a maximum of 100 elements. Array item description: >Cannot Include: >* HTML markup Filtering Type: `list of text` ``` Eligible For: * atm * card * event * faq * financialProfessional * healthcareFacility * healthcareProfessional * helpArticle * hotel * job * location * product * restaurant ``` uniqueItems: true type: array items: minLength: 0 maxLength: 100 type: string description: |- Cannot Include: * HTML markup Filtering Type: `text` kidFriendly: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates if the entity is kid friendly. Filtering Type: `option` ``` Eligible For: * hotel ``` kidsClub: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates if the property has a Kids Club. Filtering Type: `option` ``` Eligible For: * hotel ``` kidsStayFree: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity allows kids to stay free. Filtering Type: `option` ``` Eligible For: * hotel ``` kitchenHours: additionalProperties: false type: object properties: friday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the kitchen hours are "closed" on Friday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity's kitchen is open on Friday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' holidayHours: description: |- **NOTE:** The list of Holiday Hours that you send us must be comprehensive. For example, if you send us a list of Holiday Hours that does not include Holiday Hours that you sent in your last update, Yext considers the missing Holiday Hours to be deleted, and we remove them. Array must be ordered. Filtering Type: `list of object` uniqueItems: true type: array items: required: - date additionalProperties: false type: object properties: date: format: date type: string description: |- Date on which the holiday hours will be in effect. Cannot be in the past. Date must be on or after 1970-01-01 Date must be before or on 2038-01-01 Filtering Type: `date` isClosed: type: boolean description: |- Indicates if the kitchen hours are "closed" on on the given date. Filtering Type: `boolean` isRegularHours: type: boolean description: |- Indicates whether the holiday hours are the same as the regular business hours for the given date. If set to true, we will update the holiday hours if the regular business hours change for the date's day of the week. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity's kitchen is open on the specified date. Filtering Type: `list of object` description: 'Filtering Type: `object`' monday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the kitchen hours are "closed" on Monday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity's kitchen is open on Monday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' reopenDate: format: date type: string description: |- Date must be on or after 1970-01-01 Date must be before or on 2038-01-01 Filtering Type: `date` saturday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the kitchen hours are "closed" on Saturday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity's kitchen is open on Saturday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' sunday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the kitchen hours are "closed" on Sunday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity's kitchen is open on Sunday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' thursday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the kitchen hours are "closed" on Thursday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity's kitchen is open on Thursday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' tuesday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the kitchen hours are "closed" on Tuesday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity's kitchen open on Tuesday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' wednesday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the kitchen hours are "closed" on Wednesday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity's kitchen is open on Wednesday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' description: |- Contains the daily kitchen hours, holiday kitchen hours, and reopen date for the Entity. Each day is represented by a sub-field of `kitchenHours`. (e.g. `monday`, `tuesday`, etc.) Open times can be specified per day through the `openIntervals` field and the `isClosed` flag. Similarly, holiday kitchen hours are represented by the `holidayHours` sub-field. Setting the `reopenDate` sub-field indicates that the business is temporarily closed and will reopen on the specified date. SPECIAL CASES: * To indicate that an Entity is open 24 hours on a specific day, set start to 00:00 and end to 23:59 in `openIntervals` for that day. * To indicate that an Entity has split hours on a specific day (e.g., open from 9:00 AM to 12:00 PM and again from 1:00 PM to 5:00 PM), supply two or more `openIntervals` values with non-overlapping sets of hours. * If you are providing `openIntervals`, you may not set `isClosed` to true for that day. Filtering Type: `hours` ``` Eligible For: * hotel * location * restaurant ``` labels: uniqueItems: false type: array items: minLength: 0 type: string description: |- The IDs of the entity labels that have been added to this entity. Entity labels help you identify entities that share a certain characteristic; they do not appear on your entity'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. Filtering Type: `opaque` ``` Eligible For: * atm * board * brand * card * contactCard * event * faq * financialProfessional * healthcareFacility * healthcareProfessional * helpArticle * hotel * hotelRoomType * job * location * organization * product * restaurant ``` landingPageUrl: minLength: 0 format: uri type: string description: |- The URL of this entity's Landing Page that was created with Yext Pages Filtering Type: `text` ``` Eligible For: * atm * card * event * faq * financialProfessional * healthcareFacility * healthcareProfessional * helpArticle * hotel * job * location * product * restaurant ``` languages: description: |- The langauges in which consumers can commicate with this entity or its staff members All strings must be non-empty when trimmed of whitespace. Array must be ordered. Array may have a maximum of 100 elements. Array item description: >Cannot Include: >* HTML markup Filtering Type: `list of text` ``` Eligible For: * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` uniqueItems: true type: array items: minLength: 0 maxLength: 100 type: string description: |- Cannot Include: * HTML markup Filtering Type: `text` lastName: minLength: 0 maxLength: 35 type: string description: |- The last name of the healthcare professional Cannot Include: * a URL or domain name * HTML markup Filtering Type: `text` ``` Eligible For: * healthcareProfessional ``` laundry: enum: - FULL_SERVICE - SELF_SERVICE - NOT_APPLICABLE type: string description: |- Indicates whether the entity offers laundry services. Filtering Type: `option` ``` Eligible For: * hotel ``` lazyRiver: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates if the property has a lazy river Filtering Type: `option` ``` Eligible For: * hotel ``` lifeguard: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates if the property has a lifeguard on duty Filtering Type: `option` ``` Eligible For: * hotel ``` linkedInUrl: minLength: 0 format: uri type: string description: |- URL for your LinkedIn account, format should be https://www.linkedin.com/in/yourUsername Filtering Type: `text` ``` Eligible For: * contactCard * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * organization * restaurant ``` linkedLocation: type: string description: |- location ID of the event location, if the event is held at a location managed in the Yext Knowledge Manager Filtering Type: `entityId` ``` Eligible For: * contactCard * event ``` localPhone: minLength: 0 type: string description: |- Must be a valid, non-toll-free phone number, based on the country specified in **`address.region`**. Phone numbers for US entities must contain 10 digits. Filtering Type: `text` ``` Eligible For: * atm * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` localShuttle: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity offers local shuttle services. Filtering Type: `option` ``` Eligible For: * hotel ``` locatedIn: type: string description: |- For atms, the external ID of the entity that the atm is installed in. The entity must be in the same business account as the atm. Filtering Type: `entityId` ``` Eligible For: * atm ``` location: additionalProperties: false type: object properties: existingLocation: type: string description: |- A location entity referenced by Yext ID or Entity ID where this job opening exists Filtering Type: `entityId` externalLocation: minLength: 0 maxLength: 255 type: string description: |- A location string where this job opening exists Cannot Include: * a URL or domain name * HTML markup Filtering Type: `text` description: |- The location where this job opening exists as either an existing location or an external location Filtering Type: `object` ``` Eligible For: * job ``` locationType: enum: - LOCATION - HEALTHCARE_FACILITY - HEALTHCARE_PROFESSIONAL - ATM - RESTAURANT - HOTEL type: string description: |- Indicates the entity's type, if it is not an event Filtering Type: `option` ``` Eligible For: * atm * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` logo: required: - image additionalProperties: false type: object description: |- An image of the entity's logo Supported Aspect Ratios: * 1 x 1 **NOTE**: Maximum image size is 5mb after normalization and padding (if applicable). As well, there is a 6 second download limit from the image host. Filtering Type: `object` ``` Eligible For: * atm * contactCard * faq * financialProfessional * healthcareFacility * healthcareProfessional * hotel * job * location * organization * restaurant ``` properties: clickthroughUrl: minLength: 0 format: uri type: string description: 'Filtering Type: `text`' description: minLength: 0 type: string description: 'Filtering Type: `text`' details: minLength: 0 type: string description: 'Filtering Type: `text`' image: required: - url additionalProperties: false type: object description: |- Supported Aspect Ratios: * 1 x 1 **NOTE**: Maximum image size is 5mb after normalization and padding (if applicable). As well, there is a 6 second download limit from the image host. Filtering Type: `object` properties: alternateText: minLength: 0 type: string description: 'Filtering Type: `text`' url: minLength: 0 format: uri type: string description: 'Filtering Type: `text`' mainPhone: minLength: 0 type: string description: |- The main phone number of the entity's point of contact Must be a valid phone number. If the phone number's calling code is for a country other than the one given in the entity's **`countryCode`**, the phone number provided must contain the calling code (e.g., `+44` in `+442038083831`). Otherwise, the calling code is optional. Filtering Type: `text` ``` Eligible For: * atm * contactCard * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * organization * restaurant ``` massage: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity offers massage services. Filtering Type: `option` ``` Eligible For: * hotel ``` maxAgeOfKidsStayFree: multipleOf: 1 minimum: 0 type: number description: |- The maximum age specified by the property for children to stay in the room/suite of a parent or adult without an additional fee Filtering Type: `integer` ``` Eligible For: * hotel ``` maxNumberOfKidsStayFree: multipleOf: 1 minimum: 0 type: number description: |- The maximum number of children who can stay in the room/suite of a parent or adult without an additional fee Filtering Type: `integer` ``` Eligible For: * hotel ``` mealsServed: uniqueItems: true type: array items: enum: - BREAKFAST - LUNCH - BRUNCH - DINNER - HAPPY_HOUR - LATE_NIGHT type: string description: 'Filtering Type: `option`' description: |- Types of meals served at this restaurant Filtering Type: `list of option` ``` Eligible For: * restaurant ``` meetingRoomCount: multipleOf: 1 minimum: 0 type: number description: |- The number of meeting rooms the entity has. Filtering Type: `integer` ``` Eligible For: * hotel ``` menuUrl: additionalProperties: false type: object properties: displayUrl: minLength: 0 maxLength: 2000 format: uri type: string description: |- The URL that is shown on your listings in place of **`menuUrl.url`**. You can use **`menuUrl.displayUrl`** to display a short, memorable web address that redirects consumers to the URL given in **`menuUrl.url`**. Filtering Type: `text` preferDisplayUrl: type: boolean description: |- If set to true, only the display URL will be sent to those publishers who do not support separate display and tracking URLs for this field. Filtering Type: `boolean` url: minLength: 0 maxLength: 2000 format: uri type: string description: |- A valid URL where consumers can view the entity's menu Filtering Type: `text` description: |- Information about the URL where consumers can view the entity's menu Filtering Type: `object` ``` Eligible For: * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` menus: additionalProperties: false type: object properties: ids: description: |- IDs of the Menu Lists associated with this entity Array must be ordered. Array may have a maximum of 40 elements. Filtering Type: `list of text` uniqueItems: true type: array items: minLength: 0 type: string description: 'Filtering Type: `text`' label: minLength: 0 maxLength: 30 type: string description: |- Label to be used for this entity's Menu Lists. This label will appear on your entity's listings. Filtering Type: `text` description: |- Information about the Menu Content Lists associated with this entity Filtering Type: `object` ``` Eligible For: * hotel * location * restaurant ``` middleName: minLength: 0 maxLength: 35 type: string description: |- The middle name of the healthcare professional Cannot Include: * a URL or domain name * HTML markup Filtering Type: `text` ``` Eligible For: * healthcareProfessional ``` mobilePhone: minLength: 0 type: string description: |- Must be a valid phone number. If the phone number's calling code is for a country other than the one given in the entity's **`countryCode`**, the phone number provided must contain the calling code (e.g., `+44` in `+442038083831`). Otherwise, the calling code is optional. Filtering Type: `text` ``` Eligible For: * atm * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` mobilityAccessible: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity is mobility/wheelchair accessible Filtering Type: `option` ``` Eligible For: * hotel ``` nightclub: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity has a nightclub. Filtering Type: `option` ``` Eligible For: * hotel ``` npi: minLength: 0 type: string description: |- The National Provider Identifier (NPI) of the healthcare provider Filtering Type: `text` ``` Eligible For: * healthcareFacility * healthcareProfessional ``` nudgeEnabled: type: boolean description: |- Indicates whether Knowledge Nudge is enabled for the Yext Knowledge Assistant for this entity Filtering Type: `boolean` ``` Eligible For: * atm * faq * financialProfessional * healthcareFacility * healthcareProfessional * helpArticle * hotel * job * location * organization * product * restaurant ``` officeName: minLength: 0 type: string description: |- The name of the office where the healthcare professional works, if different from **`name`** Filtering Type: `text` ``` Eligible For: * healthcareProfessional ``` onlineServiceHours: additionalProperties: false type: object properties: friday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the online service hours are "closed" on Friday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for the Entity's online service hours on Friday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' holidayHours: description: |- **NOTE:** The list of Holiday Hours that you send us must be comprehensive. For example, if you send us a list of Holiday Hours that does not include Holiday Hours that you sent in your last update, Yext considers the missing Holiday Hours to be deleted, and we remove them. Array must be ordered. Filtering Type: `list of object` uniqueItems: true type: array items: required: - date additionalProperties: false type: object properties: date: format: date type: string description: |- Date on which the holiday hours will be in effect. Cannot be in the past. Date must be on or after 1970-01-01 Date must be before or on 2038-01-01 Filtering Type: `date` isClosed: type: boolean description: |- Indicates if the online service hours are "closed" on on the given date. Filtering Type: `boolean` isRegularHours: type: boolean description: |- Indicates whether the holiday hours are the same as the regular business hours for the given date. If set to true, we will update the holiday hours if the regular business hours change for the date's day of the week. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for the Entity's online service hours on the specified date. Filtering Type: `list of object` description: 'Filtering Type: `object`' monday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the online service hours are "closed" on Monday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for the Entity's online service hours on Monday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' reopenDate: format: date type: string description: |- Date must be on or after 1970-01-01 Date must be before or on 2038-01-01 Filtering Type: `date` saturday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the online service hours are "closed" on Saturday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for the Entity's online service hours on Saturday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' sunday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the online service hours are "closed" on Sunday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for the Entity's online service hours on Sunday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' thursday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the online service hours are "closed" on Thursday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for the Entity's online service hours on Thursday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' tuesday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the online service hours are "closed" on Tuesday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for the Entity's online service hours on Tuesday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' wednesday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the online service hours are "closed" on Wednesday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for the Entity's online service hours on Wednesday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' description: |- Contains the daily online service hours, holiday online service hours, and reopen date for the Entity. Each day is represented by a sub-field of `onlineServiceHours`. (e.g. `monday`, `tuesday`, etc.) Open times can be specified per day through the `openIntervals` field and the `isClosed` flag. Similarly, holiday online service hours are represented by the `holidayHours` sub-field. Setting the `reopenDate` sub-field indicates that the business is temporarily closed and will reopen on the specified date. SPECIAL CASES: * To indicate that an Entity is open 24 hours on a specific day, set start to 00:00 and end to 23:59 in `openIntervals` for that day. * To indicate that an Entity has split hours on a specific day (e.g., open from 9:00 AM to 12:00 PM and again from 1:00 PM to 5:00 PM), supply two or more `openIntervals` values with non-overlapping sets of hours. * If you are providing `openIntervals`, you may not set `isClosed` to true for that day. Filtering Type: `hours` ``` Eligible For: * financialProfessional * healthcareFacility * healthcareProfessional * location * restaurant ``` openDate: format: date type: string description: |- The date that the entity is set to open for the first time. Must be formatted in YYYY-MM-DD format. Date must be on or after 1970-01-01 Date must be before or on 2038-01-01 Filtering Type: `date` ``` Eligible For: * atm * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` operatingCountries: uniqueItems: true type: array items: enum: - AD - AE - AF - AG - AI - AL - AM - AO - AR - AS - AT - AU - AW - AX - AZ - BA - BB - BD - BE - BF - BG - BH - BI - BJ - BL - BM - BN - BO - BQ - BR - BS - BT - BW - BY - BZ - CA - CD - CF - CG - CH - CI - CK - CL - CM - CN - CO - CR - CU - CV - CW - CY - CZ - DE - DJ - DK - DM - DO - DZ - EC - EE - EG - EH - ER - ES - ET - FI - FJ - FK - FM - FO - FR - GA - GB - GD - GE - GF - GG - GH - GI - GL - GM - GN - GP - GQ - GR - GT - GU - GW - GY - HK - HN - HR - HT - HU - ID - IE - IL - IM - IN - IQ - IR - IS - IT - JE - JM - JO - JP - KE - KG - KH - KI - KM - KN - KR - KW - KY - KZ - LA - LB - LC - LI - LK - LR - LS - LT - LU - LV - LY - MA - MC - MD - ME - MF - MG - MH - MK - ML - MM - MN - MO - MP - MQ - MR - MS - MT - MU - MV - MW - MX - MY - MZ - NA - NC - NE - NG - NI - NL - 'NO' - NP - NR - NZ - OM - PA - PE - PF - PG - PH - PK - PL - PM - PR - PS - PT - PW - PY - QA - RE - RO - RS - RU - RW - SA - SB - SC - SD - SE - SG - SH - SI - SJ - SK - SL - SM - SN - SO - SR - SS - ST - SV - SX - SY - SZ - TC - TD - TG - TH - TJ - TL - TM - TN - TO - TR - TT - TV - TW - TZ - UA - UG - US - UY - UZ - VA - VC - VE - VG - VI - VN - VU - WF - WS - XK - YE - YT - ZA - ZM - ZW type: string description: 'Filtering Type: `option`' description: |- The list of countries the business operates in Filtering Type: `list of option` ``` Eligible For: * organization ``` orderUrl: additionalProperties: false type: object properties: displayUrl: minLength: 0 maxLength: 2000 format: uri type: string description: |- The URL that is shown on your listings in place of **`orderUrl.url`**. You can use **`orderUrl.displayUrl`** to display a short, memorable web address that redirects consumers to the URL given in **`orderUrl.url`**. Filtering Type: `text` preferDisplayUrl: type: boolean description: |- If set to true, only the display URL will be sent to those publishers who do not support separate display and tracking URLs for this field. Filtering Type: `boolean` url: minLength: 0 maxLength: 2000 format: uri type: string description: |- A valid URL used to place an order at this entity Filtering Type: `text` description: |- Information about the URL used to place orders that will be fulfilled by the entity Filtering Type: `object` ``` Eligible For: * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` organizerEmail: minLength: 0 format: email type: string description: |- Point of contact for the event organizer (not to be published publicly) Filtering Type: `text` ``` Eligible For: * event ``` organizerName: minLength: 0 type: string description: |- Point of contact for the event organizer (not to be published publicly) Filtering Type: `text` ``` Eligible For: * event ``` organizerPhone: minLength: 0 type: string description: |- Point of contact for the event organizer (not to be published publicly) Filtering Type: `text` ``` Eligible For: * event ``` outdoorPoolCount: multipleOf: 1 minimum: 0 type: number description: |- The number of outdoor pools the entity has. Filtering Type: `integer` ``` Eligible For: * hotel ``` parking: enum: - PARKING_AVAILABLE - PARKING_AVAILABLE_FOR_FREE - NOT_APPLICABLE type: string description: |- Indicates whether the entity offers parking services. Filtering Type: `option` ``` Eligible For: * hotel ``` paymentOptions: uniqueItems: true type: array items: enum: - AFTERPAY - ALIPAY - AMERICANEXPRESS - ANDROIDPAY - APPLEPAY - ATM - ATMQUICK - BACS - BANCONTACT - BANKDEPOSIT - BANKPAY - BGO - BITCOIN - Bar - CARTASI - CASH - CCS - CHECK - CHEQUESVACANCES - CONB - CONTACTLESSPAYME - CVVV - DEBITCARD - DEBITNOTE - DINERSCLUB - DIRECTDEBIT - DISCOVER - ECKARTE - ECOCHEQUE - EKENA - EMV - FINANCING - GIFTCARD - GOPAY - HAYAKAKEN - HEBAG - IBOD - ICCARDS - ICOCA - ID - IDEAL - INCA - INVOICE - JCB - JCoinPay - JKOPAY - KITACA - KLA - KLARNA - LINEPAY - MAESTRO - MANACA - MASTERCARD - MIPAY - MONIZZE - MPAY - Manuelle Lastsch - Merpay - NANACO - NEXI - NIMOCA - OREM - PASMO - PAYBACKPAY - PAYBOX - PAYCONIQ - PAYPAL - PAYPAY - PAYSEC - PIN - POSTEPAY - QRCODE - QUICPAY - RAKUTENEDY - RAKUTENPAY - SAMSUNGPAY - SODEXO - SUGOCA - SUICA - SWISH - TICKETRESTAURANT - TOICA - TRAVELERSCHECK - TSCUBIC - TWINT - UNIONPAY - VEV - VISA - VISAELECTRON - VOB - VOUCHER - VPAY - WAON - WECHATPAY - WIRETRANSFER - Yucho Pay - ZELLE - auPay - dBarai - Überweisung type: string description: 'Filtering Type: `option`' description: |- The payment methods accepted by this entity Valid elements depend on the entity's country. Filtering Type: `list of option` ``` Eligible For: * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` performers: description: |- Performers at the event Array must be ordered. Array may have a maximum of 100 elements. Filtering Type: `list of text` ``` Eligible For: * event ``` uniqueItems: true type: array items: minLength: 0 maxLength: 100 type: string description: 'Filtering Type: `text`' petsAllowed: enum: - PETS_WELCOME - PETS_WELCOME_FOR_FREE - NOT_APPLICABLE - NOT_ALLOWED type: string description: |- Indicates if the entity is pet friendly. Filtering Type: `option` ``` Eligible For: * hotel ``` photoGallery: description: |- **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. Array must be ordered. Array may have a maximum of 500 elements. Array item description: >Supported Aspect Ratios: >* 1 x 1 >* 4 x 3 >* 3 x 2 >* 5 x 3 >* 16 x 9 >* 3 x 1 >* 2 x 3 >* 5 x 7 >* 4 x 5 >* 4 x 1 > >**NOTE**: Maximum image size is 5mb after normalization and padding (if applicable). As well, there is a 6 second download limit from the image host. > Filtering Type: `list of object` ``` Eligible For: * atm * event * financialProfessional * healthcareFacility * healthcareProfessional * hotel * hotelRoomType * location * organization * product * restaurant ``` uniqueItems: false type: array items: required: - image additionalProperties: false type: object description: |- Supported Aspect Ratios: * 1 x 1 * 4 x 3 * 3 x 2 * 5 x 3 * 16 x 9 * 3 x 1 * 2 x 3 * 5 x 7 * 4 x 5 * 4 x 1 **NOTE**: Maximum image size is 5mb after normalization and padding (if applicable). As well, there is a 6 second download limit from the image host. Filtering Type: `object` properties: clickthroughUrl: minLength: 0 format: uri type: string description: 'Filtering Type: `text`' description: minLength: 0 type: string description: 'Filtering Type: `text`' details: minLength: 0 type: string description: 'Filtering Type: `text`' image: required: - url additionalProperties: false type: object description: |- Supported Aspect Ratios: * 1 x 1 * 4 x 3 * 3 x 2 * 5 x 3 * 16 x 9 * 3 x 1 * 2 x 3 * 5 x 7 * 4 x 5 * 4 x 1 **NOTE**: Maximum image size is 5mb after normalization and padding (if applicable). As well, there is a 6 second download limit from the image host. Filtering Type: `object` properties: alternateText: minLength: 0 type: string description: 'Filtering Type: `text`' url: minLength: 0 format: uri type: string description: 'Filtering Type: `text`' pickupCoordinate: additionalProperties: false type: object properties: latitude: minimum: -90 maximum: 90 type: number description: 'Filtering Type: `float`' longitude: minimum: -180 maximum: 180 type: number description: 'Filtering Type: `float`' description: |- Coordinates of where consumers can be picked up at the entity, as provided by you Filtering Type: `object` ``` Eligible For: * atm * event * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` pickupHours: additionalProperties: false type: object properties: friday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the pickup hours are "closed" on Friday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is open for pickup on Friday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' holidayHours: description: |- **NOTE:** The list of Holiday Hours that you send us must be comprehensive. For example, if you send us a list of Holiday Hours that does not include Holiday Hours that you sent in your last update, Yext considers the missing Holiday Hours to be deleted, and we remove them. Array must be ordered. Filtering Type: `list of object` uniqueItems: true type: array items: required: - date additionalProperties: false type: object properties: date: format: date type: string description: |- Date on which the holiday hours will be in effect. Cannot be in the past. Date must be on or after 1970-01-01 Date must be before or on 2038-01-01 Filtering Type: `date` isClosed: type: boolean description: |- Indicates if the pickup hours are "closed" on on the given date. Filtering Type: `boolean` isRegularHours: type: boolean description: |- Indicates whether the holiday hours are the same as the regular business hours for the given date. If set to true, we will update the holiday hours if the regular business hours change for the date's day of the week. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is open for pickup on the specified date. Filtering Type: `list of object` description: 'Filtering Type: `object`' monday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the pickup hours are "closed" on Monday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is open for pickup on Monday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' reopenDate: format: date type: string description: |- Date must be on or after 1970-01-01 Date must be before or on 2038-01-01 Filtering Type: `date` saturday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the pickup hours are "closed" on Saturday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is open for pickup on Saturday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' sunday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the pickup hours are "closed" on Sunday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is open for pickup on Sunday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' thursday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the pickup hours are "closed" on Thursday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is open for pickup on Thursday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' tuesday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the pickup hours are "closed" on Tuesday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is open for pickup on Tuesday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' wednesday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the pickup hours are "closed" on Wednesday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is open for pickup on Wednesday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' description: |- Contains the daily pickup hours, holiday pickup hours, and reopen date for the Entity. Each day is represented by a sub-field of `pickupHours`. (e.g. `monday`, `tuesday`, etc.) Open times can be specified per day through the `openIntervals` field and the `isClosed` flag. Similarly, holiday pickup hours are represented by the `holidayHours` sub-field. Setting the `reopenDate` sub-field indicates that the business is temporarily closed and will reopen on the specified date. SPECIAL CASES: * To indicate that an Entity is open 24 hours on a specific day, set start to 00:00 and end to 23:59 in `openIntervals` for that day. * To indicate that an Entity has split hours on a specific day (e.g., open from 9:00 AM to 12:00 PM and again from 1:00 PM to 5:00 PM), supply two or more `openIntervals` values with non-overlapping sets of hours. * If you are providing `openIntervals`, you may not set `isClosed` to true for that day. Filtering Type: `hours` ``` Eligible For: * healthcareFacility * location * restaurant ``` pinterestUrl: minLength: 0 format: uri type: string description: |- URL for your Pinterest account, format should be https://www.pinterest.com/yourUsername Filtering Type: `text` ``` Eligible For: * contactCard * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * organization * restaurant ``` priceRange: enum: - UNSPECIFIED - ONE - TWO - THREE - FOUR type: string description: |- he typical price of products sold by this location, on a scale of 1 (low) to 4 (high) Filtering Type: `option` ``` Eligible For: * atm * healthcareFacility * healthcareProfessional * location * restaurant ``` primaryConversationContact: minLength: 0 type: string description: |- ID of the user who is the primary Knowledge Assistant contact for the entity Filtering Type: `option` ``` Eligible For: * atm * faq * financialProfessional * healthcareFacility * healthcareProfessional * helpArticle * hotel * job * location * organization * product * restaurant ``` privateBeach: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity has access to a private beach. Filtering Type: `option` ``` Eligible For: * hotel ``` privateCarService: enum: - PRIVATE_CAR_SERVICE - PRIVATE_CAR_SERVICE_FOR_FREE - NOT_APPLICABLE type: string description: |- Indicates whether the entity offers private car services. Filtering Type: `option` ``` Eligible For: * hotel ``` productLists: additionalProperties: false type: object properties: ids: description: |- IDs of the Products & Services Lists associated with this entity Array must be ordered. Array may have a maximum of 40 elements. Filtering Type: `list of text` uniqueItems: true type: array items: minLength: 0 type: string description: 'Filtering Type: `text`' label: minLength: 0 maxLength: 30 type: string description: |- Label to be used for this entity's Products & Services Lists. This label will appear on your entity's listings. Filtering Type: `text` description: |- Information about the Products & Services Content Lists associated with this entity Filtering Type: `object` ``` Eligible For: * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` products: description: |- Products sold by this entity All strings must be non-empty when trimmed of whitespace. Array must be ordered. Array may have a maximum of 100 elements. Array item description: >Cannot Include: >* HTML markup Filtering Type: `list of text` ``` Eligible For: * financialProfessional * location ``` uniqueItems: true type: array items: minLength: 0 maxLength: 100 type: string description: |- Cannot Include: * HTML markup Filtering Type: `text` questionsAndAnswers: type: boolean description: |- Indicates whether Yext Knowledge Assistant question-and-answer conversations are enabled for this entity Filtering Type: `boolean` ``` Eligible For: * atm * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * organization * restaurant ``` rankTrackingCompetitors: description: |- Information about the competitors whose search performance you would like to compare to your own Array must be ordered. Array may have a maximum of 5 elements. Filtering Type: `list of object` ``` Eligible For: * atm * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * organization * restaurant ``` uniqueItems: true type: array items: required: - name - website additionalProperties: false type: object properties: name: minLength: 0 maxLength: 100 type: string description: |- A name of a competitor Cannot Include: * HTML markup Filtering Type: `text` website: minLength: 0 maxLength: 255 format: uri type: string description: |- The business website of a competitor Cannot Include: * common domain names, e.g., google.com, youtube.com, etc. Filtering Type: `text` description: 'Filtering Type: `object`' rankTrackingEnabled: type: boolean description: |- Indicates whether Rank Tracking is enabled Filtering Type: `boolean` ``` Eligible For: * atm * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * organization * restaurant ``` rankTrackingFrequency: enum: - WEEKLY - MONTHLY - QUARTERLY type: string description: |- How often we send search queries to track your search performance Filtering Type: `option` ``` Eligible For: * atm * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * organization * restaurant ``` rankTrackingQueryTemplates: description: |- The ways in which your keywords will be arranged in the search queries we use to track your performance Array must have a minimum of 2 elements. Array may have a maximum of 4 elements. Filtering Type: `list of option` ``` Eligible For: * atm * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * organization * restaurant ``` uniqueItems: true type: array items: enum: - KEYWORD - KEYWORD_ZIP - KEYWORD_CITY - KEYWORD_IN_CITY - KEYWORD_NEAR_ME - KEYWORD_CITY_STATE type: string description: 'Filtering Type: `option`' rankTrackingSites: uniqueItems: true type: array items: enum: - GOOGLE_DESKTOP - GOOGLE_MOBILE - BING_DESKTOP - BING_MOBILE - YAHOO_DESKTOP - YAHOO_MOBILE type: string description: 'Filtering Type: `option`' description: |- The search engines that we will use to track your performance Filtering Type: `list of option` ``` Eligible For: * atm * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * organization * restaurant ``` reservationUrl: additionalProperties: false type: object properties: displayUrl: minLength: 0 maxLength: 2000 format: uri type: string description: |- The URL that is shown on your listings in place of **`reservationUrl.url`**. You can use **`reservationUrl.displayUrl`** to display a short, memorable web address that redirects consumers to the URL given in **`reservationUrl.url`**. Must be a valid URL and be specified along with **`reservationUrl.url`**. Filtering Type: `text` preferDisplayUrl: type: boolean description: |- If set to true, only the display URL will be sent to those publishers who do not support separate display and tracking URLs for this field. Filtering Type: `boolean` url: minLength: 0 maxLength: 2000 format: uri type: string description: |- A valid URL used to make reservations at this entity Filtering Type: `text` description: |- Information about the URL consumers can visit to make reservations at this entity Filtering Type: `object` ``` Eligible For: * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` restaurantCount: multipleOf: 1 minimum: 0 type: number description: |- The number of restaurants the entity has. Filtering Type: `integer` ``` Eligible For: * hotel ``` reviewGenerationUrl: minLength: 0 type: string description: |- The URL given Review Invitation emails where consumers can leave a review about the entity ``` Eligible For: * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` reviewResponseConversationEnabled: type: boolean description: |- Indicates whether Yext Knowledge Assistant review-response conversations are enabled for this entity Filtering Type: `boolean` ``` Eligible For: * atm * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` roomCount: multipleOf: 1 minimum: 0 type: number description: |- The number of rooms the entity has. Filtering Type: `integer` ``` Eligible For: * hotel ``` roomService: enum: - ROOM_SERVICE_AVAILABLE - ROOM_SERVICE_AVAILABLE_24_HOURS - NOT_APPLICABLE type: string description: |- Indicates whether the entity offers room service. Filtering Type: `option` ``` Eligible For: * hotel ``` routableCoordinate: additionalProperties: false type: object properties: latitude: minimum: -90 maximum: 90 type: number description: 'Filtering Type: `float`' longitude: minimum: -180 maximum: 180 type: number description: 'Filtering Type: `float`' description: |- Destination coordinates to use for driving directions to the entity, as provided by you Filtering Type: `object` ``` Eligible For: * atm * event * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` salon: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity has a salon. Filtering Type: `option` ``` Eligible For: * hotel ``` sauna: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity has a sauna. Filtering Type: `option` ``` Eligible For: * hotel ``` scuba: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity offers scuba diving. Filtering Type: `option` ``` Eligible For: * hotel ``` selfParking: enum: - SELF_PARKING_AVAILABLE - SELF_PARKING_AVAILABLE_FOR_FREE - NOT_APPLICABLE type: string description: |- Indicates whether the entity offers self parking services. Filtering Type: `option` ``` Eligible For: * hotel ``` seniorHours: additionalProperties: false type: object properties: friday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the senior hours are "closed" on Friday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for the Entity's senior hours on Friday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' holidayHours: description: |- **NOTE:** The list of Holiday Hours that you send us must be comprehensive. For example, if you send us a list of Holiday Hours that does not include Holiday Hours that you sent in your last update, Yext considers the missing Holiday Hours to be deleted, and we remove them. Array must be ordered. Filtering Type: `list of object` uniqueItems: true type: array items: required: - date additionalProperties: false type: object properties: date: format: date type: string description: |- Date on which the holiday hours will be in effect. Cannot be in the past. Date must be on or after 1970-01-01 Date must be before or on 2038-01-01 Filtering Type: `date` isClosed: type: boolean description: |- Indicates if the senior hours are "closed" on on the given date. Filtering Type: `boolean` isRegularHours: type: boolean description: |- Indicates whether the holiday hours are the same as the regular business hours for the given date. If set to true, we will update the holiday hours if the regular business hours change for the date's day of the week. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for the Entity's senior hours on the specified date. Filtering Type: `list of object` description: 'Filtering Type: `object`' monday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the senior hours are "closed" on Monday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for the Entity's senior hours on Monday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' reopenDate: format: date type: string description: |- Date must be on or after 1970-01-01 Date must be before or on 2038-01-01 Filtering Type: `date` saturday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the senior hours are "closed" on Saturday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for the Entity's senior hours on Saturday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' sunday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the senior hours are "closed" on Sunday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for the Entity's senior hours on Sunday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' thursday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the senior hours are "closed" on Thursday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for the Entity's senior hours on Thursday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' tuesday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the senior hours are "closed" on Tuesday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for the Entity's senior hours on Tuesday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' wednesday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the senior hours are "closed" on Wednesday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for the Entity's senior hours on Wednesday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' description: |- Contains the daily senior hours, holiday senior hours, and reopen date for the Entity. Each day is represented by a sub-field of `seniorHours`. (e.g. `monday`, `tuesday`, etc.) Open times can be specified per day through the `openIntervals` field and the `isClosed` flag. Similarly, holiday senior hours are represented by the `holidayHours` sub-field. Setting the `reopenDate` sub-field indicates that the business is temporarily closed and will reopen on the specified date. SPECIAL CASES: * To indicate that an Entity is open 24 hours on a specific day, set start to 00:00 and end to 23:59 in `openIntervals` for that day. * To indicate that an Entity has split hours on a specific day (e.g., open from 9:00 AM to 12:00 PM and again from 1:00 PM to 5:00 PM), supply two or more `openIntervals` values with non-overlapping sets of hours. * If you are providing `openIntervals`, you may not set `isClosed` to true for that day. Filtering Type: `hours` ``` Eligible For: * location * restaurant ``` serviceArea: additionalProperties: false type: object properties: places: description: |- A list of places served by the entity, where each place is either: - a postal code, or - the name of a city. Array must be ordered. Array may have a maximum of 200 elements. Filtering Type: `list of text` uniqueItems: true type: array items: minLength: 0 maxLength: 100 type: string description: 'Filtering Type: `text`' description: |- Information about the area that is served by this entity. It is specified as a list of cities and/or postal codes. **Only for Google Business Profile and Bing:** Currently, **serviceArea** is only supported by Google Business Profile and Bing and will not affect your listings on other sites. Filtering Type: `object` ``` Eligible For: * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` serviceAreaPlaces: description: |- Information about the area that is served by this entity. It is specified as a list of service area names, their associated types and google place ids. **Only for Google Business Profile and Bing:** Currently, **serviceArea** is only supported by Google Business Profile and Bing and will not affect your listings on other sites. Array may have a maximum of 200 elements. Filtering Type: `list of object` ``` Eligible For: * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` uniqueItems: true type: array items: additionalProperties: false type: object properties: name: minLength: 0 maxLength: 100 type: string description: 'Filtering Type: `text`' googlePlaceId: minLength: 0 type: string description: 'Filtering Type: `text`' type: enum: - POSTAL_CODE - REGION - COUNTY - CITY - SUBLOCALITY type: string description: 'Filtering Type: `option`' description: 'Filtering Type: `object`' services: description: |- Services offered by this entity All strings must be non-empty when trimmed of whitespace. Array must be ordered. Array may have a maximum of 100 elements. Array item description: >Cannot Include: >* HTML markup Filtering Type: `list of text` ``` Eligible For: * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` uniqueItems: true type: array items: minLength: 0 maxLength: 100 type: string description: |- Cannot Include: * HTML markup Filtering Type: `text` smokeFreeProperty: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates if the entity is smoke free. Filtering Type: `option` ``` Eligible For: * hotel ``` snorkeling: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity offers snorkeling. Filtering Type: `option` ``` Eligible For: * hotel ``` socialHour: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity offers a social hour. Filtering Type: `option` ``` Eligible For: * hotel ``` spa: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity has a spa. Filtering Type: `option` ``` Eligible For: * hotel ``` specialities: description: |- Up to 100 of this entity's specialities (e.g., for food and dining: `Chicago style`) All strings must be non-empty when trimmed of whitespace. Array must be ordered. Array may have a maximum of 100 elements. Array item description: >Cannot Include: >* HTML markup Filtering Type: `list of text` ``` Eligible For: * financialProfessional * location * restaurant ``` uniqueItems: true type: array items: minLength: 0 maxLength: 100 type: string description: |- Cannot Include: * HTML markup Filtering Type: `text` tableService: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity has a sit-down restaurant. Filtering Type: `option` ``` Eligible For: * hotel ``` takeoutHours: additionalProperties: false type: object properties: friday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the takeout hours are "closed" on Friday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is open for takeout on Friday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' holidayHours: description: |- **NOTE:** The list of Holiday Hours that you send us must be comprehensive. For example, if you send us a list of Holiday Hours that does not include Holiday Hours that you sent in your last update, Yext considers the missing Holiday Hours to be deleted, and we remove them. Array must be ordered. Filtering Type: `list of object` uniqueItems: true type: array items: required: - date additionalProperties: false type: object properties: date: format: date type: string description: |- Date on which the holiday hours will be in effect. Cannot be in the past. Date must be on or after 1970-01-01 Date must be before or on 2038-01-01 Filtering Type: `date` isClosed: type: boolean description: |- Indicates if the takeout hours are "closed" on on the given date. Filtering Type: `boolean` isRegularHours: type: boolean description: |- Indicates whether the holiday hours are the same as the regular business hours for the given date. If set to true, we will update the holiday hours if the regular business hours change for the date's day of the week. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is open for takeout on the specified date. Filtering Type: `list of object` description: 'Filtering Type: `object`' monday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the takeout hours are "closed" on Monday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is open for takeout on Monday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' reopenDate: format: date type: string description: |- Date must be on or after 1970-01-01 Date must be before or on 2038-01-01 Filtering Type: `date` saturday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the takeout hours are "closed" on Saturday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is open for takeout on Saturday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' sunday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the takeout hours are "closed" on Sunday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is open for takeout on Sunday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' thursday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the takeout hours are "closed" on Thursday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is open for takeout on Thursday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' tuesday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the takeout hours are "closed" on Tuesday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is open for takeout on Tuesday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' wednesday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the takeout hours are "closed" on Wednesday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is open for takeout on Wednesday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' description: |- Contains the daily takeout hours, holiday takeout hours, and reopen date for the Entity. Each day is represented by a sub-field of `takeoutHours`. (e.g. `monday`, `tuesday`, etc.) Open times can be specified per day through the `openIntervals` field and the `isClosed` flag. Similarly, holiday takeout hours are represented by the `holidayHours` sub-field. Setting the `reopenDate` sub-field indicates that the business is temporarily closed and will reopen on the specified date. SPECIAL CASES: * To indicate that an Entity is open 24 hours on a specific day, set start to 00:00 and end to 23:59 in `openIntervals` for that day. * To indicate that an Entity has split hours on a specific day (e.g., open from 9:00 AM to 12:00 PM and again from 1:00 PM to 5:00 PM), supply two or more `openIntervals` values with non-overlapping sets of hours. * If you are providing `openIntervals`, you may not set `isClosed` to true for that day. Filtering Type: `hours` ``` Eligible For: * location * restaurant ``` tennis: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity has tennis courts. Filtering Type: `option` ``` Eligible For: * hotel ``` thermalPool: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity has a thermal pool. Filtering Type: `option` ``` Eligible For: * hotel ``` ticketAvailability: enum: - IN_STOCK - SOLD_OUT - PRE_ORDER - UNSPECIFIED type: string description: |- Information about the availability of tickets for the event Filtering Type: `option` ``` Eligible For: * event ``` ticketPriceRange: additionalProperties: false type: object properties: currencyCode: minLength: 0 type: string description: |- Three letter currency code (ISO standard) Filtering Type: `text` maxValue: pattern: ^\d*\.?\d*$ type: string description: |- Maximum ticket price Filtering Type: `decimal` minValue: pattern: ^\d*\.?\d*$ type: string description: |- Minimum ticket price Filtering Type: `decimal` description: |- Contains the price range for the event Filtering Type: `object` ``` Eligible For: * event ``` ticketSaleDateTime: format: date-time type: string description: |- The date/time tickets are available for sale (local time) Filtering Type: `datetime` ``` Eligible For: * event ``` ticketUrl: minLength: 0 format: uri type: string description: |- URL to purchase tickets for the event (if ticketed) Filtering Type: `text` ``` Eligible For: * event ``` tikTokUrl: minLength: 0 format: uri type: string description: |- URL for your TikTok profile, format should be https://www.tiktok.com/yourUsername Filtering Type: `text` ``` Eligible For: * contactCard * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * organization * restaurant ``` time: additionalProperties: false type: object properties: end: format: date-time type: string description: |- End date/time of the event, in local time (see timezone field) Standard ISO 8601 datetime without timezone Format: `YYYY-MM-DDThh:mm` Filtering Type: `datetime` start: format: date-time type: string description: |- Start date/time of the event, in local time (see timezone field) Standard ISO 8601 datetime without timezone Format: `YYYY-MM-DDThh:mm` Filtering Type: `datetime` description: |- Contains the start/end times for the event Filtering Type: `object` ``` Eligible For: * event ``` timeZoneUtcOffset: minLength: 0 type: string description: |- Represents the time zone offset of the entity from UTC, in `±hh:mm` format. For example, if the entity is 4 hours ahead of UTC time, the offset will be `+04:00`. If the entity is 15.5 hours behind UTC time, the offset will be `-15:30`. If the entity is in UTC time, the offset will be `+00:00`. ``` Eligible For: * atm * event * faq * healthcareFacility * healthcareProfessional * hotel * job * location * restaurant ``` timezone: minLength: 0 type: string description: |- The timezone of the entity, in the standard `IANA time zone database` format (tz database). e.g. `"America/New_York"` Filtering Type: `option` ``` Eligible For: * atm * board * card * contactCard * event * faq * financialProfessional * healthcareFacility * healthcareProfessional * helpArticle * hotel * hotelRoomType * job * location * organization * product * restaurant ``` tollFreePhone: minLength: 0 type: string description: |- Must be a valid phone number. If the phone number's calling code is for a country other than the one given in the entity's **`countryCode`**, the phone number provided must contain the calling code (e.g., `+44` in `+442038083831`). Otherwise, the calling code is optional. Filtering Type: `text` ``` Eligible For: * atm * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` treadmill: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity has a treadmill. Filtering Type: `option` ``` Eligible For: * hotel ``` ttyPhone: minLength: 0 type: string description: |- Must be a valid phone number. If the phone number's calling code is for a country other than the one given in the entity's **`countryCode`**, the phone number provided must contain the calling code (e.g., `+44` in `+442038083831`). Otherwise, the calling code is optional. Filtering Type: `text` ``` Eligible For: * atm * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` turndownService: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity offers turndown service. Filtering Type: `option` ``` Eligible For: * hotel ``` twitterHandle: minLength: 0 maxLength: 15 type: string description: |- Valid Twitter handle for the entity without the leading "@" (e.g., `JohnSmith`) 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. Filtering Type: `text` ``` Eligible For: * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * organization * restaurant ``` uberLink: required: - presentation additionalProperties: false type: object properties: presentation: enum: - BUTTON - LINK type: string description: |- Indicates whether the embedded Uber link for this entity 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 entity set as the trip destination. If the Uber app is not installed, the consumer will be prompted to download it. Filtering Type: `option` text: minLength: 0 maxLength: 100 type: string description: |- The text of the embedded Uber link Default is `Ride there with Uber`. **NOTE:** This field is only available if **`uberLink.presentation`** is `LINK`. Filtering Type: `text` description: |- Information about the Yext-powered link that can be copied and pasted into the markup of Yext Pages where the embedded Uber link should appear Filtering Type: `object` ``` Eligible For: * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` uberTripBranding: required: - text - url - description additionalProperties: false type: object properties: description: minLength: 0 maxLength: 150 type: string description: |- A longer description that will appear near the call-to-action in the Uber app during a trip to your entity. **NOTE:** If a value for **`uberTripBranding.description`** is provided, values must also be provided for **`uberTripBranding.text`** and **`uberTripBranding.url`**. Filtering Type: `text` text: minLength: 0 maxLength: 28 type: string description: |- The text of the call-to-action that will appear in the Uber app during a trip to your entity (e.g., `Check out our menu!`) **NOTE:** If a value for **`uberTripBranding.text`** is provided, values must also be provided for **`uberTripBranding.url`** and **`uberTripBranding.description`**. Filtering Type: `text` url: minLength: 0 format: uri type: string description: |- 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 entity. **NOTE:** If a value for **`uberTripBranding.url`** is provided, values must also be provided for **`uberTripBranding.text`** and **`uberTripBranding.description`**. Filtering Type: `text` description: |- Information about the call-to-action consumers will see in the Uber app during a trip to your entity Filtering Type: `object` ``` Eligible For: * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` valetParking: enum: - VALET_PARKING_AVAILABLE - VALET_PARKING_AVAILABLE_FOR_FREE - NOT_APPLICABLE type: string description: |- Indicates whether the entity offers valet parking services. Filtering Type: `option` ``` Eligible For: * hotel ``` validThrough: format: date-time type: string description: |- The date this entity is valid through. Filtering Type: `datetime` ``` Eligible For: * job ``` vendingMachine: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity has a vending machine. Filtering Type: `option` ``` Eligible For: * hotel ``` venueName: minLength: 0 type: string description: |- Name of the venue where the event is being held Filtering Type: `text` ``` Eligible For: * event ``` videos: description: |- Valid YouTube URLs for embedding a video on some publisher sites **NOTE:** Currently, only the first URL in the Array appears in your listings. Array must be ordered. Filtering Type: `list of object` ``` Eligible For: * financialProfessional * healthcareFacility * healthcareProfessional * hotel * hotelRoomType * location * organization * product * restaurant ``` uniqueItems: true type: array items: required: - video additionalProperties: false type: object properties: description: minLength: 0 maxLength: 140 type: string description: |- Cannot Include: * HTML markup Filtering Type: `text` video: required: - url additionalProperties: false type: object properties: url: minLength: 0 format: uri type: string description: 'Filtering Type: `text`' description: 'Filtering Type: `object`' description: 'Filtering Type: `object`' wadingPool: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity has a wading pool. Filtering Type: `option` ``` Eligible For: * hotel ``` wakeUpCalls: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity offers wake up call services. Filtering Type: `option` ``` Eligible For: * hotel ``` walkableCoordinate: additionalProperties: false type: object properties: latitude: minimum: -90 maximum: 90 type: number description: 'Filtering Type: `float`' longitude: minimum: -180 maximum: 180 type: number description: 'Filtering Type: `float`' description: |- Destination coordinates to use for walking directions to the entity, as provided by you Filtering Type: `object` ``` Eligible For: * atm * event * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` waterPark: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity has a water park. Filtering Type: `option` ``` Eligible For: * hotel ``` waterSkiing: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity offers water skiing. Filtering Type: `option` ``` Eligible For: * hotel ``` watercraft: enum: - WATERCRAFT_RENTALS - WATERCRAFT_RENTALS_FOR_FREE - NOT_APPLICABLE type: string description: |- Indicates whether the entity offers any kind of watercrafts. Filtering Type: `option` ``` Eligible For: * hotel ``` waterslide: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity has a water slide. Filtering Type: `option` ``` Eligible For: * hotel ``` wavePool: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity has a wave pool. Filtering Type: `option` ``` Eligible For: * hotel ``` websiteUrl: additionalProperties: false type: object properties: displayUrl: minLength: 0 maxLength: 2000 format: uri type: string description: |- The URL that is shown on your listings in place of **`websiteUrl.url`**. You can use **`websiteUrl.displayUrl`** to display a short, memorable web address that redirects consumers to the URL given in **`websiteUrl.url`**. Must be a valid URL and be specified along with **`websiteUrl.url`**. Filtering Type: `text` preferDisplayUrl: type: boolean description: |- If set to true, only the display URL will be sent to those publishers who do not support separate display and tracking URLs for this field. Filtering Type: `boolean` url: minLength: 0 maxLength: 2000 format: uri type: string description: |- A valid URL for this entity's website Filtering Type: `text` description: |- Information about the website for this entity Filtering Type: `object` ``` Eligible For: * atm * contactCard * event * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * organization * restaurant ``` weightMachine: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity has a weight machine. Filtering Type: `option` ``` Eligible For: * hotel ``` wheelchairAccessible: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates if the entity is wheelchair accessible. Filtering Type: `option` ``` Eligible For: * hotel ``` wifiAvailable: enum: - WIFI_AVAILABLE - WIFI_AVAILABLE_FOR_FREE - NOT_APPLICABLE type: string description: |- Indicates whether the entity has WiFi available Filtering Type: `option` ``` Eligible For: * hotel ``` workRemote: type: boolean description: |- Indicates whether the job is remote. Filtering Type: `boolean` ``` Eligible For: * job ``` yearEstablished: multipleOf: 1 minimum: 1000 maximum: 2028 type: number description: |- The year the entity was established. Filtering Type: `integer` ``` Eligible For: * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` yearLastRenovated: multipleOf: 1 minimum: 1000 maximum: 2028 type: number description: |- The most recent year the entity was partially or completely renovated. Filtering Type: `integer` ``` Eligible For: * hotel ``` yextDisplayCoordinate: additionalProperties: false type: object properties: latitude: minimum: -90 maximum: 90 type: number description: 'Filtering Type: `float`' longitude: minimum: -180 maximum: 180 type: number description: 'Filtering Type: `float`' description: |- Coordinates where the map pin for the entity should be displayed, as calculated by Yext Filtering Type: `object` ``` Eligible For: * atm * event * financialProfessional * healthcareFacility * healthcareProfessional * hotel * job * location * restaurant ``` yextDropoffCoordinate: additionalProperties: false type: object properties: latitude: minimum: -90 maximum: 90 type: number description: 'Filtering Type: `float`' longitude: minimum: -180 maximum: 180 type: number description: 'Filtering Type: `float`' description: |- Coordinates of where consumers can be dropped off at the entity, as calculated by Yext Filtering Type: `object` ``` Eligible For: * atm * event * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` yextPickupCoordinate: additionalProperties: false type: object properties: latitude: minimum: -90 maximum: 90 type: number description: 'Filtering Type: `float`' longitude: minimum: -180 maximum: 180 type: number description: 'Filtering Type: `float`' description: |- Coordinates of where consumers can be picked up at the entity, as calculated by Yext Filtering Type: `object` ``` Eligible For: * atm * event * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` yextRoutableCoordinate: additionalProperties: false type: object properties: latitude: minimum: -90 maximum: 90 type: number description: 'Filtering Type: `float`' longitude: minimum: -180 maximum: 180 type: number description: 'Filtering Type: `float`' description: |- Destination coordinates to use for driving directions to the entity, as calculated by Yext Filtering Type: `object` ``` Eligible For: * atm * event * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` yextWalkableCoordinate: additionalProperties: false type: object properties: latitude: minimum: -90 maximum: 90 type: number description: 'Filtering Type: `float`' longitude: minimum: -180 maximum: 180 type: number description: 'Filtering Type: `float`' description: |- Destination coordinates to use for walking directions to the entity, as calculated by Yext Filtering Type: `object` ``` Eligible For: * atm * event * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` youTubeChannelUrl: minLength: 0 format: uri type: string description: |- URL for your YouTube channel, format should be https://www.youtube.com/c/yourUsername Filtering Type: `text` ``` Eligible For: * contactCard * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * organization * restaurant ``` pageToken: minLength: 0 type: string description: | Pass this value into the next request as the **`pageToken`** parameter to retrieve the next page of data. If the response of a request contains the last page of data, a **`pageToken`** value will not be returned. A **`pageToken`** will never appear in the response if the request contains the **`sortOrder`**, **`randomization`**, or **`randomizationToken`** parameters. headers: {} '400': description: Error Response content: application/json: schema: additionalProperties: false type: object properties: meta: additionalProperties: false type: object properties: errors: uniqueItems: false type: array items: additionalProperties: false type: object properties: code: multipleOf: 1 type: number description: | Code that uniquely identifies the error or warning. message: minLength: 0 type: string description: Message explaining the problem. type: enum: - FATAL_ERROR - NON_FATAL_ERROR - WARNING type: string description: List of errors and warnings. uuid: minLength: 0 type: string description: 'Filtering Type: `object`' headers: {} /accounts/{accountId}/entities/{entityId}: get: operationId: getEntity parameters: - schema: minLength: 0 type: string name: accountId in: path required: true - schema: minLength: 0 type: string description: The external ID of the requested Entity name: entityId in: path required: true - schema: minLength: 0 type: string description: A date in `YYYYMMDD` format. name: v in: query required: true - schema: minLength: 0 type: string description: | Optional parameter to return fields of type **Markdown** as HTML. - `false`: **Markdown** fields will be returned as JSON - `true`: **Markdown** fields will be returned as HTML name: convertMarkdownToHTML in: query required: false - schema: minLength: 0 type: string description: | Optional parameter to return fields of type **Rich Text** as HTML. - `false`: **Rich Text** fields will be returned as JSON - `true`: **Rich Text** fields will be returned as HTML name: convertRichTextToHTML in: query required: false - schema: minLength: 0 type: string description: Comma-separated list of field names. When present, only the fields listed will be returned. You can use dot notation to specify substructures (e.g., `"address.line1"`). Custom fields are specified in the same way, albeit with their `c_*` name. name: fields in: query required: false - schema: minLength: 0 type: string default: markdown description: | Present if and only if at least one field is of type "**Legacy Rich Text**." Valid values: * `markdown` * `html` * `none` name: format in: query required: false tags: - Live API summary: 'Entities: Get' description: | Retrieve information for an Entity with a given ID **NOTE:** Responses will contain resolved values for embedded fields responses: '200': description: Success Response content: application/json: schema: additionalProperties: false type: object properties: meta: additionalProperties: false type: object properties: uuid: minLength: 0 type: string description: Unique ID for this request / response. response: additionalProperties: false type: object properties: meta: additionalProperties: false type: object properties: accountId: minLength: 0 type: string description: ID of the account associated with this Entity countryCode: minLength: 0 type: string description: |- Country code of this Entity's Language Profile (defaults to the country of the account) Filtering Type: `text` createdTimestamp: minLength: 0 type: string description: The timestamp of when the entity record was created. entityType: minLength: 0 type: string description: |- This Entity's type (e.g., location, event) Filtering Type: `text` folderId: minLength: 0 type: string description: |- The ID of the folder containing this Entity Filtering Type: `text` id: minLength: 0 type: string description: |- ID of this Entity Filtering Type: `text` labels: uniqueItems: false type: array items: minLength: 0 type: string description: 'Filtering Type: `text`' description: |- This Entity's labels. If the **`v`** parameter is before `20211215`, this will be an integer. Filtering Type: `list of text` language: minLength: 0 type: string description: |- Language code of this Entity's Language Profile (defaults to the language code of the account) Filtering Type: `text` timestamp: minLength: 0 type: string description: | The timestamp of the most recent change to this entity record. Will be ignored when the client is saving entity data to Yext. **NOTE:** The timestamp may change even if observable fields stay the same. uid: minLength: 0 type: string description: | The internal ID of the entity. This UID is a static, globally unique ID. Note that this value cannot be used in place of id in API calls to retrieve or edit Entity information. If the v param is before `20221206`, the returned value will be a hashed version of the entity UID (aka internal ID of the entity). description: |- Contains the metadata about the entity. ``` Eligible For: * atm * event * faq * healthcareFacility * healthcareProfessional * hotel * job * location * restaurant ``` name: minLength: 0 maxLength: 5000 type: string description: |- Cannot Include: * HTML markup Filtering Type: `text` ``` Eligible For: * atm * board * brand * card * contactCard * event * faq * financialProfessional * healthcareFacility * healthcareProfessional * helpArticle * hotel * hotelRoomType * job * location * organization * product * restaurant ``` address: additionalProperties: false type: object properties: city: minLength: 0 maxLength: 255 type: string description: |- The city the entity (or the entity's location) is in Cannot Include: * a URL or domain name Filtering Type: `text` countryCode: minLength: 0 pattern: ^[a-zA-Z]{2}$ type: string description: 'Filtering Type: `text`' extraDescription: minLength: 0 maxLength: 255 type: string description: |- Provides additional information to help consumers get to the entity. This string appears along with the entity's address (e.g., `In Menlo Mall, 3rd Floor`). It may also be used in conjunction with a hidden address (i.e., when **`addressHidden`** is `true`) to give consumers information about where the entity can be found (e.g., `Servicing the New York area`). Filtering Type: `text` line1: minLength: 0 maxLength: 255 type: string description: |- Cannot Include: * a URL or domain name Filtering Type: `text` line2: minLength: 0 maxLength: 255 type: string description: |- Cannot Include: * a URL or domain name Filtering Type: `text` postalCode: minLength: 0 maxLength: 10 type: string description: |- The entity's postal code. The postal code must be valid for the entity's country. Cannot include a URL or domain name. Cannot Include: * a URL or domain name Filtering Type: `text` region: minLength: 0 maxLength: 255 type: string description: |- The name of the entity's region or state. Cannot Include: * a URL or domain name Filtering Type: `text` sublocality: minLength: 0 maxLength: 255 type: string description: |- The name of the entity's sublocality Cannot Include: * a URL or domain name Filtering Type: `text` description: |- Contains the address of the entity (or where the entity is located) Must be a valid address Cannot be a P.O. Box If the entity is an `event`, either an **`address`** value or a **`linkedLocation`** value can be provided. Filtering Type: `object` ``` Eligible For: * atm * event * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` acceptingNewPatients: type: boolean description: |- Indicates whether the healthcare provider is accepting new patients. Filtering Type: `boolean` ``` Eligible For: * healthcareFacility * healthcareProfessional ``` acceptsReservations: type: boolean description: |- Indicates whether the entity accepts reservations. Filtering Type: `boolean` ``` Eligible For: * restaurant ``` accessHours: additionalProperties: false type: object properties: friday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the access hours are "closed" on Friday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is open on Friday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' holidayHours: description: |- **NOTE:** The list of Holiday Hours that you send us must be comprehensive. For example, if you send us a list of Holiday Hours that does not include Holiday Hours that you sent in your last update, Yext considers the missing Holiday Hours to be deleted, and we remove them. Array must be ordered. Filtering Type: `list of object` uniqueItems: true type: array items: required: - date additionalProperties: false type: object properties: date: format: date type: string description: |- Date on which the holiday hours will be in effect. Cannot be in the past. Date must be on or after 1970-01-01 Date must be before or on 2038-01-01 Filtering Type: `date` isClosed: type: boolean description: |- Indicates if the access hours are "closed" on on the given date. Filtering Type: `boolean` isRegularHours: type: boolean description: |- Indicates whether the holiday hours are the same as the regular business hours for the given date. If set to true, we will update the holiday hours if the regular business hours change for the date's day of the week. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is open on the specified date. Filtering Type: `list of object` description: 'Filtering Type: `object`' monday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the access hours are "closed" on Monday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is open on Monday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' reopenDate: format: date type: string description: |- Date must be on or after 1970-01-01 Date must be before or on 2038-01-01 Filtering Type: `date` saturday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the access hours are "closed" on Saturday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is open on Saturday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' sunday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the access hours are "closed" on Sunday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is open on Sunday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' thursday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the access hours are "closed" on Thursday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is open on Thursday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' tuesday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the access hours are "closed" on Tuesday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is open on Tuesday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' wednesday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the access hours are "closed" on Wednesday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is open on Wednesday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' description: |- Contains the daily access hours, holiday access hours, and reopen date for the Entity. Each day is represented by a sub-field of `accessHours`. (e.g. `monday`, `tuesday`, etc.) Open times can be specified per day through the `openIntervals` field and the `isClosed` flag. Similarly, holiday access hours are represented by the `holidayHours` sub-field. Setting the `reopenDate` sub-field indicates that the business is temporarily closed and will reopen on the specified date. SPECIAL CASES: * To indicate that an Entity is open 24 hours on a specific day, set start to 00:00 and end to 23:59 in `openIntervals` for that day. * To indicate that an Entity has split hours on a specific day (e.g., open from 9:00 AM to 12:00 PM and again from 1:00 PM to 5:00 PM), supply two or more `openIntervals` values with non-overlapping sets of hours. * If you are providing `openIntervals`, you may not set `isClosed` to true for that day. Filtering Type: `hours` ``` Eligible For: * atm * healthcareFacility * hotel * location * restaurant ``` additionalHoursText: minLength: 0 maxLength: 255 type: string description: |- Additional information about hours that does not fit in **`hours`** (e.g., `"Closed during the winter"`) Filtering Type: `text` ``` Eligible For: * atm * contactCard * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` additionalPromotingLocations: description: |- If other locations are promoting this event, a list of those locations' **`id`**s in the Yext Knowledge Manager Array must be ordered. Filtering Type: `list of entityId` ``` Eligible For: * event ``` uniqueItems: true type: array items: type: string description: 'Filtering Type: `entityId`' addressHidden: type: boolean description: |- If `true`, the entity's street address will not be shown on listings. Defaults to `false`. Filtering Type: `boolean` ``` Eligible For: * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` admittingHospitals: description: |- A list of hospitals where the healthcare professional admits patients Array must be ordered. Array may have a maximum of 100 elements. Array item description: >Cannot Include: >* HTML markup Filtering Type: `list of text` ``` Eligible For: * healthcareProfessional ``` uniqueItems: true type: array items: minLength: 0 maxLength: 100 type: string description: |- Cannot Include: * HTML markup Filtering Type: `text` adultPool: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity has a pool for adults only. Filtering Type: `option` ``` Eligible For: * hotel ``` ageRange: additionalProperties: false type: object properties: maxValue: multipleOf: 1 type: number description: |- Maximum age for the event Filtering Type: `integer` minValue: multipleOf: 1 type: number description: |- Minimum age for the event Filtering Type: `integer` description: |- Contains the age range for the event Filtering Type: `object` ``` Eligible For: * event ``` airportShuttle: enum: - AIRPORT_SHUTTLE_AVAILABLE - AIRPORT_SHUTTLE_AVAILABLE_FOR_FREE - NOT_APPLICABLE type: string description: |- Indicates whether the entity offers a shuttle to/from the airport. Filtering Type: `option` ``` Eligible For: * hotel ``` airportTransfer: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity offers a shuttle service of car service to/from nearby airports or train stations. Filtering Type: `option` ``` Eligible For: * hotel ``` allInclusive: enum: - ALL_INCLUSIVE_RATES_AVAILABLE - ALL_INCLUSIVE_RATES_ONLY - NOT_APPLICABLE type: string description: |- Indicates whether the entity offers all-inclusive rates. Filtering Type: `option` ``` Eligible For: * hotel ``` alternateNames: description: |- Other names for your business that you would like us to use when tracking your search performance Array must be ordered. Array may have a maximum of 3 elements. Array item description: >Cannot Include: >* HTML markup Filtering Type: `list of text` ``` Eligible For: * atm * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * organization * restaurant ``` uniqueItems: true type: array items: minLength: 0 maxLength: 100 type: string description: |- Cannot Include: * HTML markup Filtering Type: `text` alternatePhone: minLength: 0 type: string description: |- Must be a valid phone number. If the phone number's calling code is for a country other than the one given in the entity's **`countryCode`**, the phone number provided must contain the calling code (e.g., `+44` in `+442038083831`). Otherwise, the calling code is optional. Filtering Type: `text` ``` Eligible For: * atm * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` alternateWebsites: description: |- Other websites for your business that we should search for when tracking your search performance Array must be ordered. Array may have a maximum of 3 elements. Array item description: >Cannot Include: >* common domain names, e.g., google.com, youtube.com, etc. Filtering Type: `list of text` ``` Eligible For: * atm * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * organization * restaurant ``` uniqueItems: true type: array items: minLength: 0 maxLength: 255 format: uri type: string description: |- Cannot Include: * common domain names, e.g., google.com, youtube.com, etc. Filtering Type: `text` androidAppUrl: minLength: 0 type: string description: |- The URL where consumers can download the entity's Android app Filtering Type: `text` ``` Eligible For: * brand * financialProfessional * hotel * location * restaurant ``` answer: description: |- The answer to the frequently asked question represented by this entity Character limit: 0 .. 15000 Supported formats include: * BOLD * ITALICS * UNDERLINE * BULLETED_LIST * NUMBERED_LIST * HYPERLINK * IMAGE * CODE_SPAN * HEADINGS ``` Eligible For: * faq ``` type: string format: rich-text appleActionLinks: description: |- Use this field to add action links to your Apple Listings. The call to action category will be displayed on the action link button. The App Store URL should contain a valid link to the landing page of an App in the Apple App Store. The Quick Link URL is where a user is taken when an action link is clicked by a user. The App Name sub-field is not displayed on Apple Listings and is only used to distinguish the call-to-action type when utilizing action links in Apple posts. Array must be ordered. Filtering Type: `list of object` ``` Eligible For: * atm * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` uniqueItems: true type: array items: required: - category - quickLinkUrl - appName additionalProperties: false type: object properties: appName: minLength: 0 maxLength: 18 type: string description: 'Filtering Type: `text`' appStoreUrl: minLength: 0 maxLength: 2000 format: uri type: string description: 'Filtering Type: `text`' category: enum: - BOOK_TRAVEL - CHECK_IN - FEES_POLICIES - FLIGHT_STATUS - TICKETS - TICKETING - AMENITIES - FRONT_DESK - PARKING - GIFT_CARD - WAITLIST - DELIVERY - ORDER - TAKEOUT - PICKUP - RESERVE - MENU - APPOINTMENT - PORTFOLIO - QUOTE - SERVICES - STORE_ORDERS - STORE_SHOP - STORE_SUPPORT - SCHEDULE - SHOWTIMES - AVAILABILITY - PRICING - ACTIVITIES - BOOK - BOOK_(HOTEL) - BOOK_(RIDE) - BOOK_(TOUR) - CAREERS - CHARGE - COUPONS - DELIVERY_(RETAIL) - DONATE - EVENTS - ORDER_(RETAIL) - OTHER_MENU - PICKUP_(RETAIL) - RESERVE_(PARKING) - SHOWS - SPORTS - SUPPORT - TEE_TIME - GIFT_CARD_(RESTAURANT) type: string description: 'Filtering Type: `option`' quickLinkUrl: minLength: 0 maxLength: 2000 format: uri type: string description: 'Filtering Type: `text`' description: 'Filtering Type: `object`' appleBusinessDescription: minLength: 0 maxLength: 500 type: string description: |- The business description to be sent to Apple Filtering Type: `text` ``` Eligible For: * atm * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` appleBusinessId: minLength: 0 pattern: ^\d*\.?\d*$ type: string description: |- The ID associated with an individual Business Folder in your Apple account Filtering Type: `text` ``` Eligible For: * atm * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` appleCompanyId: minLength: 0 pattern: ^\d*\.?\d*$ type: string description: |- The ID associated with your Apple account. Numerical values only Filtering Type: `text` ``` Eligible For: * atm * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` appleCoverPhoto: required: - url additionalProperties: false type: object description: |- The cover photo for the entity''s Apple profile Image must be at least 1600 x 1040 pixels Image may be no more than 4864 x 3163 pixels Supported Aspect Ratios: * 154 x 100 **NOTE**: Maximum image size is 5mb after normalization and padding (if applicable). As well, there is a 6 second download limit from the image host. Filtering Type: `object` ``` Eligible For: * atm * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` properties: alternateText: minLength: 0 type: string description: 'Filtering Type: `text`' url: minLength: 0 format: uri type: string description: 'Filtering Type: `text`' appleDisplayName: minLength: 0 maxLength: 5000 type: string description: |- The name to be displayed on Apple for the entity. NOTE: The names of Brands and their respective Locations within an Apple Business Connect Account must match identically. Cannot Include: HTML markup Cannot Include: * HTML markup Filtering Type: `text` ``` Eligible For: * atm * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` applicationUrl: minLength: 0 format: uri type: string description: |- The application URL Filtering Type: `text` ``` Eligible For: * job ``` associations: description: |- Association memberships relevant to the entity (e.g., `"New York Doctors Association"`) All strings must be non-empty when trimmed of whitespace. Array must be ordered. Array may have a maximum of 100 elements. Array item description: >Cannot Include: >* HTML markup Filtering Type: `list of text` ``` Eligible For: * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` uniqueItems: true type: array items: minLength: 0 maxLength: 100 type: string description: |- Cannot Include: * HTML markup Filtering Type: `text` attendance: required: - attendanceMode additionalProperties: false type: object properties: attendanceMode: enum: - OFFLINE - ONLINE - MIXED type: string description: 'Filtering Type: `option`' virtualLocationUrl: minLength: 0 format: uri type: string description: 'Filtering Type: `text`' description: |- Indicates whether the event is online, offline, or a mix. A `virtualLocationUrl` must be specified for online and mixed events. Filtering Type: `object` ``` Eligible For: * event ``` attire: enum: - UNSPECIFIED - DRESSY - CASUAL - FORMAL type: string description: |- The formality of clothing typically worn at this restaurant Filtering Type: `option` ``` Eligible For: * restaurant ``` babysittingOffered: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity offers babysitting. Filtering Type: `option` ``` Eligible For: * hotel ``` baggageStorage: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity offers baggage storage pre check-in and post check-out. Filtering Type: `option` ``` Eligible For: * hotel ``` bar: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity has an indoor or outdoor bar onsite. Filtering Type: `option` ``` Eligible For: * hotel ``` beachAccess: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity has access to a beach. Filtering Type: `option` ``` Eligible For: * hotel ``` beachFrontProperty: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity is physically located next to a beach. Filtering Type: `option` ``` Eligible For: * hotel ``` bicycles: enum: - BICYCLE_RENTALS - BICYCLE_RENTALS_FOR_FREE - NOT_APPLICABLE type: string description: |- Indicates whether the entity offers bicycles for rent or for free. Filtering Type: `option` ``` Eligible For: * hotel ``` bios: additionalProperties: false type: object properties: ids: description: |- IDs of the Bio Lists associated with this entity Array must be ordered. Array may have a maximum of 40 elements. Filtering Type: `list of text` uniqueItems: true type: array items: minLength: 0 type: string description: 'Filtering Type: `text`' label: minLength: 0 maxLength: 30 type: string description: |- Label to be used for this entity's Bio Lists. This label will appear on your entity's listings. Filtering Type: `text` description: |- Information about the Bio Content Lists associated with this entity Filtering Type: `object` ``` Eligible For: * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * organization * restaurant ``` boutiqueStores: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity has a boutique store. Gift shop or convenience store are not eligible. Filtering Type: `option` ``` Eligible For: * hotel ``` brands: description: |- Brands sold by this entity All strings must be non-empty when trimmed of whitespace. Array must be ordered. Array may have a maximum of 100 elements. Array item description: >Cannot Include: >* HTML markup Filtering Type: `list of text` ``` Eligible For: * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` uniqueItems: true type: array items: minLength: 0 maxLength: 100 type: string description: |- Cannot Include: * HTML markup Filtering Type: `text` breakfast: enum: - BREAKFAST_AVAILABLE - BREAKFAST_AVAILABLE_FOR_FREE - NOT_APPLICABLE type: string description: |- Indicates whether the entity offers breakfast. Filtering Type: `option` ``` Eligible For: * hotel ``` brunchHours: additionalProperties: false type: object properties: friday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the brunch hours are "closed" on Friday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is open for brunch on Friday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' holidayHours: description: |- **NOTE:** The list of Holiday Hours that you send us must be comprehensive. For example, if you send us a list of Holiday Hours that does not include Holiday Hours that you sent in your last update, Yext considers the missing Holiday Hours to be deleted, and we remove them. Array must be ordered. Filtering Type: `list of object` uniqueItems: true type: array items: required: - date additionalProperties: false type: object properties: date: format: date type: string description: |- Date on which the holiday hours will be in effect. Cannot be in the past. Date must be on or after 1970-01-01 Date must be before or on 2038-01-01 Filtering Type: `date` isClosed: type: boolean description: |- Indicates if the brunch hours are "closed" on on the given date. Filtering Type: `boolean` isRegularHours: type: boolean description: |- Indicates whether the holiday hours are the same as the regular business hours for the given date. If set to true, we will update the holiday hours if the regular business hours change for the date's day of the week. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is open on the specified date. Filtering Type: `list of object` description: 'Filtering Type: `object`' monday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the brunch hours are "closed" on Monday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is open for brunch on Monday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' reopenDate: format: date type: string description: |- Date must be on or after 1970-01-01 Date must be before or on 2038-01-01 Filtering Type: `date` saturday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the brunch hours are "closed" on Saturday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is open for brunch on Saturday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' sunday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the brunch hours are "closed" on Sunday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is open for brunch on Sunday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' thursday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the brunch hours are "closed" on Thursday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is open for brunch on Thursday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' tuesday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the brunch hours are "closed" on Tuesday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is open for brunch on Tuesday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' wednesday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the brunch hours are "closed" on Wednesday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is open for brunch on Wednesday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' description: |- Contains the daily brunch hours, holiday brunch hours, and reopen date for the Entity. Each day is represented by a sub-field of `brunchHours`. (e.g. `monday`, `tuesday`, etc.) Open times can be specified per day through the `openIntervals` field and the `isClosed` flag. Similarly, holiday brunch hours are represented by the `holidayHours` sub-field. Setting the `reopenDate` sub-field indicates that the business is temporarily closed and will reopen on the specified date. SPECIAL CASES: * To indicate that an Entity is open 24 hours on a specific day, set start to 00:00 and end to 23:59 in `openIntervals` for that day. * To indicate that an Entity has split hours on a specific day (e.g., open from 9:00 AM to 12:00 PM and again from 1:00 PM to 5:00 PM), supply two or more `openIntervals` values with non-overlapping sets of hours. * If you are providing `openIntervals`, you may not set `isClosed` to true for that day. Filtering Type: `hours` ``` Eligible For: * hotel * location * restaurant ``` businessCenter: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity has a business center. Filtering Type: `option` ``` Eligible For: * hotel ``` calendars: additionalProperties: false type: object properties: ids: description: |- IDs of the Calendars associated with this entity Array must be ordered. Array may have a maximum of 40 elements. Filtering Type: `list of text` uniqueItems: true type: array items: minLength: 0 type: string description: 'Filtering Type: `text`' label: minLength: 0 maxLength: 30 type: string description: |- Label to be used for this entity's Calendars. This label will appear on your entity's listings. Filtering Type: `text` description: |- Information about the events Content Lists (Calendars) associated with this entity Filtering Type: `object` ``` Eligible For: * financialProfessional * healthcareFacility * hotel * location * restaurant ``` carRental: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity offers car rental. Filtering Type: `option` ``` Eligible For: * hotel ``` casino: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity has a casino on premise or nearby. Filtering Type: `option` ``` Eligible For: * hotel ``` categories: additionalProperties: false type: object properties: {} description: |- Yext Categories. (Supported for versions > 20240220) A map of category list external IDs (i.e. "yext") to a list of category IDs. IDs must be valid and selectable (i.e., cannot be parent categories). Partial updates are accepted, meaning sending only the "yext" property will have no effect on any category list except the "yext" category. Filtering Type: `object` ``` Eligible For: * atm * event * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` categoryIds: uniqueItems: false type: array items: minLength: 0 type: string description: 'Filtering Type: `text`' description: |- Yext Category IDs. (Deprecated: For versions > 20240220) 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. Filtering Type: `list of text` ``` Eligible For: * atm * event * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` catsAllowed: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates if the entity is cat friendly. Filtering Type: `option` ``` Eligible For: * hotel ``` certifications: description: |- A list of the certifications held by the healthcare professional **NOTE:** This field is only available to locations whose **`entityType`** is `healthcareProfessional`. Array must be ordered. Array may have a maximum of 100 elements. Array item description: >Cannot Include: >* HTML markup Filtering Type: `list of text` ``` Eligible For: * financialProfessional * healthcareProfessional ``` uniqueItems: true type: array items: minLength: 0 maxLength: 200 type: string description: |- Cannot Include: * HTML markup Filtering Type: `text` checkInTime: format: time type: string description: |- The check-in time Filtering Type: `time` ``` Eligible For: * hotel ``` checkOutTime: format: time type: string description: |- The check-out time Filtering Type: `time` ``` Eligible For: * hotel ``` classificationRating: pattern: ^\d*\.?\d*$ type: string description: |- The 1 to 5 star rating of the entitiy based on its services and facilities. Filtering Type: `decimal` ``` Eligible For: * hotel ``` closed: type: boolean description: |- Indicates whether the entity is closed Filtering Type: `boolean` ``` Eligible For: * atm * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` concierge: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity offers concierge service. Filtering Type: `option` ``` Eligible For: * hotel ``` conditionsTreated: description: |- A list of the conditions treated by the healthcare provider Array must be ordered. Array may have a maximum of 100 elements. Array item description: >Cannot Include: >* HTML markup Filtering Type: `list of text` ``` Eligible For: * healthcareFacility * healthcareProfessional ``` uniqueItems: true type: array items: minLength: 0 maxLength: 100 type: string description: |- Cannot Include: * HTML markup Filtering Type: `text` convenienceStore: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity has a convenience store. Filtering Type: `option` ``` Eligible For: * hotel ``` covidMessaging: minLength: 0 maxLength: 15000 type: string description: |- Information or messaging related to COVID-19. Filtering Type: `text` ``` Eligible For: * healthcareFacility * healthcareProfessional * location ``` covidTestAppointmentUrl: minLength: 0 format: uri type: string description: |- An appointment URL for scheduling a COVID-19 test. Filtering Type: `text` ``` Eligible For: * healthcareFacility * location ``` covidTestingAppointmentRequired: type: boolean description: |- Indicates whether an appointment is required for a COVID-19 test. Filtering Type: `boolean` ``` Eligible For: * healthcareFacility * location ``` covidTestingDriveThroughSite: type: boolean description: |- Indicates whether location is a drive-through site for COVID-19 tests. Filtering Type: `boolean` ``` Eligible For: * healthcareFacility * location ``` covidTestingIsFree: type: boolean description: |- Indicates whether location offers free COVID-19 testing. Filtering Type: `boolean` ``` Eligible For: * healthcareFacility * location ``` covidTestingPatientRestrictions: type: boolean description: |- Indicates whether there are patient restrictions for COVID-19 testing. Filtering Type: `boolean` ``` Eligible For: * healthcareFacility * location ``` covidTestingReferralRequired: type: boolean description: |- Indicates whether a referral is required for COVID-19 testing. Filtering Type: `boolean` ``` Eligible For: * healthcareFacility * location ``` covidTestingSiteInstructions: minLength: 0 maxLength: 15000 type: string description: |- Information or instructions for the COVID-19 testing site. Filtering Type: `text` ``` Eligible For: * healthcareFacility * location ``` covidVaccineAppointmentRequired: type: boolean description: |- Indicates whether an appointment is required for a COVID-19 vaccine. Filtering Type: `boolean` ``` Eligible For: * healthcareFacility * location ``` covidVaccineDriveThroughSite: type: boolean description: |- Indicates whether location is a drive-through site for COVID-19 vaccines. Filtering Type: `boolean` ``` Eligible For: * healthcareFacility * location ``` covidVaccineInformationUrl: minLength: 0 format: uri type: string description: |- An information URL for more information about COVID-19 vaccines. Filtering Type: `text` ``` Eligible For: * healthcareFacility * location ``` covidVaccinePatientRestrictions: type: boolean description: |- Indicates whether there are patient restrictions for a COVID-19 vaccine. Filtering Type: `boolean` ``` Eligible For: * healthcareFacility * location ``` covidVaccineReferralRequired: type: boolean description: |- Indicates whether a referral is required for a COVID-19 vaccine. Filtering Type: `boolean` ``` Eligible For: * healthcareFacility * location ``` covidVaccineSiteInstructions: minLength: 0 maxLength: 15000 type: string description: |- Information or instructions for the COVID-19 vaccination site. Filtering Type: `text` ``` Eligible For: * healthcareFacility * location ``` covidVaccinesOffered: uniqueItems: true type: array items: enum: - PFIZER - MODERNA - JOHNSON_&_JOHNSON type: string description: 'Filtering Type: `option`' description: |- Indicates which COVID-19 vaccines the location offers. Filtering Type: `list of option` ``` Eligible For: * healthcareFacility * location ``` currencyExchange: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity offers currency exchange services. Filtering Type: `option` ``` Eligible For: * hotel ``` customKeywords: description: |- Additional keywords you would like us to use when tracking your search performance Array must be ordered. Array may have a maximum of 5 elements. Filtering Type: `list of text` ``` Eligible For: * atm * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * organization * restaurant ``` uniqueItems: true type: array items: minLength: 0 maxLength: 100 type: string description: 'Filtering Type: `text`' datePosted: format: date type: string description: |- The date this entity was posted Filtering Type: `date` ``` Eligible For: * job ``` degrees: description: |- A list of the degrees earned by the healthcare professional Array must be ordered. Filtering Type: `list of option` ``` Eligible For: * healthcareProfessional ``` uniqueItems: true type: array items: enum: - ANP - APN - APRN - ARNP - AUD - BSW - CCCA - CNM - CNP - CNS - CPNP - CRNA - CRNP - DC - DDS - DMD - DNP - DO - DPM - DPT - DSW - DVM - FNP - GNP - LAC - LCSW - LPN - MBA - MBBS - MD - MPAS - MPH - MSW - ND - NNP - NP - OD - PA - PAC - PHARMD - PHD - PNP - PSYD - RD - RSW - VMD - WHNP type: string description: 'Filtering Type: `option`' deliveryHours: additionalProperties: false type: object properties: friday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the delivery hours are "closed" on Friday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is delivering on Friday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' holidayHours: description: |- **NOTE:** The list of Holiday Hours that you send us must be comprehensive. For example, if you send us a list of Holiday Hours that does not include Holiday Hours that you sent in your last update, Yext considers the missing Holiday Hours to be deleted, and we remove them. Array must be ordered. Filtering Type: `list of object` uniqueItems: true type: array items: required: - date additionalProperties: false type: object properties: date: format: date type: string description: |- Date on which the holiday hours will be in effect. Cannot be in the past. Date must be on or after 1970-01-01 Date must be before or on 2038-01-01 Filtering Type: `date` isClosed: type: boolean description: |- Indicates if the delivery hours are "closed" on on the given date. Filtering Type: `boolean` isRegularHours: type: boolean description: |- Indicates whether the holiday hours are the same as the regular business hours for the given date. If set to true, we will update the holiday hours if the regular business hours change for the date's day of the week. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is delivering on the specified date. Filtering Type: `list of object` description: 'Filtering Type: `object`' monday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the delivery hours are "closed" on Monday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is delivering on Monday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' reopenDate: format: date type: string description: |- Date must be on or after 1970-01-01 Date must be before or on 2038-01-01 Filtering Type: `date` saturday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the delivery hours are "closed" on Saturday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is delivering on Saturday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' sunday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the delivery hours are "closed" on Sunday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is delivering on Sunday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' thursday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the delivery hours are "closed" on Thursday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is delivering on Thursday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' tuesday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the delivery hours are "closed" on Tuesday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is delivering on Tuesday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' wednesday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the delivery hours are "closed" on Wednesday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is delivering on Wednesday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' description: |- Contains the daily delivery hours, holiday delivery hours, and reopen date for the Entity. Each day is represented by a sub-field of `deliveryHours`. (e.g. `monday`, `tuesday`, etc.) Open times can be specified per day through the `openIntervals` field and the `isClosed` flag. Similarly, holiday delivery hours are represented by the `holidayHours` sub-field. Setting the `reopenDate` sub-field indicates that the business is temporarily closed and will reopen on the specified date. SPECIAL CASES: * To indicate that an Entity is open 24 hours on a specific day, set start to 00:00 and end to 23:59 in `openIntervals` for that day. * To indicate that an Entity has split hours on a specific day (e.g., open from 9:00 AM to 12:00 PM and again from 1:00 PM to 5:00 PM), supply two or more `openIntervals` values with non-overlapping sets of hours. * If you are providing `openIntervals`, you may not set `isClosed` to true for that day. Filtering Type: `hours` ``` Eligible For: * location * restaurant ``` description: minLength: 10 maxLength: 15000 type: string description: |- A description of the entity Cannot Include: * HTML markup Filtering Type: `text` ``` Eligible For: * atm * contactCard * event * financialProfessional * healthcareFacility * healthcareProfessional * hotel * job * location * organization * restaurant ``` displayCoordinate: additionalProperties: false type: object properties: latitude: minimum: -90 maximum: 90 type: number description: 'Filtering Type: `float`' longitude: minimum: -180 maximum: 180 type: number description: 'Filtering Type: `float`' description: |- Coordinates where the map pin for the entity should be displayed, as provided by you Filtering Type: `object` ``` Eligible For: * atm * event * financialProfessional * healthcareFacility * healthcareProfessional * hotel * job * location * restaurant ``` doctorOnCall: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity has a doctor on premise or on call. Filtering Type: `option` ``` Eligible For: * hotel ``` dogsAllowed: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates if the entity is dog friendly. Filtering Type: `option` ``` Eligible For: * hotel ``` driveThroughHours: additionalProperties: false type: object properties: friday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the drive-through hours are "closed" on Friday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity's drive-through is open on Friday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' holidayHours: description: |- **NOTE:** The list of Holiday Hours that you send us must be comprehensive. For example, if you send us a list of Holiday Hours that does not include Holiday Hours that you sent in your last update, Yext considers the missing Holiday Hours to be deleted, and we remove them. Array must be ordered. Filtering Type: `list of object` uniqueItems: true type: array items: required: - date additionalProperties: false type: object properties: date: format: date type: string description: |- Date on which the holiday hours will be in effect. Cannot be in the past. Date must be on or after 1970-01-01 Date must be before or on 2038-01-01 Filtering Type: `date` isClosed: type: boolean description: |- Indicates if the drive-through hours are "closed" on on the given date. Filtering Type: `boolean` isRegularHours: type: boolean description: |- Indicates whether the holiday hours are the same as the regular business hours for the given date. If set to true, we will update the holiday hours if the regular business hours change for the date's day of the week. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity's drive-through is open on the specified date. Filtering Type: `list of object` description: 'Filtering Type: `object`' monday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the drive-through hours are "closed" on Monday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity's drive-through is open on Monday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' reopenDate: format: date type: string description: |- Date must be on or after 1970-01-01 Date must be before or on 2038-01-01 Filtering Type: `date` saturday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the drive-through hours are "closed" on Saturday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity's drive-through is open on Saturday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' sunday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the drive-through hours are "closed" on Sunday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity's drive-through is open on Sunday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' thursday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the drive-through hours are "closed" on Thursday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity's drive-through is open on Thursday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' tuesday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the drive-through hours are "closed" on Tuesday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity's drive-through is open on Tuesday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' wednesday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the drive-through hours are "closed" on Wednesday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity's drive-through is open on Wednesday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' description: |- Contains the daily drive-through hours, holiday drive-through hours, and reopen date for the Entity. Each day is represented by a sub-field of `driveThroughHours`. (e.g. `monday`, `tuesday`, etc.) Open times can be specified per day through the `openIntervals` field and the `isClosed` flag. Similarly, holiday drive-through hours are represented by the `holidayHours` sub-field. Setting the `reopenDate` sub-field indicates that the business is temporarily closed and will reopen on the specified date. SPECIAL CASES: * To indicate that an Entity is open 24 hours on a specific day, set start to 00:00 and end to 23:59 in `openIntervals` for that day. * To indicate that an Entity has split hours on a specific day (e.g., open from 9:00 AM to 12:00 PM and again from 1:00 PM to 5:00 PM), supply two or more `openIntervals` values with non-overlapping sets of hours. * If you are providing `openIntervals`, you may not set `isClosed` to true for that day. Filtering Type: `hours` ``` Eligible For: * atm * location * restaurant ``` dropoffCoordinate: additionalProperties: false type: object properties: latitude: minimum: -90 maximum: 90 type: number description: 'Filtering Type: `float`' longitude: minimum: -180 maximum: 180 type: number description: 'Filtering Type: `float`' description: |- Coordinates of the drop-off area for the entity, as provided by you Filtering Type: `object` ``` Eligible For: * atm * event * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` educationList: description: |- Information about the education or training completed by the healthcare professional Array must be ordered. Filtering Type: `list of object` ``` Eligible For: * healthcareProfessional ``` uniqueItems: true type: array items: required: - type - institutionName - yearCompleted additionalProperties: false type: object properties: institutionName: minLength: 0 maxLength: 100 type: string description: 'Filtering Type: `text`' type: enum: - FELLOWSHIP - RESIDENCY - INTERNSHIP - MEDICAL_SCHOOL type: string description: 'Filtering Type: `option`' yearCompleted: multipleOf: 1 minimum: 1900 maximum: 2100 type: number description: 'Filtering Type: `integer`' description: 'Filtering Type: `object`' electricChargingStation: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity has electric car chargine stations on premise. Filtering Type: `option` ``` Eligible For: * hotel ``` elevator: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity has an elevator. Filtering Type: `option` ``` Eligible For: * hotel ``` ellipticalMachine: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity has an elliptical machine. Filtering Type: `option` ``` Eligible For: * hotel ``` emails: description: |- Emails addresses for this entity's point of contact Must be valid email addresses Array must be ordered. Array may have a maximum of 5 elements. Filtering Type: `list of text` ``` Eligible For: * contactCard * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * organization * restaurant ``` uniqueItems: true type: array items: minLength: 0 format: email type: string description: 'Filtering Type: `text`' employmentType: enum: - FULL_TIME - PART_TIME - CONTRACTOR - TEMPORARY - INTERN - VOLUNTEER - PER_DIEM - OTHER type: string description: |- The employment type for the open job. Indicates whether the job is full-time, part-time, temporary, etc. Filtering Type: `option` ``` Eligible For: * job ``` eventStatus: enum: - SCHEDULED - RESCHEDULED - POSTPONED - CANCELED - EVENT_MOVED_ONLINE type: string description: |- Information on whether the event will take place as scheduled Filtering Type: `option` ``` Eligible For: * event ``` facebookAbout: minLength: 0 maxLength: 255 type: string description: |- A description of the entity to be used in the "About You" section on Facebook Filtering Type: `text` ``` Eligible For: * atm * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` facebookCallToAction: required: - type additionalProperties: false type: object properties: type: enum: - NONE - BOOK_NOW - CALL_NOW - CONTACT_US - SEND_MESSAGE - USE_APP - PLAY_GAME - SHOP_NOW - SIGN_UP - WATCH_VIDEO - SEND_EMAIL - LEARN_MORE - PURCHASE_GIFT_CARDS - ORDER_NOW - FOLLOW_PAGE type: string description: |- The action the consumer is being prompted to take by the button's text Filtering Type: `option` value: minLength: 0 type: string description: |- Indicates where consumers will be directed to upon clicking the Call-to-Action button (e.g., a URL). It can be a free-form string or an embedded value, depending on what the user specifies. For example, if the user sets the Facebook Call-to-Action as " 'Sign Up' using 'Website URL' " in the Yext platform, **`type`** will be `SIGN_UP` and **`value`** will be `[[websiteUrl]]`. The Call-to-Action will have the same behavior if the user sets the value to "Custom Value" in the platform and embeds a field. Filtering Type: `text` description: |- Designates the Facebook Call-to-Action button text and value Valid contents of **`value`** depends on the Call-to-Action's **`type`**: * `NONE`: (optional) * `BOOK_NOW`: URL * `CALL_NOW`: Phone number * `CONTACT_US`: URL * `SEND_MESSAGE`: Any string * `USE_APP`: URL * `PLAY_GAME`: URL * `SHOP_NOW`: URL * `SIGN_UP`: URL * `WATCH_VIDEO`: URL * `SEND_EMAIL`: Email address * `LEARN_MORE`: URL * `PURCHASE_GIFT_CARDS`: URL * `ORDER_NOW`: URL * `FOLLOW_PAGE`: Any string Filtering Type: `object` ``` Eligible For: * atm * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` facebookCoverPhoto: required: - url additionalProperties: false type: object description: |- The cover photo for the entity's Facebook profile Displayed as a 851 x 315 pixel image You may need a cover photo in order for your listing to appear on Facebook. Please check your listings tab to learn more. Image must be at least 400 x 150 pixels Image area (width x height) may be no more than 41000000 pixels Image may be no more than 30000 x 30000 pixels Supported Aspect Ratios: * 1 x 1 * 4 x 3 * 3 x 2 * 5 x 3 * 16 x 9 * 3 x 1 * 2 x 3 * 5 x 7 * 4 x 5 * 4 x 1 **NOTE**: Maximum image size is 5mb after normalization and padding (if applicable). As well, there is a 6 second download limit from the image host. Filtering Type: `object` ``` Eligible For: * atm * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` properties: alternateText: minLength: 0 type: string description: 'Filtering Type: `text`' url: minLength: 0 format: uri type: string description: 'Filtering Type: `text`' facebookDescriptor: minLength: 3 maxLength: 75 type: string description: |- Location Descriptors are used for Enterprise businesses that sync Facebook listings using brand page location structure. The Location Descriptor is typically an additional geographic description (e.g. geomodifier) that will appear in parentheses after the name on the Facebook listing. Cannot Include: * HTML markup Filtering Type: `text` ``` Eligible For: * atm * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` facebookName: minLength: 0 type: string description: |- The name for this entity's Facebook profile. A separate name may be specified to send only to Facebook in order to comply with any specific Facebook rules or naming conventions. Filtering Type: `text` ``` Eligible For: * atm * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` facebookOverrideCity: minLength: 0 type: string description: |- The city to be displayed on this entity's Facebook profile Filtering Type: `text` ``` Eligible For: * atm * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` facebookPageUrl: minLength: 0 type: string description: |- URL for the entity's Facebook Page. Valid formats: - facebook.com/profile.php?id=[numId] - facebook.com/group.php?gid=[numId] - facebook.com/groups/[numId] - facebook.com/[Name] - facebook.com/pages/[Name]/[numId] - facebook.com/people/[Name]/[numId] where [Name] is a String and [numId] is an Integer The success response will contain a warning message explaining why the URL wasn't stored in the system. Filtering Type: `text` ``` Eligible For: * atm * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * organization * restaurant ``` facebookParentPageId: minLength: 0 maxLength: 65 type: string description: |- The Facebook Page ID of this entity's brand page if in a brand page location structure Filtering Type: `text` ``` Eligible For: * atm * brand * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` facebookProfilePhoto: required: - url additionalProperties: false type: object description: |- The profile picture for the entity's Facebook profile You must have a profile picture in order for your listing to appear on Facebook. Image must be at least 180 x 180 pixels Image area (width x height) may be no more than 41000000 pixels Image may be no more than 30000 x 30000 pixels Supported Aspect Ratios: * 1 x 1 * 4 x 3 * 3 x 2 * 5 x 3 * 16 x 9 * 3 x 1 * 2 x 3 * 5 x 7 * 4 x 5 * 4 x 1 **NOTE**: Maximum image size is 5mb after normalization and padding (if applicable). As well, there is a 6 second download limit from the image host. Filtering Type: `object` ``` Eligible For: * atm * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` properties: alternateText: minLength: 0 type: string description: 'Filtering Type: `text`' url: minLength: 0 format: uri type: string description: 'Filtering Type: `text`' facebookStoreId: minLength: 0 type: string description: |- The Store ID used for this entity in a brand page location structure Filtering Type: `text` ``` Eligible For: * atm * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` facebookVanityUrl: minLength: 0 maxLength: 50 type: string description: |- The username that appear's in the Facebook listing URL to help customers find and remember a brand’s Facebook page. The username is also be used for tagging the Facebook page in other users’ posts, and searching for the Facebook page. Filtering Type: `text` ``` Eligible For: * atm * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` facebookWebsiteOverride: minLength: 0 format: uri type: string description: |- The URL you would like to submit to Facebook in place of the one given in **`websiteUrl`** (if applicable). Filtering Type: `text` ``` Eligible For: * atm * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` fax: minLength: 0 type: string description: |- Must be a valid fax number. If the fax number's calling code is for a country other than the one given in the entity's **`countryCode`**, the fax number provided must contain the calling code (e.g., `+44` in `+442038083831`). Otherwise, the calling code is optional. Filtering Type: `text` ``` Eligible For: * atm * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` featuredMessage: additionalProperties: false type: object properties: description: minLength: 0 maxLength: 50 type: string description: |- The text of Featured Message. Default: `Call today!` Cannot include: - inappropriate language - HTML markup - a URL or domain name - a phone number - control characters ([\x00-\x1F\x7F]) - insufficient spacing If you submit a Featured Message that contains profanity or more than 50 characters, it will be ignored. The success response will contain a warning message explaining why your Featured Message wasn't stored in the system. Cannot Include: * HTML markup Filtering Type: `text` url: minLength: 0 maxLength: 255 format: uri type: string description: |- Valid URL linked to the Featured Message text Filtering Type: `text` description: |- Information about the entity's Featured Message Filtering Type: `object` ``` Eligible For: * atm * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` firstName: minLength: 0 maxLength: 35 type: string description: |- The first name of the healthcare professional Cannot Include: * a URL or domain name * HTML markup Filtering Type: `text` ``` Eligible For: * healthcareProfessional ``` firstPartyReviewPage: minLength: 0 type: string description: |- Link to the review-collection page, where consumers can leave first-party reviews ``` Eligible For: * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` fitnessCenter: enum: - FITNESS_CENTER_AVAILABLE - FITNESS_CENTER_AVAILABLE_FOR_FREE - NOT_APPLICABLE type: string description: |- Indicates whether the entity has a fitness center. Filtering Type: `option` ``` Eligible For: * hotel ``` floorCount: multipleOf: 1 minimum: 0 type: number description: |- The number of floors the entity has from ground floor to top floor. Filtering Type: `integer` ``` Eligible For: * hotel ``` freeWeights: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity has free weights. Filtering Type: `option` ``` Eligible For: * hotel ``` frequentlyAskedQuestions: description: |- A list of questions that are frequently asked about this entity Array must be ordered. Array may have a maximum of 100 elements. Filtering Type: `list of object` ``` Eligible For: * atm * event * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` uniqueItems: true type: array items: required: - question additionalProperties: false type: object properties: answer: minLength: 1 maxLength: 4096 type: string description: 'Filtering Type: `text`' question: minLength: 1 maxLength: 4096 type: string description: 'Filtering Type: `text`' description: 'Filtering Type: `object`' frontDesk: enum: - FRONT_DESK_AVAILABLE - FRONT_DESK_AVAILABLE_24_HOURS - NOT_APPLICABLE type: string description: |- Indicates whether the entity has a front desk. Filtering Type: `option` ``` Eligible For: * hotel ``` fullyVaccinatedStaff: type: boolean description: |- Indicates whether the staff is vaccinated against COVID-19. Filtering Type: `boolean` ``` Eligible For: * healthcareFacility * hotel * location * restaurant ``` gameRoom: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity has a game room. Filtering Type: `option` ``` Eligible For: * hotel ``` gender: enum: - UNSPECIFIED - FEMALE - MALE - NONBINARY - TRANSGENDER_FEMALE - TRANSGENDER_MALE - OTHER - PREFER_NOT_TO_DISCLOSE type: string description: |- The gender of the healthcare professional Filtering Type: `option` ``` Eligible For: * healthcareProfessional ``` geomodifier: minLength: 0 type: string description: |- Provides additional information on where the entity can be found (e.g., `Times Square`, `Global Center Mall`) Filtering Type: `text` ``` Eligible For: * atm * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` giftShop: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity has a gift shop. Filtering Type: `option` ``` Eligible For: * hotel ``` golf: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity has a golf couse on premise or nearby. The golf course may be independently run. Filtering Type: `option` ``` Eligible For: * hotel ``` googleAttributes: additionalProperties: false type: object properties: {} description: |- The unique IDs of the entity's Google Business Profile keywords, as well as the unique IDs of any values selected for each keyword. Valid keywords (e.g., `has_drive_through`, `has_fitting_room`, `kitchen_in_room`) are determined by the entity's primary category. A full list of keywords can be retrieved with the Google Fields: List endpoint. Keyword values provide more details on how the keyword applies to the entity (e.g., if the keyword is `has_drive_through`, its values may be `true` or `false`). * If the **`v`** parameter is before `20181204`: **`googleAttributes`** is formatted as a map of key-value pairs (e.g., `[{ "id": "has_wheelchair_accessible_entrance", "values": [ "true" ] }]`) * If the **`v`** parameter is on or after `20181204`: the contents are formatted as a list of objects (e.g., `{ "has_wheelchair_accessible_entrance": [ "true" ]}`) **NOTE:** The latest Google Attributes are available via the Google Fields: List endpoint. Google Attributes are managed by Google and are subject to change without notice. To prevent errors, make sure your API implementation is not dependent on the presence of specific attributes. Filtering Type: `object` ``` Eligible For: * atm * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` googleCoverPhoto: required: - url additionalProperties: false type: object description: |- The cover photo for the entity's Google profile Image must be at least 250 x 250 pixels Filtering Type: `object` ``` Eligible For: * atm * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` properties: alternateText: minLength: 0 type: string description: 'Filtering Type: `text`' url: minLength: 0 format: uri type: string description: 'Filtering Type: `text`' googleMessaging: additionalProperties: false type: object properties: smsNumber: minLength: 0 type: string description: |- The SMS phone number of the entity's point of contact for messaging/ chat functionality. Must be a valid phone number. If the phone number's calling code is for a country other than the one given in the entity's countryCode, the phone number provided must contain the calling code (e.g., +44 in +442038083831). Otherwise, the calling code is optional. Filtering Type: `text` whatsappMessagingUrl: minLength: 0 maxLength: 2000 format: uri type: string description: |- A valid URL for this entity's WhatsApp account. Must be a valid URL Filtering Type: `text` description: |- Information about Google Messaging, WhatsApp and SMS, for the entity’s point of contact for messaging/chat functionality. NOTE: Only one, either WhatsApp or SMS is displayed on the Google listing. If both SMS Number and WhatsApp URL are provided only SMS Number will be displayed on the listing. Filtering Type: `object` ``` Eligible For: * atm * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` googleMyBusinessLabels: description: |- Google Business Profile Labels help users organize their locations into groups within GBP. Array must be ordered. Array may have a maximum of 10 elements. Array item description: >Cannot Include: >* HTML markup Filtering Type: `list of text` ``` Eligible For: * atm * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` uniqueItems: true type: array items: minLength: 0 maxLength: 50 type: string description: |- Cannot Include: * HTML markup Filtering Type: `text` googlePlaceId: minLength: 0 type: string description: |- The unique identifier of this entity on Google Maps. Filtering Type: `text` ``` Eligible For: * atm * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` googleProfilePhoto: required: - url additionalProperties: false type: object description: |- The profile photo for the entity's Google profile Image must be at least 250 x 250 pixels Image may be no more than 5000 x 5000 pixels Supported Aspect Ratios: * 1 x 1 **NOTE**: Maximum image size is 5mb after normalization and padding (if applicable). As well, there is a 6 second download limit from the image host. Filtering Type: `object` ``` Eligible For: * atm * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` properties: alternateText: minLength: 0 type: string description: 'Filtering Type: `text`' url: minLength: 0 format: uri type: string description: 'Filtering Type: `text`' googleWebsiteOverride: minLength: 0 format: uri type: string description: |- 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. Filtering Type: `text` ``` Eligible For: * atm * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` happyHours: additionalProperties: false type: object properties: friday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the happy hours are "closed" on Friday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity's happy hours on Friday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' holidayHours: description: |- **NOTE:** The list of Holiday Hours that you send us must be comprehensive. For example, if you send us a list of Holiday Hours that does not include Holiday Hours that you sent in your last update, Yext considers the missing Holiday Hours to be deleted, and we remove them. Array must be ordered. Filtering Type: `list of object` uniqueItems: true type: array items: required: - date additionalProperties: false type: object properties: date: format: date type: string description: |- Date on which the holiday hours will be in effect. Cannot be in the past. Date must be on or after 1970-01-01 Date must be before or on 2038-01-01 Filtering Type: `date` isClosed: type: boolean description: |- Indicates if the happy hours are "closed" on on the given date. Filtering Type: `boolean` isRegularHours: type: boolean description: |- Indicates whether the holiday hours are the same as the regular business hours for the given date. If set to true, we will update the holiday hours if the regular business hours change for the date's day of the week. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for the Entity's happy hours on the specified date. Filtering Type: `list of object` description: 'Filtering Type: `object`' monday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the happy hours are "closed" on Monday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for the Entity's happy hours on Monday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' reopenDate: format: date type: string description: |- Date must be on or after 1970-01-01 Date must be before or on 2038-01-01 Filtering Type: `date` saturday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the happy hours are "closed" on Saturday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for the Entity's happy hours on Saturday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' sunday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the happy hours are "closed" on Sunday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for the Entity's happy hours on Sunday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' thursday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the happy hours are "closed" on Thursday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for the Entity's happy hours on Thursday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' tuesday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the happy hours are "closed" on Tuesday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for the Entity's happy hours on Tuesday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' wednesday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the happy hours are "closed" on Wednesday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for the Entity's happy hours on Wednesday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' description: |- Contains the daily happy hours, holiday happy hours, and reopen date for the Entity. Each day is represented by a sub-field of `happyHours`. (e.g. `monday`, `tuesday`, etc.) Open times can be specified per day through the `openIntervals` field and the `isClosed` flag. Similarly, holiday happy hours are represented by the `holidayHours` sub-field. Setting the `reopenDate` sub-field indicates that the business is temporarily closed and will reopen on the specified date. SPECIAL CASES: * To indicate that an Entity is open 24 hours on a specific day, set start to 00:00 and end to 23:59 in `openIntervals` for that day. * To indicate that an Entity has split hours on a specific day (e.g., open from 9:00 AM to 12:00 PM and again from 1:00 PM to 5:00 PM), supply two or more `openIntervals` values with non-overlapping sets of hours. * If you are providing `openIntervals`, you may not set `isClosed` to true for that day. Filtering Type: `hours` ``` Eligible For: * hotel * location * restaurant ``` headshot: required: - url additionalProperties: false type: object description: |- A portrait of the healthcare professional Filtering Type: `object` ``` Eligible For: * contactCard * financialProfessional * healthcareProfessional ``` properties: alternateText: minLength: 0 type: string description: 'Filtering Type: `text`' url: minLength: 0 format: uri type: string description: 'Filtering Type: `text`' hiringOrganization: minLength: 0 type: string description: |- The organization that is hiring for the open job Filtering Type: `text` ``` Eligible For: * job ``` holidayHoursConversationEnabled: type: boolean description: |- Indicates whether holiday-hour confirmation alerts are enabled for the Yext Knowledge Assistant for this entity Filtering Type: `boolean` ``` Eligible For: * atm * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` horsebackRiding: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity offers horseback riding. Filtering Type: `option` ``` Eligible For: * hotel ``` hotTub: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity has a hot tub. Filtering Type: `option` ``` Eligible For: * hotel ``` hours: additionalProperties: false type: object properties: friday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the hours of operation are "closed" on Friday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is open on Friday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' holidayHours: description: |- **NOTE:** The list of Holiday Hours that you send us must be comprehensive. For example, if you send us a list of Holiday Hours that does not include Holiday Hours that you sent in your last update, Yext considers the missing Holiday Hours to be deleted, and we remove them. Array must be ordered. Filtering Type: `list of object` uniqueItems: true type: array items: required: - date additionalProperties: false type: object properties: date: format: date type: string description: |- Date on which the holiday hours will be in effect. Cannot be in the past. Date must be on or after 1970-01-01 Date must be before or on 2038-01-01 Filtering Type: `date` isClosed: type: boolean description: |- Indicates if the hours of operation are "closed" on on the given date. Filtering Type: `boolean` isRegularHours: type: boolean description: |- Indicates whether the holiday hours are the same as the regular business hours for the given date. If set to true, we will update the holiday hours if the regular business hours change for the date's day of the week. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is open on the specified date. Filtering Type: `list of object` description: 'Filtering Type: `object`' monday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the hours of operation are "closed" on Monday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is open on Monday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' reopenDate: format: date type: string description: |- Date must be on or after 1970-01-01 Date must be before or on 2038-01-01 Filtering Type: `date` saturday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the hours of operation are "closed" on Saturday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is open on Saturday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' sunday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the hours of operation are "closed" on Sunday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is open on Sunday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' thursday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the hours of operation are "closed" on Thursday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is open on Thursday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' tuesday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the hours of operation are "closed" on Tuesday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is open on Tuesday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' wednesday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the hours of operation are "closed" on Wednesday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is open on Wednesday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' description: |- Contains the daily hours, holiday hours, and reopen date for the Entity. Each day is represented by a sub-field of `hours`. (e.g. `monday`, `tuesday`, etc.) Open times can be specified per day through the `openIntervals` field and the `isClosed` flag. Similarly, holiday hours are represented by the `holidayHours` sub-field. Setting the `reopenDate` sub-field indicates that the business is temporarily closed and will reopen on the specified date. SPECIAL CASES: * To indicate that an Entity is open 24 hours on a specific day, set start to 00:00 and end to 23:59 in `openIntervals` for that day. * To indicate that an Entity has split hours on a specific day (e.g., open from 9:00 AM to 12:00 PM and again from 1:00 PM to 5:00 PM), supply two or more `openIntervals` values with non-overlapping sets of hours. * If you are providing `openIntervals`, you may not set `isClosed` to true for that day. Filtering Type: `hours` ``` Eligible For: * atm * contactCard * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` housekeeping: enum: - HOUSEKEEPING_AVAILABLE - HOUSEKEEPING_AVAILABLE_DAILY - NOT_APPLICABLE type: string description: |- Indicates whether the entity offers housekeeping services. Filtering Type: `option` ``` Eligible For: * hotel ``` impressum: minLength: 0 maxLength: 2000 type: string description: |- A statement of the ownership and authorship of a document. Individuals or organizations based in many German-speaking countries are required by law to include an Impressum in published media. Filtering Type: `text` ``` Eligible For: * atm * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` indoorPoolCount: multipleOf: 1 minimum: 0 type: number description: |- A count of the number of indoor pools Filtering Type: `integer` ``` Eligible For: * hotel ``` instagramHandle: minLength: 0 maxLength: 30 type: string description: |- Valid Instagram username for the entity without the leading "@" (e.g., `NewCityAuto`) Filtering Type: `text` ``` Eligible For: * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * organization * restaurant ``` insuranceAccepted: description: |- A list of insurance policies accepted by the healthcare provider Array must be ordered. Array may have a maximum of 100 elements. Array item description: >Cannot Include: >* HTML markup Filtering Type: `list of text` ``` Eligible For: * healthcareFacility * healthcareProfessional ``` uniqueItems: true type: array items: minLength: 0 maxLength: 100 type: string description: |- Cannot Include: * HTML markup Filtering Type: `text` iosAppUrl: minLength: 0 type: string description: |- The URL where consumers can download the entity's app to their iPhone or iPad Filtering Type: `text` ``` Eligible For: * brand * financialProfessional * hotel * location * restaurant ``` isClusterPrimary: type: boolean description: |- Indicates whether the healthcare entity is the primary entity in its group Filtering Type: `boolean` ``` Eligible For: * healthcareProfessional ``` isFreeEvent: type: boolean description: |- Indicates whether or not the event is free Filtering Type: `boolean` ``` Eligible For: * event ``` isoRegionCode: minLength: 0 type: string description: |- The ISO 3166-2 region code for the entity Yext will determine the entity's code and update **`isoRegionCode`** with that value. If Yext is unable to determine the code for the entity, the entity'ss ISO 3166-1 alpha-2 country code will be used. Filtering Type: `text` ``` Eligible For: * atm * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` keywords: description: |- Keywords that describe the entity. All strings must be non-empty when trimmed of whitespace. Array must be ordered. Array may have a maximum of 100 elements. Array item description: >Cannot Include: >* HTML markup Filtering Type: `list of text` ``` Eligible For: * atm * card * event * faq * financialProfessional * healthcareFacility * healthcareProfessional * helpArticle * hotel * job * location * product * restaurant ``` uniqueItems: true type: array items: minLength: 0 maxLength: 100 type: string description: |- Cannot Include: * HTML markup Filtering Type: `text` kidFriendly: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates if the entity is kid friendly. Filtering Type: `option` ``` Eligible For: * hotel ``` kidsClub: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates if the property has a Kids Club. Filtering Type: `option` ``` Eligible For: * hotel ``` kidsStayFree: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity allows kids to stay free. Filtering Type: `option` ``` Eligible For: * hotel ``` kitchenHours: additionalProperties: false type: object properties: friday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the kitchen hours are "closed" on Friday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity's kitchen is open on Friday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' holidayHours: description: |- **NOTE:** The list of Holiday Hours that you send us must be comprehensive. For example, if you send us a list of Holiday Hours that does not include Holiday Hours that you sent in your last update, Yext considers the missing Holiday Hours to be deleted, and we remove them. Array must be ordered. Filtering Type: `list of object` uniqueItems: true type: array items: required: - date additionalProperties: false type: object properties: date: format: date type: string description: |- Date on which the holiday hours will be in effect. Cannot be in the past. Date must be on or after 1970-01-01 Date must be before or on 2038-01-01 Filtering Type: `date` isClosed: type: boolean description: |- Indicates if the kitchen hours are "closed" on on the given date. Filtering Type: `boolean` isRegularHours: type: boolean description: |- Indicates whether the holiday hours are the same as the regular business hours for the given date. If set to true, we will update the holiday hours if the regular business hours change for the date's day of the week. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity's kitchen is open on the specified date. Filtering Type: `list of object` description: 'Filtering Type: `object`' monday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the kitchen hours are "closed" on Monday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity's kitchen is open on Monday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' reopenDate: format: date type: string description: |- Date must be on or after 1970-01-01 Date must be before or on 2038-01-01 Filtering Type: `date` saturday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the kitchen hours are "closed" on Saturday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity's kitchen is open on Saturday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' sunday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the kitchen hours are "closed" on Sunday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity's kitchen is open on Sunday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' thursday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the kitchen hours are "closed" on Thursday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity's kitchen is open on Thursday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' tuesday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the kitchen hours are "closed" on Tuesday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity's kitchen open on Tuesday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' wednesday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the kitchen hours are "closed" on Wednesday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity's kitchen is open on Wednesday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' description: |- Contains the daily kitchen hours, holiday kitchen hours, and reopen date for the Entity. Each day is represented by a sub-field of `kitchenHours`. (e.g. `monday`, `tuesday`, etc.) Open times can be specified per day through the `openIntervals` field and the `isClosed` flag. Similarly, holiday kitchen hours are represented by the `holidayHours` sub-field. Setting the `reopenDate` sub-field indicates that the business is temporarily closed and will reopen on the specified date. SPECIAL CASES: * To indicate that an Entity is open 24 hours on a specific day, set start to 00:00 and end to 23:59 in `openIntervals` for that day. * To indicate that an Entity has split hours on a specific day (e.g., open from 9:00 AM to 12:00 PM and again from 1:00 PM to 5:00 PM), supply two or more `openIntervals` values with non-overlapping sets of hours. * If you are providing `openIntervals`, you may not set `isClosed` to true for that day. Filtering Type: `hours` ``` Eligible For: * hotel * location * restaurant ``` labels: uniqueItems: false type: array items: minLength: 0 type: string description: |- The IDs of the entity labels that have been added to this entity. Entity labels help you identify entities that share a certain characteristic; they do not appear on your entity'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. Filtering Type: `opaque` ``` Eligible For: * atm * board * brand * card * contactCard * event * faq * financialProfessional * healthcareFacility * healthcareProfessional * helpArticle * hotel * hotelRoomType * job * location * organization * product * restaurant ``` landingPageUrl: minLength: 0 format: uri type: string description: |- The URL of this entity's Landing Page that was created with Yext Pages Filtering Type: `text` ``` Eligible For: * atm * card * event * faq * financialProfessional * healthcareFacility * healthcareProfessional * helpArticle * hotel * job * location * product * restaurant ``` languages: description: |- The langauges in which consumers can commicate with this entity or its staff members All strings must be non-empty when trimmed of whitespace. Array must be ordered. Array may have a maximum of 100 elements. Array item description: >Cannot Include: >* HTML markup Filtering Type: `list of text` ``` Eligible For: * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` uniqueItems: true type: array items: minLength: 0 maxLength: 100 type: string description: |- Cannot Include: * HTML markup Filtering Type: `text` lastName: minLength: 0 maxLength: 35 type: string description: |- The last name of the healthcare professional Cannot Include: * a URL or domain name * HTML markup Filtering Type: `text` ``` Eligible For: * healthcareProfessional ``` laundry: enum: - FULL_SERVICE - SELF_SERVICE - NOT_APPLICABLE type: string description: |- Indicates whether the entity offers laundry services. Filtering Type: `option` ``` Eligible For: * hotel ``` lazyRiver: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates if the property has a lazy river Filtering Type: `option` ``` Eligible For: * hotel ``` lifeguard: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates if the property has a lifeguard on duty Filtering Type: `option` ``` Eligible For: * hotel ``` linkedInUrl: minLength: 0 format: uri type: string description: |- URL for your LinkedIn account, format should be https://www.linkedin.com/in/yourUsername Filtering Type: `text` ``` Eligible For: * contactCard * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * organization * restaurant ``` linkedLocation: type: string description: |- location ID of the event location, if the event is held at a location managed in the Yext Knowledge Manager Filtering Type: `entityId` ``` Eligible For: * contactCard * event ``` localPhone: minLength: 0 type: string description: |- Must be a valid, non-toll-free phone number, based on the country specified in **`address.region`**. Phone numbers for US entities must contain 10 digits. Filtering Type: `text` ``` Eligible For: * atm * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` localShuttle: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity offers local shuttle services. Filtering Type: `option` ``` Eligible For: * hotel ``` locatedIn: type: string description: |- For atms, the external ID of the entity that the atm is installed in. The entity must be in the same business account as the atm. Filtering Type: `entityId` ``` Eligible For: * atm ``` location: additionalProperties: false type: object properties: existingLocation: type: string description: |- A location entity referenced by Yext ID or Entity ID where this job opening exists Filtering Type: `entityId` externalLocation: minLength: 0 maxLength: 255 type: string description: |- A location string where this job opening exists Cannot Include: * a URL or domain name * HTML markup Filtering Type: `text` description: |- The location where this job opening exists as either an existing location or an external location Filtering Type: `object` ``` Eligible For: * job ``` locationType: enum: - LOCATION - HEALTHCARE_FACILITY - HEALTHCARE_PROFESSIONAL - ATM - RESTAURANT - HOTEL type: string description: |- Indicates the entity's type, if it is not an event Filtering Type: `option` ``` Eligible For: * atm * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` logo: required: - image additionalProperties: false type: object description: |- An image of the entity's logo Supported Aspect Ratios: * 1 x 1 **NOTE**: Maximum image size is 5mb after normalization and padding (if applicable). As well, there is a 6 second download limit from the image host. Filtering Type: `object` ``` Eligible For: * atm * contactCard * faq * financialProfessional * healthcareFacility * healthcareProfessional * hotel * job * location * organization * restaurant ``` properties: clickthroughUrl: minLength: 0 format: uri type: string description: 'Filtering Type: `text`' description: minLength: 0 type: string description: 'Filtering Type: `text`' details: minLength: 0 type: string description: 'Filtering Type: `text`' image: required: - url additionalProperties: false type: object description: |- Supported Aspect Ratios: * 1 x 1 **NOTE**: Maximum image size is 5mb after normalization and padding (if applicable). As well, there is a 6 second download limit from the image host. Filtering Type: `object` properties: alternateText: minLength: 0 type: string description: 'Filtering Type: `text`' url: minLength: 0 format: uri type: string description: 'Filtering Type: `text`' mainPhone: minLength: 0 type: string description: |- The main phone number of the entity's point of contact Must be a valid phone number. If the phone number's calling code is for a country other than the one given in the entity's **`countryCode`**, the phone number provided must contain the calling code (e.g., `+44` in `+442038083831`). Otherwise, the calling code is optional. Filtering Type: `text` ``` Eligible For: * atm * contactCard * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * organization * restaurant ``` massage: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity offers massage services. Filtering Type: `option` ``` Eligible For: * hotel ``` maxAgeOfKidsStayFree: multipleOf: 1 minimum: 0 type: number description: |- The maximum age specified by the property for children to stay in the room/suite of a parent or adult without an additional fee Filtering Type: `integer` ``` Eligible For: * hotel ``` maxNumberOfKidsStayFree: multipleOf: 1 minimum: 0 type: number description: |- The maximum number of children who can stay in the room/suite of a parent or adult without an additional fee Filtering Type: `integer` ``` Eligible For: * hotel ``` mealsServed: uniqueItems: true type: array items: enum: - BREAKFAST - LUNCH - BRUNCH - DINNER - HAPPY_HOUR - LATE_NIGHT type: string description: 'Filtering Type: `option`' description: |- Types of meals served at this restaurant Filtering Type: `list of option` ``` Eligible For: * restaurant ``` meetingRoomCount: multipleOf: 1 minimum: 0 type: number description: |- The number of meeting rooms the entity has. Filtering Type: `integer` ``` Eligible For: * hotel ``` menuUrl: additionalProperties: false type: object properties: displayUrl: minLength: 0 maxLength: 2000 format: uri type: string description: |- The URL that is shown on your listings in place of **`menuUrl.url`**. You can use **`menuUrl.displayUrl`** to display a short, memorable web address that redirects consumers to the URL given in **`menuUrl.url`**. Filtering Type: `text` preferDisplayUrl: type: boolean description: |- If set to true, only the display URL will be sent to those publishers who do not support separate display and tracking URLs for this field. Filtering Type: `boolean` url: minLength: 0 maxLength: 2000 format: uri type: string description: |- A valid URL where consumers can view the entity's menu Filtering Type: `text` description: |- Information about the URL where consumers can view the entity's menu Filtering Type: `object` ``` Eligible For: * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` menus: additionalProperties: false type: object properties: ids: description: |- IDs of the Menu Lists associated with this entity Array must be ordered. Array may have a maximum of 40 elements. Filtering Type: `list of text` uniqueItems: true type: array items: minLength: 0 type: string description: 'Filtering Type: `text`' label: minLength: 0 maxLength: 30 type: string description: |- Label to be used for this entity's Menu Lists. This label will appear on your entity's listings. Filtering Type: `text` description: |- Information about the Menu Content Lists associated with this entity Filtering Type: `object` ``` Eligible For: * hotel * location * restaurant ``` middleName: minLength: 0 maxLength: 35 type: string description: |- The middle name of the healthcare professional Cannot Include: * a URL or domain name * HTML markup Filtering Type: `text` ``` Eligible For: * healthcareProfessional ``` mobilePhone: minLength: 0 type: string description: |- Must be a valid phone number. If the phone number's calling code is for a country other than the one given in the entity's **`countryCode`**, the phone number provided must contain the calling code (e.g., `+44` in `+442038083831`). Otherwise, the calling code is optional. Filtering Type: `text` ``` Eligible For: * atm * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` mobilityAccessible: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity is mobility/wheelchair accessible Filtering Type: `option` ``` Eligible For: * hotel ``` nightclub: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity has a nightclub. Filtering Type: `option` ``` Eligible For: * hotel ``` npi: minLength: 0 type: string description: |- The National Provider Identifier (NPI) of the healthcare provider Filtering Type: `text` ``` Eligible For: * healthcareFacility * healthcareProfessional ``` nudgeEnabled: type: boolean description: |- Indicates whether Knowledge Nudge is enabled for the Yext Knowledge Assistant for this entity Filtering Type: `boolean` ``` Eligible For: * atm * faq * financialProfessional * healthcareFacility * healthcareProfessional * helpArticle * hotel * job * location * organization * product * restaurant ``` officeName: minLength: 0 type: string description: |- The name of the office where the healthcare professional works, if different from **`name`** Filtering Type: `text` ``` Eligible For: * healthcareProfessional ``` onlineServiceHours: additionalProperties: false type: object properties: friday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the online service hours are "closed" on Friday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for the Entity's online service hours on Friday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' holidayHours: description: |- **NOTE:** The list of Holiday Hours that you send us must be comprehensive. For example, if you send us a list of Holiday Hours that does not include Holiday Hours that you sent in your last update, Yext considers the missing Holiday Hours to be deleted, and we remove them. Array must be ordered. Filtering Type: `list of object` uniqueItems: true type: array items: required: - date additionalProperties: false type: object properties: date: format: date type: string description: |- Date on which the holiday hours will be in effect. Cannot be in the past. Date must be on or after 1970-01-01 Date must be before or on 2038-01-01 Filtering Type: `date` isClosed: type: boolean description: |- Indicates if the online service hours are "closed" on on the given date. Filtering Type: `boolean` isRegularHours: type: boolean description: |- Indicates whether the holiday hours are the same as the regular business hours for the given date. If set to true, we will update the holiday hours if the regular business hours change for the date's day of the week. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for the Entity's online service hours on the specified date. Filtering Type: `list of object` description: 'Filtering Type: `object`' monday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the online service hours are "closed" on Monday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for the Entity's online service hours on Monday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' reopenDate: format: date type: string description: |- Date must be on or after 1970-01-01 Date must be before or on 2038-01-01 Filtering Type: `date` saturday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the online service hours are "closed" on Saturday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for the Entity's online service hours on Saturday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' sunday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the online service hours are "closed" on Sunday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for the Entity's online service hours on Sunday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' thursday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the online service hours are "closed" on Thursday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for the Entity's online service hours on Thursday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' tuesday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the online service hours are "closed" on Tuesday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for the Entity's online service hours on Tuesday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' wednesday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the online service hours are "closed" on Wednesday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for the Entity's online service hours on Wednesday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' description: |- Contains the daily online service hours, holiday online service hours, and reopen date for the Entity. Each day is represented by a sub-field of `onlineServiceHours`. (e.g. `monday`, `tuesday`, etc.) Open times can be specified per day through the `openIntervals` field and the `isClosed` flag. Similarly, holiday online service hours are represented by the `holidayHours` sub-field. Setting the `reopenDate` sub-field indicates that the business is temporarily closed and will reopen on the specified date. SPECIAL CASES: * To indicate that an Entity is open 24 hours on a specific day, set start to 00:00 and end to 23:59 in `openIntervals` for that day. * To indicate that an Entity has split hours on a specific day (e.g., open from 9:00 AM to 12:00 PM and again from 1:00 PM to 5:00 PM), supply two or more `openIntervals` values with non-overlapping sets of hours. * If you are providing `openIntervals`, you may not set `isClosed` to true for that day. Filtering Type: `hours` ``` Eligible For: * financialProfessional * healthcareFacility * healthcareProfessional * location * restaurant ``` openDate: format: date type: string description: |- The date that the entity is set to open for the first time. Must be formatted in YYYY-MM-DD format. Date must be on or after 1970-01-01 Date must be before or on 2038-01-01 Filtering Type: `date` ``` Eligible For: * atm * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` operatingCountries: uniqueItems: true type: array items: enum: - AD - AE - AF - AG - AI - AL - AM - AO - AR - AS - AT - AU - AW - AX - AZ - BA - BB - BD - BE - BF - BG - BH - BI - BJ - BL - BM - BN - BO - BQ - BR - BS - BT - BW - BY - BZ - CA - CD - CF - CG - CH - CI - CK - CL - CM - CN - CO - CR - CU - CV - CW - CY - CZ - DE - DJ - DK - DM - DO - DZ - EC - EE - EG - EH - ER - ES - ET - FI - FJ - FK - FM - FO - FR - GA - GB - GD - GE - GF - GG - GH - GI - GL - GM - GN - GP - GQ - GR - GT - GU - GW - GY - HK - HN - HR - HT - HU - ID - IE - IL - IM - IN - IQ - IR - IS - IT - JE - JM - JO - JP - KE - KG - KH - KI - KM - KN - KR - KW - KY - KZ - LA - LB - LC - LI - LK - LR - LS - LT - LU - LV - LY - MA - MC - MD - ME - MF - MG - MH - MK - ML - MM - MN - MO - MP - MQ - MR - MS - MT - MU - MV - MW - MX - MY - MZ - NA - NC - NE - NG - NI - NL - 'NO' - NP - NR - NZ - OM - PA - PE - PF - PG - PH - PK - PL - PM - PR - PS - PT - PW - PY - QA - RE - RO - RS - RU - RW - SA - SB - SC - SD - SE - SG - SH - SI - SJ - SK - SL - SM - SN - SO - SR - SS - ST - SV - SX - SY - SZ - TC - TD - TG - TH - TJ - TL - TM - TN - TO - TR - TT - TV - TW - TZ - UA - UG - US - UY - UZ - VA - VC - VE - VG - VI - VN - VU - WF - WS - XK - YE - YT - ZA - ZM - ZW type: string description: 'Filtering Type: `option`' description: |- The list of countries the business operates in Filtering Type: `list of option` ``` Eligible For: * organization ``` orderUrl: additionalProperties: false type: object properties: displayUrl: minLength: 0 maxLength: 2000 format: uri type: string description: |- The URL that is shown on your listings in place of **`orderUrl.url`**. You can use **`orderUrl.displayUrl`** to display a short, memorable web address that redirects consumers to the URL given in **`orderUrl.url`**. Filtering Type: `text` preferDisplayUrl: type: boolean description: |- If set to true, only the display URL will be sent to those publishers who do not support separate display and tracking URLs for this field. Filtering Type: `boolean` url: minLength: 0 maxLength: 2000 format: uri type: string description: |- A valid URL used to place an order at this entity Filtering Type: `text` description: |- Information about the URL used to place orders that will be fulfilled by the entity Filtering Type: `object` ``` Eligible For: * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` organizerEmail: minLength: 0 format: email type: string description: |- Point of contact for the event organizer (not to be published publicly) Filtering Type: `text` ``` Eligible For: * event ``` organizerName: minLength: 0 type: string description: |- Point of contact for the event organizer (not to be published publicly) Filtering Type: `text` ``` Eligible For: * event ``` organizerPhone: minLength: 0 type: string description: |- Point of contact for the event organizer (not to be published publicly) Filtering Type: `text` ``` Eligible For: * event ``` outdoorPoolCount: multipleOf: 1 minimum: 0 type: number description: |- The number of outdoor pools the entity has. Filtering Type: `integer` ``` Eligible For: * hotel ``` parking: enum: - PARKING_AVAILABLE - PARKING_AVAILABLE_FOR_FREE - NOT_APPLICABLE type: string description: |- Indicates whether the entity offers parking services. Filtering Type: `option` ``` Eligible For: * hotel ``` paymentOptions: uniqueItems: true type: array items: enum: - AFTERPAY - ALIPAY - AMERICANEXPRESS - ANDROIDPAY - APPLEPAY - ATM - ATMQUICK - BACS - BANCONTACT - BANKDEPOSIT - BANKPAY - BGO - BITCOIN - Bar - CARTASI - CASH - CCS - CHECK - CHEQUESVACANCES - CONB - CONTACTLESSPAYME - CVVV - DEBITCARD - DEBITNOTE - DINERSCLUB - DIRECTDEBIT - DISCOVER - ECKARTE - ECOCHEQUE - EKENA - EMV - FINANCING - GIFTCARD - GOPAY - HAYAKAKEN - HEBAG - IBOD - ICCARDS - ICOCA - ID - IDEAL - INCA - INVOICE - JCB - JCoinPay - JKOPAY - KITACA - KLA - KLARNA - LINEPAY - MAESTRO - MANACA - MASTERCARD - MIPAY - MONIZZE - MPAY - Manuelle Lastsch - Merpay - NANACO - NEXI - NIMOCA - OREM - PASMO - PAYBACKPAY - PAYBOX - PAYCONIQ - PAYPAL - PAYPAY - PAYSEC - PIN - POSTEPAY - QRCODE - QUICPAY - RAKUTENEDY - RAKUTENPAY - SAMSUNGPAY - SODEXO - SUGOCA - SUICA - SWISH - TICKETRESTAURANT - TOICA - TRAVELERSCHECK - TSCUBIC - TWINT - UNIONPAY - VEV - VISA - VISAELECTRON - VOB - VOUCHER - VPAY - WAON - WECHATPAY - WIRETRANSFER - Yucho Pay - ZELLE - auPay - dBarai - Überweisung type: string description: 'Filtering Type: `option`' description: |- The payment methods accepted by this entity Valid elements depend on the entity's country. Filtering Type: `list of option` ``` Eligible For: * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` performers: description: |- Performers at the event Array must be ordered. Array may have a maximum of 100 elements. Filtering Type: `list of text` ``` Eligible For: * event ``` uniqueItems: true type: array items: minLength: 0 maxLength: 100 type: string description: 'Filtering Type: `text`' petsAllowed: enum: - PETS_WELCOME - PETS_WELCOME_FOR_FREE - NOT_APPLICABLE - NOT_ALLOWED type: string description: |- Indicates if the entity is pet friendly. Filtering Type: `option` ``` Eligible For: * hotel ``` photoGallery: description: |- **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. Array must be ordered. Array may have a maximum of 500 elements. Array item description: >Supported Aspect Ratios: >* 1 x 1 >* 4 x 3 >* 3 x 2 >* 5 x 3 >* 16 x 9 >* 3 x 1 >* 2 x 3 >* 5 x 7 >* 4 x 5 >* 4 x 1 > >**NOTE**: Maximum image size is 5mb after normalization and padding (if applicable). As well, there is a 6 second download limit from the image host. > Filtering Type: `list of object` ``` Eligible For: * atm * event * financialProfessional * healthcareFacility * healthcareProfessional * hotel * hotelRoomType * location * organization * product * restaurant ``` uniqueItems: false type: array items: required: - image additionalProperties: false type: object description: |- Supported Aspect Ratios: * 1 x 1 * 4 x 3 * 3 x 2 * 5 x 3 * 16 x 9 * 3 x 1 * 2 x 3 * 5 x 7 * 4 x 5 * 4 x 1 **NOTE**: Maximum image size is 5mb after normalization and padding (if applicable). As well, there is a 6 second download limit from the image host. Filtering Type: `object` properties: clickthroughUrl: minLength: 0 format: uri type: string description: 'Filtering Type: `text`' description: minLength: 0 type: string description: 'Filtering Type: `text`' details: minLength: 0 type: string description: 'Filtering Type: `text`' image: required: - url additionalProperties: false type: object description: |- Supported Aspect Ratios: * 1 x 1 * 4 x 3 * 3 x 2 * 5 x 3 * 16 x 9 * 3 x 1 * 2 x 3 * 5 x 7 * 4 x 5 * 4 x 1 **NOTE**: Maximum image size is 5mb after normalization and padding (if applicable). As well, there is a 6 second download limit from the image host. Filtering Type: `object` properties: alternateText: minLength: 0 type: string description: 'Filtering Type: `text`' url: minLength: 0 format: uri type: string description: 'Filtering Type: `text`' pickupCoordinate: additionalProperties: false type: object properties: latitude: minimum: -90 maximum: 90 type: number description: 'Filtering Type: `float`' longitude: minimum: -180 maximum: 180 type: number description: 'Filtering Type: `float`' description: |- Coordinates of where consumers can be picked up at the entity, as provided by you Filtering Type: `object` ``` Eligible For: * atm * event * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` pickupHours: additionalProperties: false type: object properties: friday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the pickup hours are "closed" on Friday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is open for pickup on Friday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' holidayHours: description: |- **NOTE:** The list of Holiday Hours that you send us must be comprehensive. For example, if you send us a list of Holiday Hours that does not include Holiday Hours that you sent in your last update, Yext considers the missing Holiday Hours to be deleted, and we remove them. Array must be ordered. Filtering Type: `list of object` uniqueItems: true type: array items: required: - date additionalProperties: false type: object properties: date: format: date type: string description: |- Date on which the holiday hours will be in effect. Cannot be in the past. Date must be on or after 1970-01-01 Date must be before or on 2038-01-01 Filtering Type: `date` isClosed: type: boolean description: |- Indicates if the pickup hours are "closed" on on the given date. Filtering Type: `boolean` isRegularHours: type: boolean description: |- Indicates whether the holiday hours are the same as the regular business hours for the given date. If set to true, we will update the holiday hours if the regular business hours change for the date's day of the week. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is open for pickup on the specified date. Filtering Type: `list of object` description: 'Filtering Type: `object`' monday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the pickup hours are "closed" on Monday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is open for pickup on Monday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' reopenDate: format: date type: string description: |- Date must be on or after 1970-01-01 Date must be before or on 2038-01-01 Filtering Type: `date` saturday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the pickup hours are "closed" on Saturday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is open for pickup on Saturday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' sunday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the pickup hours are "closed" on Sunday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is open for pickup on Sunday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' thursday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the pickup hours are "closed" on Thursday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is open for pickup on Thursday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' tuesday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the pickup hours are "closed" on Tuesday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is open for pickup on Tuesday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' wednesday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the pickup hours are "closed" on Wednesday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is open for pickup on Wednesday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' description: |- Contains the daily pickup hours, holiday pickup hours, and reopen date for the Entity. Each day is represented by a sub-field of `pickupHours`. (e.g. `monday`, `tuesday`, etc.) Open times can be specified per day through the `openIntervals` field and the `isClosed` flag. Similarly, holiday pickup hours are represented by the `holidayHours` sub-field. Setting the `reopenDate` sub-field indicates that the business is temporarily closed and will reopen on the specified date. SPECIAL CASES: * To indicate that an Entity is open 24 hours on a specific day, set start to 00:00 and end to 23:59 in `openIntervals` for that day. * To indicate that an Entity has split hours on a specific day (e.g., open from 9:00 AM to 12:00 PM and again from 1:00 PM to 5:00 PM), supply two or more `openIntervals` values with non-overlapping sets of hours. * If you are providing `openIntervals`, you may not set `isClosed` to true for that day. Filtering Type: `hours` ``` Eligible For: * healthcareFacility * location * restaurant ``` pinterestUrl: minLength: 0 format: uri type: string description: |- URL for your Pinterest account, format should be https://www.pinterest.com/yourUsername Filtering Type: `text` ``` Eligible For: * contactCard * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * organization * restaurant ``` priceRange: enum: - UNSPECIFIED - ONE - TWO - THREE - FOUR type: string description: |- he typical price of products sold by this location, on a scale of 1 (low) to 4 (high) Filtering Type: `option` ``` Eligible For: * atm * healthcareFacility * healthcareProfessional * location * restaurant ``` primaryConversationContact: minLength: 0 type: string description: |- ID of the user who is the primary Knowledge Assistant contact for the entity Filtering Type: `option` ``` Eligible For: * atm * faq * financialProfessional * healthcareFacility * healthcareProfessional * helpArticle * hotel * job * location * organization * product * restaurant ``` privateBeach: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity has access to a private beach. Filtering Type: `option` ``` Eligible For: * hotel ``` privateCarService: enum: - PRIVATE_CAR_SERVICE - PRIVATE_CAR_SERVICE_FOR_FREE - NOT_APPLICABLE type: string description: |- Indicates whether the entity offers private car services. Filtering Type: `option` ``` Eligible For: * hotel ``` productLists: additionalProperties: false type: object properties: ids: description: |- IDs of the Products & Services Lists associated with this entity Array must be ordered. Array may have a maximum of 40 elements. Filtering Type: `list of text` uniqueItems: true type: array items: minLength: 0 type: string description: 'Filtering Type: `text`' label: minLength: 0 maxLength: 30 type: string description: |- Label to be used for this entity's Products & Services Lists. This label will appear on your entity's listings. Filtering Type: `text` description: |- Information about the Products & Services Content Lists associated with this entity Filtering Type: `object` ``` Eligible For: * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` products: description: |- Products sold by this entity All strings must be non-empty when trimmed of whitespace. Array must be ordered. Array may have a maximum of 100 elements. Array item description: >Cannot Include: >* HTML markup Filtering Type: `list of text` ``` Eligible For: * financialProfessional * location ``` uniqueItems: true type: array items: minLength: 0 maxLength: 100 type: string description: |- Cannot Include: * HTML markup Filtering Type: `text` questionsAndAnswers: type: boolean description: |- Indicates whether Yext Knowledge Assistant question-and-answer conversations are enabled for this entity Filtering Type: `boolean` ``` Eligible For: * atm * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * organization * restaurant ``` rankTrackingCompetitors: description: |- Information about the competitors whose search performance you would like to compare to your own Array must be ordered. Array may have a maximum of 5 elements. Filtering Type: `list of object` ``` Eligible For: * atm * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * organization * restaurant ``` uniqueItems: true type: array items: required: - name - website additionalProperties: false type: object properties: name: minLength: 0 maxLength: 100 type: string description: |- A name of a competitor Cannot Include: * HTML markup Filtering Type: `text` website: minLength: 0 maxLength: 255 format: uri type: string description: |- The business website of a competitor Cannot Include: * common domain names, e.g., google.com, youtube.com, etc. Filtering Type: `text` description: 'Filtering Type: `object`' rankTrackingEnabled: type: boolean description: |- Indicates whether Rank Tracking is enabled Filtering Type: `boolean` ``` Eligible For: * atm * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * organization * restaurant ``` rankTrackingFrequency: enum: - WEEKLY - MONTHLY - QUARTERLY type: string description: |- How often we send search queries to track your search performance Filtering Type: `option` ``` Eligible For: * atm * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * organization * restaurant ``` rankTrackingQueryTemplates: description: |- The ways in which your keywords will be arranged in the search queries we use to track your performance Array must have a minimum of 2 elements. Array may have a maximum of 4 elements. Filtering Type: `list of option` ``` Eligible For: * atm * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * organization * restaurant ``` uniqueItems: true type: array items: enum: - KEYWORD - KEYWORD_ZIP - KEYWORD_CITY - KEYWORD_IN_CITY - KEYWORD_NEAR_ME - KEYWORD_CITY_STATE type: string description: 'Filtering Type: `option`' rankTrackingSites: uniqueItems: true type: array items: enum: - GOOGLE_DESKTOP - GOOGLE_MOBILE - BING_DESKTOP - BING_MOBILE - YAHOO_DESKTOP - YAHOO_MOBILE type: string description: 'Filtering Type: `option`' description: |- The search engines that we will use to track your performance Filtering Type: `list of option` ``` Eligible For: * atm * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * organization * restaurant ``` reservationUrl: additionalProperties: false type: object properties: displayUrl: minLength: 0 maxLength: 2000 format: uri type: string description: |- The URL that is shown on your listings in place of **`reservationUrl.url`**. You can use **`reservationUrl.displayUrl`** to display a short, memorable web address that redirects consumers to the URL given in **`reservationUrl.url`**. Must be a valid URL and be specified along with **`reservationUrl.url`**. Filtering Type: `text` preferDisplayUrl: type: boolean description: |- If set to true, only the display URL will be sent to those publishers who do not support separate display and tracking URLs for this field. Filtering Type: `boolean` url: minLength: 0 maxLength: 2000 format: uri type: string description: |- A valid URL used to make reservations at this entity Filtering Type: `text` description: |- Information about the URL consumers can visit to make reservations at this entity Filtering Type: `object` ``` Eligible For: * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` restaurantCount: multipleOf: 1 minimum: 0 type: number description: |- The number of restaurants the entity has. Filtering Type: `integer` ``` Eligible For: * hotel ``` reviewGenerationUrl: minLength: 0 type: string description: |- The URL given Review Invitation emails where consumers can leave a review about the entity ``` Eligible For: * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` reviewResponseConversationEnabled: type: boolean description: |- Indicates whether Yext Knowledge Assistant review-response conversations are enabled for this entity Filtering Type: `boolean` ``` Eligible For: * atm * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` roomCount: multipleOf: 1 minimum: 0 type: number description: |- The number of rooms the entity has. Filtering Type: `integer` ``` Eligible For: * hotel ``` roomService: enum: - ROOM_SERVICE_AVAILABLE - ROOM_SERVICE_AVAILABLE_24_HOURS - NOT_APPLICABLE type: string description: |- Indicates whether the entity offers room service. Filtering Type: `option` ``` Eligible For: * hotel ``` routableCoordinate: additionalProperties: false type: object properties: latitude: minimum: -90 maximum: 90 type: number description: 'Filtering Type: `float`' longitude: minimum: -180 maximum: 180 type: number description: 'Filtering Type: `float`' description: |- Destination coordinates to use for driving directions to the entity, as provided by you Filtering Type: `object` ``` Eligible For: * atm * event * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` salon: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity has a salon. Filtering Type: `option` ``` Eligible For: * hotel ``` sauna: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity has a sauna. Filtering Type: `option` ``` Eligible For: * hotel ``` scuba: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity offers scuba diving. Filtering Type: `option` ``` Eligible For: * hotel ``` selfParking: enum: - SELF_PARKING_AVAILABLE - SELF_PARKING_AVAILABLE_FOR_FREE - NOT_APPLICABLE type: string description: |- Indicates whether the entity offers self parking services. Filtering Type: `option` ``` Eligible For: * hotel ``` seniorHours: additionalProperties: false type: object properties: friday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the senior hours are "closed" on Friday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for the Entity's senior hours on Friday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' holidayHours: description: |- **NOTE:** The list of Holiday Hours that you send us must be comprehensive. For example, if you send us a list of Holiday Hours that does not include Holiday Hours that you sent in your last update, Yext considers the missing Holiday Hours to be deleted, and we remove them. Array must be ordered. Filtering Type: `list of object` uniqueItems: true type: array items: required: - date additionalProperties: false type: object properties: date: format: date type: string description: |- Date on which the holiday hours will be in effect. Cannot be in the past. Date must be on or after 1970-01-01 Date must be before or on 2038-01-01 Filtering Type: `date` isClosed: type: boolean description: |- Indicates if the senior hours are "closed" on on the given date. Filtering Type: `boolean` isRegularHours: type: boolean description: |- Indicates whether the holiday hours are the same as the regular business hours for the given date. If set to true, we will update the holiday hours if the regular business hours change for the date's day of the week. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for the Entity's senior hours on the specified date. Filtering Type: `list of object` description: 'Filtering Type: `object`' monday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the senior hours are "closed" on Monday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for the Entity's senior hours on Monday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' reopenDate: format: date type: string description: |- Date must be on or after 1970-01-01 Date must be before or on 2038-01-01 Filtering Type: `date` saturday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the senior hours are "closed" on Saturday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for the Entity's senior hours on Saturday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' sunday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the senior hours are "closed" on Sunday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for the Entity's senior hours on Sunday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' thursday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the senior hours are "closed" on Thursday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for the Entity's senior hours on Thursday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' tuesday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the senior hours are "closed" on Tuesday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for the Entity's senior hours on Tuesday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' wednesday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the senior hours are "closed" on Wednesday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for the Entity's senior hours on Wednesday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' description: |- Contains the daily senior hours, holiday senior hours, and reopen date for the Entity. Each day is represented by a sub-field of `seniorHours`. (e.g. `monday`, `tuesday`, etc.) Open times can be specified per day through the `openIntervals` field and the `isClosed` flag. Similarly, holiday senior hours are represented by the `holidayHours` sub-field. Setting the `reopenDate` sub-field indicates that the business is temporarily closed and will reopen on the specified date. SPECIAL CASES: * To indicate that an Entity is open 24 hours on a specific day, set start to 00:00 and end to 23:59 in `openIntervals` for that day. * To indicate that an Entity has split hours on a specific day (e.g., open from 9:00 AM to 12:00 PM and again from 1:00 PM to 5:00 PM), supply two or more `openIntervals` values with non-overlapping sets of hours. * If you are providing `openIntervals`, you may not set `isClosed` to true for that day. Filtering Type: `hours` ``` Eligible For: * location * restaurant ``` serviceArea: additionalProperties: false type: object properties: places: description: |- A list of places served by the entity, where each place is either: - a postal code, or - the name of a city. Array must be ordered. Array may have a maximum of 200 elements. Filtering Type: `list of text` uniqueItems: true type: array items: minLength: 0 maxLength: 100 type: string description: 'Filtering Type: `text`' description: |- Information about the area that is served by this entity. It is specified as a list of cities and/or postal codes. **Only for Google Business Profile and Bing:** Currently, **serviceArea** is only supported by Google Business Profile and Bing and will not affect your listings on other sites. Filtering Type: `object` ``` Eligible For: * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` serviceAreaPlaces: description: |- Information about the area that is served by this entity. It is specified as a list of service area names, their associated types and google place ids. **Only for Google Business Profile and Bing:** Currently, **serviceArea** is only supported by Google Business Profile and Bing and will not affect your listings on other sites. Array may have a maximum of 200 elements. Filtering Type: `list of object` ``` Eligible For: * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` uniqueItems: true type: array items: additionalProperties: false type: object properties: name: minLength: 0 maxLength: 100 type: string description: 'Filtering Type: `text`' googlePlaceId: minLength: 0 type: string description: 'Filtering Type: `text`' type: enum: - POSTAL_CODE - REGION - COUNTY - CITY - SUBLOCALITY type: string description: 'Filtering Type: `option`' description: 'Filtering Type: `object`' services: description: |- Services offered by this entity All strings must be non-empty when trimmed of whitespace. Array must be ordered. Array may have a maximum of 100 elements. Array item description: >Cannot Include: >* HTML markup Filtering Type: `list of text` ``` Eligible For: * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` uniqueItems: true type: array items: minLength: 0 maxLength: 100 type: string description: |- Cannot Include: * HTML markup Filtering Type: `text` smokeFreeProperty: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates if the entity is smoke free. Filtering Type: `option` ``` Eligible For: * hotel ``` snorkeling: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity offers snorkeling. Filtering Type: `option` ``` Eligible For: * hotel ``` socialHour: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity offers a social hour. Filtering Type: `option` ``` Eligible For: * hotel ``` spa: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity has a spa. Filtering Type: `option` ``` Eligible For: * hotel ``` specialities: description: |- Up to 100 of this entity's specialities (e.g., for food and dining: `Chicago style`) All strings must be non-empty when trimmed of whitespace. Array must be ordered. Array may have a maximum of 100 elements. Array item description: >Cannot Include: >* HTML markup Filtering Type: `list of text` ``` Eligible For: * financialProfessional * location * restaurant ``` uniqueItems: true type: array items: minLength: 0 maxLength: 100 type: string description: |- Cannot Include: * HTML markup Filtering Type: `text` tableService: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity has a sit-down restaurant. Filtering Type: `option` ``` Eligible For: * hotel ``` takeoutHours: additionalProperties: false type: object properties: friday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the takeout hours are "closed" on Friday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is open for takeout on Friday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' holidayHours: description: |- **NOTE:** The list of Holiday Hours that you send us must be comprehensive. For example, if you send us a list of Holiday Hours that does not include Holiday Hours that you sent in your last update, Yext considers the missing Holiday Hours to be deleted, and we remove them. Array must be ordered. Filtering Type: `list of object` uniqueItems: true type: array items: required: - date additionalProperties: false type: object properties: date: format: date type: string description: |- Date on which the holiday hours will be in effect. Cannot be in the past. Date must be on or after 1970-01-01 Date must be before or on 2038-01-01 Filtering Type: `date` isClosed: type: boolean description: |- Indicates if the takeout hours are "closed" on on the given date. Filtering Type: `boolean` isRegularHours: type: boolean description: |- Indicates whether the holiday hours are the same as the regular business hours for the given date. If set to true, we will update the holiday hours if the regular business hours change for the date's day of the week. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is open for takeout on the specified date. Filtering Type: `list of object` description: 'Filtering Type: `object`' monday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the takeout hours are "closed" on Monday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is open for takeout on Monday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' reopenDate: format: date type: string description: |- Date must be on or after 1970-01-01 Date must be before or on 2038-01-01 Filtering Type: `date` saturday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the takeout hours are "closed" on Saturday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is open for takeout on Saturday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' sunday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the takeout hours are "closed" on Sunday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is open for takeout on Sunday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' thursday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the takeout hours are "closed" on Thursday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is open for takeout on Thursday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' tuesday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the takeout hours are "closed" on Tuesday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is open for takeout on Tuesday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' wednesday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the takeout hours are "closed" on Wednesday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is open for takeout on Wednesday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' description: |- Contains the daily takeout hours, holiday takeout hours, and reopen date for the Entity. Each day is represented by a sub-field of `takeoutHours`. (e.g. `monday`, `tuesday`, etc.) Open times can be specified per day through the `openIntervals` field and the `isClosed` flag. Similarly, holiday takeout hours are represented by the `holidayHours` sub-field. Setting the `reopenDate` sub-field indicates that the business is temporarily closed and will reopen on the specified date. SPECIAL CASES: * To indicate that an Entity is open 24 hours on a specific day, set start to 00:00 and end to 23:59 in `openIntervals` for that day. * To indicate that an Entity has split hours on a specific day (e.g., open from 9:00 AM to 12:00 PM and again from 1:00 PM to 5:00 PM), supply two or more `openIntervals` values with non-overlapping sets of hours. * If you are providing `openIntervals`, you may not set `isClosed` to true for that day. Filtering Type: `hours` ``` Eligible For: * location * restaurant ``` tennis: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity has tennis courts. Filtering Type: `option` ``` Eligible For: * hotel ``` thermalPool: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity has a thermal pool. Filtering Type: `option` ``` Eligible For: * hotel ``` ticketAvailability: enum: - IN_STOCK - SOLD_OUT - PRE_ORDER - UNSPECIFIED type: string description: |- Information about the availability of tickets for the event Filtering Type: `option` ``` Eligible For: * event ``` ticketPriceRange: additionalProperties: false type: object properties: currencyCode: minLength: 0 type: string description: |- Three letter currency code (ISO standard) Filtering Type: `text` maxValue: pattern: ^\d*\.?\d*$ type: string description: |- Maximum ticket price Filtering Type: `decimal` minValue: pattern: ^\d*\.?\d*$ type: string description: |- Minimum ticket price Filtering Type: `decimal` description: |- Contains the price range for the event Filtering Type: `object` ``` Eligible For: * event ``` ticketSaleDateTime: format: date-time type: string description: |- The date/time tickets are available for sale (local time) Filtering Type: `datetime` ``` Eligible For: * event ``` ticketUrl: minLength: 0 format: uri type: string description: |- URL to purchase tickets for the event (if ticketed) Filtering Type: `text` ``` Eligible For: * event ``` tikTokUrl: minLength: 0 format: uri type: string description: |- URL for your TikTok profile, format should be https://www.tiktok.com/yourUsername Filtering Type: `text` ``` Eligible For: * contactCard * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * organization * restaurant ``` time: additionalProperties: false type: object properties: end: format: date-time type: string description: |- End date/time of the event, in local time (see timezone field) Standard ISO 8601 datetime without timezone Format: `YYYY-MM-DDThh:mm` Filtering Type: `datetime` start: format: date-time type: string description: |- Start date/time of the event, in local time (see timezone field) Standard ISO 8601 datetime without timezone Format: `YYYY-MM-DDThh:mm` Filtering Type: `datetime` description: |- Contains the start/end times for the event Filtering Type: `object` ``` Eligible For: * event ``` timeZoneUtcOffset: minLength: 0 type: string description: |- Represents the time zone offset of the entity from UTC, in `±hh:mm` format. For example, if the entity is 4 hours ahead of UTC time, the offset will be `+04:00`. If the entity is 15.5 hours behind UTC time, the offset will be `-15:30`. If the entity is in UTC time, the offset will be `+00:00`. ``` Eligible For: * atm * event * faq * healthcareFacility * healthcareProfessional * hotel * job * location * restaurant ``` timezone: minLength: 0 type: string description: |- The timezone of the entity, in the standard `IANA time zone database` format (tz database). e.g. `"America/New_York"` Filtering Type: `option` ``` Eligible For: * atm * board * card * contactCard * event * faq * financialProfessional * healthcareFacility * healthcareProfessional * helpArticle * hotel * hotelRoomType * job * location * organization * product * restaurant ``` tollFreePhone: minLength: 0 type: string description: |- Must be a valid phone number. If the phone number's calling code is for a country other than the one given in the entity's **`countryCode`**, the phone number provided must contain the calling code (e.g., `+44` in `+442038083831`). Otherwise, the calling code is optional. Filtering Type: `text` ``` Eligible For: * atm * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` treadmill: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity has a treadmill. Filtering Type: `option` ``` Eligible For: * hotel ``` ttyPhone: minLength: 0 type: string description: |- Must be a valid phone number. If the phone number's calling code is for a country other than the one given in the entity's **`countryCode`**, the phone number provided must contain the calling code (e.g., `+44` in `+442038083831`). Otherwise, the calling code is optional. Filtering Type: `text` ``` Eligible For: * atm * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` turndownService: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity offers turndown service. Filtering Type: `option` ``` Eligible For: * hotel ``` twitterHandle: minLength: 0 maxLength: 15 type: string description: |- Valid Twitter handle for the entity without the leading "@" (e.g., `JohnSmith`) 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. Filtering Type: `text` ``` Eligible For: * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * organization * restaurant ``` uberLink: required: - presentation additionalProperties: false type: object properties: presentation: enum: - BUTTON - LINK type: string description: |- Indicates whether the embedded Uber link for this entity 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 entity set as the trip destination. If the Uber app is not installed, the consumer will be prompted to download it. Filtering Type: `option` text: minLength: 0 maxLength: 100 type: string description: |- The text of the embedded Uber link Default is `Ride there with Uber`. **NOTE:** This field is only available if **`uberLink.presentation`** is `LINK`. Filtering Type: `text` description: |- Information about the Yext-powered link that can be copied and pasted into the markup of Yext Pages where the embedded Uber link should appear Filtering Type: `object` ``` Eligible For: * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` uberTripBranding: required: - text - url - description additionalProperties: false type: object properties: description: minLength: 0 maxLength: 150 type: string description: |- A longer description that will appear near the call-to-action in the Uber app during a trip to your entity. **NOTE:** If a value for **`uberTripBranding.description`** is provided, values must also be provided for **`uberTripBranding.text`** and **`uberTripBranding.url`**. Filtering Type: `text` text: minLength: 0 maxLength: 28 type: string description: |- The text of the call-to-action that will appear in the Uber app during a trip to your entity (e.g., `Check out our menu!`) **NOTE:** If a value for **`uberTripBranding.text`** is provided, values must also be provided for **`uberTripBranding.url`** and **`uberTripBranding.description`**. Filtering Type: `text` url: minLength: 0 format: uri type: string description: |- 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 entity. **NOTE:** If a value for **`uberTripBranding.url`** is provided, values must also be provided for **`uberTripBranding.text`** and **`uberTripBranding.description`**. Filtering Type: `text` description: |- Information about the call-to-action consumers will see in the Uber app during a trip to your entity Filtering Type: `object` ``` Eligible For: * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` valetParking: enum: - VALET_PARKING_AVAILABLE - VALET_PARKING_AVAILABLE_FOR_FREE - NOT_APPLICABLE type: string description: |- Indicates whether the entity offers valet parking services. Filtering Type: `option` ``` Eligible For: * hotel ``` validThrough: format: date-time type: string description: |- The date this entity is valid through. Filtering Type: `datetime` ``` Eligible For: * job ``` vendingMachine: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity has a vending machine. Filtering Type: `option` ``` Eligible For: * hotel ``` venueName: minLength: 0 type: string description: |- Name of the venue where the event is being held Filtering Type: `text` ``` Eligible For: * event ``` videos: description: |- Valid YouTube URLs for embedding a video on some publisher sites **NOTE:** Currently, only the first URL in the Array appears in your listings. Array must be ordered. Filtering Type: `list of object` ``` Eligible For: * financialProfessional * healthcareFacility * healthcareProfessional * hotel * hotelRoomType * location * organization * product * restaurant ``` uniqueItems: true type: array items: required: - video additionalProperties: false type: object properties: description: minLength: 0 maxLength: 140 type: string description: |- Cannot Include: * HTML markup Filtering Type: `text` video: required: - url additionalProperties: false type: object properties: url: minLength: 0 format: uri type: string description: 'Filtering Type: `text`' description: 'Filtering Type: `object`' description: 'Filtering Type: `object`' wadingPool: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity has a wading pool. Filtering Type: `option` ``` Eligible For: * hotel ``` wakeUpCalls: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity offers wake up call services. Filtering Type: `option` ``` Eligible For: * hotel ``` walkableCoordinate: additionalProperties: false type: object properties: latitude: minimum: -90 maximum: 90 type: number description: 'Filtering Type: `float`' longitude: minimum: -180 maximum: 180 type: number description: 'Filtering Type: `float`' description: |- Destination coordinates to use for walking directions to the entity, as provided by you Filtering Type: `object` ``` Eligible For: * atm * event * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` waterPark: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity has a water park. Filtering Type: `option` ``` Eligible For: * hotel ``` waterSkiing: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity offers water skiing. Filtering Type: `option` ``` Eligible For: * hotel ``` watercraft: enum: - WATERCRAFT_RENTALS - WATERCRAFT_RENTALS_FOR_FREE - NOT_APPLICABLE type: string description: |- Indicates whether the entity offers any kind of watercrafts. Filtering Type: `option` ``` Eligible For: * hotel ``` waterslide: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity has a water slide. Filtering Type: `option` ``` Eligible For: * hotel ``` wavePool: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity has a wave pool. Filtering Type: `option` ``` Eligible For: * hotel ``` websiteUrl: additionalProperties: false type: object properties: displayUrl: minLength: 0 maxLength: 2000 format: uri type: string description: |- The URL that is shown on your listings in place of **`websiteUrl.url`**. You can use **`websiteUrl.displayUrl`** to display a short, memorable web address that redirects consumers to the URL given in **`websiteUrl.url`**. Must be a valid URL and be specified along with **`websiteUrl.url`**. Filtering Type: `text` preferDisplayUrl: type: boolean description: |- If set to true, only the display URL will be sent to those publishers who do not support separate display and tracking URLs for this field. Filtering Type: `boolean` url: minLength: 0 maxLength: 2000 format: uri type: string description: |- A valid URL for this entity's website Filtering Type: `text` description: |- Information about the website for this entity Filtering Type: `object` ``` Eligible For: * atm * contactCard * event * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * organization * restaurant ``` weightMachine: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity has a weight machine. Filtering Type: `option` ``` Eligible For: * hotel ``` wheelchairAccessible: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates if the entity is wheelchair accessible. Filtering Type: `option` ``` Eligible For: * hotel ``` wifiAvailable: enum: - WIFI_AVAILABLE - WIFI_AVAILABLE_FOR_FREE - NOT_APPLICABLE type: string description: |- Indicates whether the entity has WiFi available Filtering Type: `option` ``` Eligible For: * hotel ``` workRemote: type: boolean description: |- Indicates whether the job is remote. Filtering Type: `boolean` ``` Eligible For: * job ``` yearEstablished: multipleOf: 1 minimum: 1000 maximum: 2028 type: number description: |- The year the entity was established. Filtering Type: `integer` ``` Eligible For: * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` yearLastRenovated: multipleOf: 1 minimum: 1000 maximum: 2028 type: number description: |- The most recent year the entity was partially or completely renovated. Filtering Type: `integer` ``` Eligible For: * hotel ``` yextDisplayCoordinate: additionalProperties: false type: object properties: latitude: minimum: -90 maximum: 90 type: number description: 'Filtering Type: `float`' longitude: minimum: -180 maximum: 180 type: number description: 'Filtering Type: `float`' description: |- Coordinates where the map pin for the entity should be displayed, as calculated by Yext Filtering Type: `object` ``` Eligible For: * atm * event * financialProfessional * healthcareFacility * healthcareProfessional * hotel * job * location * restaurant ``` yextDropoffCoordinate: additionalProperties: false type: object properties: latitude: minimum: -90 maximum: 90 type: number description: 'Filtering Type: `float`' longitude: minimum: -180 maximum: 180 type: number description: 'Filtering Type: `float`' description: |- Coordinates of where consumers can be dropped off at the entity, as calculated by Yext Filtering Type: `object` ``` Eligible For: * atm * event * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` yextPickupCoordinate: additionalProperties: false type: object properties: latitude: minimum: -90 maximum: 90 type: number description: 'Filtering Type: `float`' longitude: minimum: -180 maximum: 180 type: number description: 'Filtering Type: `float`' description: |- Coordinates of where consumers can be picked up at the entity, as calculated by Yext Filtering Type: `object` ``` Eligible For: * atm * event * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` yextRoutableCoordinate: additionalProperties: false type: object properties: latitude: minimum: -90 maximum: 90 type: number description: 'Filtering Type: `float`' longitude: minimum: -180 maximum: 180 type: number description: 'Filtering Type: `float`' description: |- Destination coordinates to use for driving directions to the entity, as calculated by Yext Filtering Type: `object` ``` Eligible For: * atm * event * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` yextWalkableCoordinate: additionalProperties: false type: object properties: latitude: minimum: -90 maximum: 90 type: number description: 'Filtering Type: `float`' longitude: minimum: -180 maximum: 180 type: number description: 'Filtering Type: `float`' description: |- Destination coordinates to use for walking directions to the entity, as calculated by Yext Filtering Type: `object` ``` Eligible For: * atm * event * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` youTubeChannelUrl: minLength: 0 format: uri type: string description: |- URL for your YouTube channel, format should be https://www.youtube.com/c/yourUsername Filtering Type: `text` ``` Eligible For: * contactCard * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * organization * restaurant ``` headers: {} '400': description: Error Response content: application/json: schema: additionalProperties: false type: object properties: meta: additionalProperties: false type: object properties: errors: uniqueItems: false type: array items: additionalProperties: false type: object properties: code: multipleOf: 1 type: number description: | Code that uniquely identifies the error or warning. message: minLength: 0 type: string description: Message explaining the problem. type: enum: - FATAL_ERROR - NON_FATAL_ERROR - WARNING type: string description: List of errors and warnings. uuid: minLength: 0 type: string description: 'Filtering Type: `object`' headers: {} /accounts/{accountId}/entities/geosearch: get: operationId: geoSearchEntities parameters: - schema: minLength: 0 type: string name: accountId in: path required: true - schema: minLength: 0 type: string description: | Only entities near this position will be returned. The values can be specified in one of two ways: 1) Latitude and Longitude: The latitude and longitude of the point, separated by a comma (e.g.`"40.740957,-73.987565"`), 2) Address: A free-form address to geocode into a latitude and longitude (e.g., `"1 Madison Ave, New York, NY 10010"` or `"New York, NY"`). Note that providing an address that resolves to an area, like a city or a postal code, does not restrict the search to exactly that area; it simply centers the search circle on a point in that area. name: location in: query required: true - schema: minLength: 0 type: string description: A date in `YYYYMMDD` format. name: v in: query required: true - schema: minLength: 0 type: string description: | The two-character ISO 3166-1 code of the country where the geocoder should be biased. The value of the **`countryBias`** parameter influences the search results, but it does not guarantee that the geocoded location will be in the country provided. If both **`countryBias`** and **`geocoderBias`** are provided, **`geocoderBias`** is given priority, but both values are considered in the search. name: countryBias in: query required: false - schema: minLength: 0 type: string description: | Comma-separated list of Entity types to filter on. Example: `"location,event"` Should be from the following types: * `atm` * `event` * `faq` * `financialProfessional` * `healthcareFacility` * `healthcareProfessional` * `hotel` * `hotelRoomType` * `job` * `location` * `organization` * `product` * `restaurant` OR the API name of a custom entity type. name: entityTypes in: query required: false - schema: minLength: 0 type: string description: Comma-separated list of field names. When present, only the fields listed will be returned. You can use dot notation to specify substructures (e.g., `"address.line1"`). Custom fields are specified in the same way, albeit with their `c_*` name. name: fields in: query required: false - schema: minLength: 0 type: string description: | This parameter represents one or more filtering conditions that are applied to the set of entities that would otherwise be returned. This parameter should be provided as a URL-encoded string containing a JSON object. For example, if the filter JSON is `{"name":{"$eq":"John"}}`, then the filter param after URL-encoding will be: `filter=%7B%22name%22%3A%7B%22%24eq%22%3A%22John%22%7D%7D` **Basic Filter Structure** The filter object at its core consists of a *matcher*, a *field*, and an *argument*. For example, in the following filter JSON: ``` { "name":{ "$eq":"John" } } ``` `$eq` is the *matcher*, or filtering operation (equals, in this example), `name` is the *field* being filtered by, and `John` is *value* to be matched against. **Combining Multiple Filters** Multiple filters can be combined into one object using *combinators*. For example, the following filter JSON combines multiple filters using the combinator `$and`. `$or` is also supported. ``` { "$and":[ { "firstName":{ "$eq":"John" } }, { "countryCode":{ "$in":[ "US", "GB" ] } } ] } ``` **Filter Negation** Certain filter types may be negated. For example: ``` { "$not": { "name": { "$eq": "John" } } } ``` This can also be written more simply with a `!` in the `$eq` parameter. The following filter would have the same effect: ``` { "name":{ "!$eq":"John" } } ``` **Filter Complement** You can also search for the complement of a filter. This filter would match entities that do not contain "hello" in their descriptions, or do not have a description set. This is different from negation which can only match entities who have the negated field set to something. ``` { "$complement":{ "description":{ "$contains":"hello" } } } ``` **Addressing Subfields** Subfields of fields can be addressed using the "dot" notation while filtering. For example, if you have a custom field called **`c_myCustomField`**: ``` { "c_myCustomField":{ "age": 30, "name": "Jim", } } ``` While filtering, subfields may be addressed using the "dot" notation. ``` { "c_myCustomField.name":{ "!$eq":"John" } } ``` Fields that are nested deeper may be addressed using dot notation, as well. For example, if **`name`** in the above example was a compound field with two subfields **`first`** and **`last`**, **`first`** may be addressed as **`c_myCustomField.name.first`**. **Field Support** Entity fields correspond to certain filter types, which support matchers. Going by the example above, the field **`name`** supports the `TEXT` filter type, which supports `$eq` (equals) and `$startsWith` (starts with). **TEXT** The `TEXT` filter type is supported for text fields. (e.g., **`name`**, **`countryCode`**)
Matcher Details
$eq (equals) { "countryCode":{ "$eq":"US" } }, { "countryCode":{ "!$eq":"US" } } Supports negation. Case insensitive.
$startsWith Matches if the field starts with the argument value. e.g., "Amazing" starts with "amaz" { "address.line1":{ "$startsWith": "Jo" } } Supports negation. Case insensitive.
$in Matches if field value is a member of the argument list. { "firstName":{ "$in": ["John", "Jimmy"] } } Does not support negation. Negation can be mimicked by using an "OR" matcher, for example: { "$and":[ { "firstName":{ "!$eq": "John" } }, { "firstName":{ "!$eq": "Jimmy" } } ] }
$contains { "c_myString":{ "$contains":"sample" } } This filter will match if "sample" is contained in any string within **`c_myString`**. Note that this matching is "left-edge n-gram", meaning the argument string must be the beginning of a token. The string "sample" will match strings like "This a sample", "Sample one", and "Sample 2", but not strings like "thisisasamplewithoutspaces". Supports negation.
$containsAny { "c_myString":{ "$containsAny":[ "sample1", "sample2" ] } } This filter will match if either "sample1" or "sample2" is contained in any string within **`c_myString`**. The argument list can contain more than two strings. Note that this matching is "left-edge n-gram", meaning the argument string must be the beginning of a token. The string "sample" will match strings like "This a sample", "Sample one", and "Sample 2", but not strings like "thisisasamplewithoutspaces". Supports negation.
$containsAll { "c_myString":{ "$containsAll":[ "sample1", "sample2" ] } } This filter will match if both "sample1" and "sample2" are contained in any string within **`c_myString`**. The argument list can contain more than two strings. Note that this matching is "left-edge n-gram", meaning the argument string must be the beginning of a token. The string "sample" will match strings like "This a sample", "Sample one", and "Sample 2", but not strings like "thisisasamplewithoutspaces". Supports negation.
**BOOLEAN** The BOOLEAN filter type is supported for boolean fields and Yes / No custom fields.
Matcher Details
$eq { "isFreeEvent": { "$eq": true } } For booleans, the filter takes a boolean value, not a string. Supports negation.
**STRUCT** The STRUCT filter type is supported for compound fields with subfields. *e.g., **`address`**, **`featuredMessage`**, fields of custom types*
Matcher Details
$hasProperty Matches if argument is a key (subfield) of field being filtered by. This filter type is useful for filtering by compound fields or to check if certain fields have a value set. { "address": { "$hasProperty": "line1" } } Note that if a given property of a compound field is not set, the filter will not match. For example, if `line1` of **`address`** is not set for an entity, then the above matcher will not match the entity. Supports negation.
**OPTION** The OPTION filter type is supported for options custom fields and fields that have a predetermined list of valid values. *e.g., **`eventStatus`**, **`gender`**, `SINGLE_OPTION` and `MULTI_OPTION` types of custom fields.*
Matcher Details
$eq Matching is case insensitive and insensitive to consecutive whitespace. e.g., "XYZ 123" matches "xyz 123" { "eventStatus": { "$eq": "SCHEDULED" } } Supports negation. Negating `$eq` on the list will match any field that does not hold any of the provided values.
$in { "eventStatus": { "$in": [ "SCHEDULED", "POSTPONED" ] } } Does not support negation. However, negation can be mimicked by using an `$and` matcher to negate individually over the desired values. For example: { "$and": [ { "eventStatus":{ "!$eq": "SCHEDULED" } }, { "firstName":{ "!$eq": "POSTPONED" } } ] }
**PHONE** The PHONE filter type is supported for phone number fields only. PHONE will support the same matchers as TEXT, except that for `$eq`, the same phone number with or without calling code will match.
Matcher Details
$eq { "mainPhone":{ "$eq":"+18187076189" } }, { "mainPhone":{ "$eq":"8187076189" } }, { "mainPhone":{ "!$eq":"9177076189" } } Supports negation. Case insensitive.
$startsWith Matches if the field starts with the argument value. e.g., "8187076189" starts with "818" { "mainPhone":{ "$startsWith": "818" } } Supports negation. Case insensitive.
$in Matches if field value is a member of the argument list. { "mainPhone":{ "$in": [ "8185551616", "9171112211" ] } } Does not support negation. However, negation can be mimicked by using an `$and` matcher to negate individually over the desired values.
**INTEGER, FLOAT, DATE, DATETIME, and TIME** These filter types are strictly ordered -- therefore, they support the following matchers: - Equals - Less Than / Less Than or Equal To - Greater Than / Greater Than or Equal To
Matcher Details
$eq Equals { "ageRange.maxValue": { "$eq": "80" } } Supports negation.
$lt Less than { "time.start": { "$lt": "2018-08-28T05:56" } }
$gt Greater than { "ageRange.maxValue": { "$gt": "50" } }
$le Less than or equal to { "ageRange.maxValue": { "$le": "40" } }
$ge Greater than or equal to { "time.end": { "$ge": "2018-08-28T05:56" } }
Combinations While we do not support "between" in our filtering syntax, it is possible to combine multiple matchers for a result similar to an "and" operation: { "ageRange.maxValue : { "$gt" : 10, "$lt": 20 } }
**LIST OF TEXT** Any field that has a list of valid values and supports any of the previously mentioned filter types will also support the `$contains` matcher.
Matcher Details
$eq { "c_myStringList": { "$eq": "sample" } } This filter will match if "sample" EXACTLY matches any string within **`c_myStringList`**. Supports negation.
$eqAny { "c_myStringList": { "$eqAny": [ "sample1", "sample2" ] } } This filter will match if any one of "sample1" or "sample2" EXACTLY match a string within **`c_myStringList`** . The argument can have more than two strings. Supports negation.
$eqAll { "c_myStringList": { "$eqAll": [ "sample1", "sample2" ] } } This filter will match if both "sample1" AND "sample2" EXACTLY match a string within **`c_myStringList`**. The argument can have more than two strings. Supports negation.
$contains { "c_myStringList":{ "$contains":"sample" } } This filter will match if "sample" is contained in any string within **`c_myStringList`**. Note that this matching is "left edge n-gram", meaning the argument string must be the beginning of a token. The string "sample" will match strings like "This is a sample", "Sample one", "Sample 2" but not strings like "thisisasamplewithoutspaces". Supports negation.
$containsAny { "c_myStringList": { "$containsAny": [ "sample1", "sample2" ] } } This filter will match if either "sample1" or "sample2" is contained in any string within **`c_myStringList`**. The argument list can have more than two strings. Note that similar to `$contains`, the matching for `$containsAny` is "left edge n-gram", meaning the argument string must be the beginning of a token. The string "sample" will match strings like "This is a sample", "Sample one", "Sample 2" but not strings like "thisisasamplewithoutspaces". Supports negation.
$containsAll { "c_myStringList": { "$containsAll": [ "sample1", "sample2" ] } } This filter will match if BOTH "sample1" and "sample2" are contained in strings within **`c_myStringList`**. The argument list can have more than two strings. Note that similar to `$contains`, the matching for `$containsAll` is "left-edge n-gram", meaning the argument string must be the beginning of a token. The string "sample" will match strings like "This a sample", "Sample one", and "Sample 2", but not strings like "thisisasamplewithoutspaces". Supports negation.
$startsWith { "c_myStringList": { "$startsWith":"sample" } } This filter will match if any string within **`c_myStringList`** starts with "sample". Does not supports negation. Case Insensitive.
**LIST OF BOOLEAN, OPTION, PHONE, INTEGER, FLOAT, DATE, DATETIME, OR TIME**
Matcher Details
$eq { "c_myDateList": { "$eq": "2019-01-01" } } This filter will match if "2019-01-01" EXACTLY matches any date within **`c_myDateList`**. Supports negation.
$eqAny { "c_myIntegerList": { "$eqAny": [1, 2] } } This filter will match if 1 or 2 EXACTLY match any integer within **`c_myIntegerList`**. The argument list can have more than two elements. Supports negation.
$eqAll { "c_myStringList": { "$eqAll": [ "sample1", "sample2" ] } } This filter will match if both "2019-01-01" AND "2019-01-02" EXACTLY match a date within **`c_myDateList`**. The argument list can have more than two elements. Supports negation.
**LIST OF STRUCT** Filtering on lists of struct types is a bit nuanced. Filtering can only be done on lists of structs of the SAME type. For example, if **`c_myStructList`** is a list of compound fields with the subfields **`age`** and **`name`**, then one can address the **`age`** properties of each field in **`c_myStructList`** as a flattened list of integers and filtering upon them. For example, the following filter: ``` { "c_myStructList.age":{ "$eq": 20 } } ``` will match if any field in the list has an **`age`** property equal to 20. Similarly, any filter that can be applied to lists of integers could be applied to **`age`** in this case (`$eq`, `$eqAll`, `$eqAny`). **HOURS** By filtering on an hours field, you can find which entities are open or closed at a specified time or during a certain time range. All of these filters also take an entity’s holiday hours and reopen date into account.
Matcher Details
$openAt { "hours": { "$openAt": "2019-01-06T13:45" } } This filter would match entities open at the specified time.
$closedAt { "hours": { "$closedAt: "2019-01-06T13:45" } }
$openForAllOf { "hours": { "$openForAllOf": { "start": "2019-01-06T13:45", "end": "2019-01-06T15:00" } } } This filter would match only those entities that are open for the entire range between 2019-01-06T13:45 and 2019-01-06T15:00. { "hours": { "$openForAllOf": "2019-05-10" } } This filter would match entities open for the entire 24 hour period on 2019-05-10. You can also supply a year, a month, or an hour to filter for entities open for the entire year, month, or hour, respectively.
$openForAnyOf { "hours": { "$openForAnyOf": { "start": "now", "end": "now+2h" } } } This filter will match any entities that are open for at least a portion of the time range between now and two hours from now.
$closedForAllOf { "hours": { "$closedForAllOf": { "start": "2019-01-06T13:45", "end": "2019-01-06T15:00" } } } This filter will match only those entities that are closed for the entire given time range.
$closedForAnyOf { "hours": { "$closedForAnyOf": { "start": "2019-01-06T13:45", "end": "2019-01-06T15:00" } } } This filter will match any entities that are closed for at least a portion of the given time range.
**Filtering by Dates and Times** **Time zones** The filtering language supports searching both in local time and within a certain time zone. Searching in local time will simply ignore the time zone on the target entities, while providing one will convert the zone of your queried time to the zone of the target entities. To search in local time, simply provide the date or time without any zone: `2019-06-07T15:30` or `2019-06-07`. To conduct a zoned search, provide the name of the time zone in brackets after the time, as it is shown in the tz database: `2019-06-07T15:30[America/New_York]` or `2019-06-06[America/Phoenix]`. **Date and time types** In addition to searching with dates and datetimes, you can also query with years, months, and hours. For example, the filter: ``` { "time.start": { "$eq": "2018" } } ``` would match all start times in the year 2018. The same logic would apply for a month (`2019-05`), a date (`2019-05-01`), or an hour (`2019-05-01T06`). These types also work with ordered searches. For example: ``` { "time.start": { "$lt": "2018" } } ``` would match start times before 2018 (i.e., anything in 2017 or before). On the other hand, the same query with a `$le` matcher would include anything in or before 2018. **"Now" and Date Math** Instead of providing a static date or time, you can also use `now` in place of any date time. When you do so, the system will calculate the time when the query is made and conduct a zoned search. In order to search for a future or past time relative to `now`, you can use date math. For example, you can enter `now+3h` or `now-1d`, which would mean 3 hours from now and 1 day ago, respectively. You can also add and subtract minutes (`m`), months (`M`), and years (`y`). It is also possible to add or subtract time from a static date or datetime. Simply add `||` between the static value and any addition or subtraction. For example, `2019-02-03||+1d` would be the same as `2019-02-04`. You can also convert date and time types to other types. For example, to convert the datetime `2019-05-06T22:15` to a date, use `2019-05-06T22:15||/d`. Doing so would yield the same result as using `2019-05-06`. This method also works with `now`: `now/d` will give you today’s date without the time. **Filtering Across an Entity** It is possible to search for a specific text string across all fields of an entity by using the `$anywhere` matcher.
Matcher Details
$anywhere Matches if the argument text appears anywhere in the entity (including subfields, structs, and lists) { "$anywhere": "hello" } This filter will match all entities that contain the string "hello" or strings that begin with "hello".
**Examples** The following filter will match against entities that: - Are of type `event` (note that entity types can also be filtered by the **`entityTypes`** query parameter) - Have a name that starts with the text "Century" - Have a maximum age between 10 and 20 - Have a minimum age between 5 and 7 - Start after 7 PM (19:00) on August 28, 2018 ``` { "$and":[ { "entityType":{ "$eq":"event" } }, { "name":{ "$startsWith":"Century" } }, { "ageRange.maxValue":{ "$gt":10, "$lt":20 } }, { "ageRange.minValue":{ "$gt":5, "$lt":7 } }, { "time.start":{ "$ge":"2018-08-28T19:00" } } ] } ``` name: filter in: query required: false - schema: minLength: 0 type: string description: The latitude, longitude, and approximate radius in miles, separated by commas, where the geocoder should be biased. name: geocoderBias in: query required: false - schema: minLength: 0 type: string description: | Comma-separated list of language codes. When present, the system will return Entities that have profiles in one or more of the provided languages. For each Location, only the first available profile from the provided list of languages will be returned. The keyword `"primary"` can be used to refer to a Location’s primary profile without providing a specific language code. If an Entity does not have profiles in any of the languages provided, that Entity's primary profile will be returned. name: languages in: query required: false - schema: multipleOf: 1 maximum: 50 type: number default: '10' description: Number of results to return. name: limit in: query required: false - schema: multipleOf: 1 type: number default: '0' description: | Number of results to skip. Used to page through results. Cannot be used together with **`pageToken`**. For Live API requests, the offset cannot be higher than 9,950. For Knowledge API the maximum limit is only enforced if a filter and/or sortBy parameter are given. name: offset in: query required: false - schema: minimum: 0.1 maximum: 2500 type: number default: '10' description: Indicates the search radius around the provided **`location`** in miles name: radius in: query required: false - schema: minLength: 0 type: string default: '0' description: | Determines the noise level for randomizing sort order. Must be between 0 and 1 inclusive. A value of `0` results in no randomness: results are returned by order of distance. A value of `1` results in full randomness: results within the radius are returned in a random order. Only one of **`randomization`** and **`randomizationToken`** can be set. name: randomization in: query required: false - schema: minLength: 0 type: string description: | To be used alongside **`offset`** to allow for movement through randomized search results. After the first search with **`randomization`** set, **`randomizationToken`** is returned, which should be passed into the request as this parameter in order to iterate through subsequent results under the same randomness. Only one of **`randomization`** and **`randomizationToken`** can be set. name: randomizationToken in: query required: false - schema: minLength: 0 type: string description: | A comma-separated list of saved filter IDs. When present, the system will return entities that are included in the filters matching **all** of the provided IDs. name: savedFilterIds in: query required: false tags: - Live API summary: 'Entities: GeoSearch' description: | Gets multiple Entities with addresses near a given geographical point, ordered by proximity to that point and restricted to a radius. **NOTE:** Responses will contain resolved values for embedded fields responses: '200': description: Success Response content: application/json: schema: additionalProperties: false type: object properties: meta: additionalProperties: false type: object properties: uuid: minLength: 0 type: string description: Unique ID for this request / response. response: additionalProperties: false type: object properties: count: multipleOf: 1 type: number description: Total number of Entities that meet the filter criteria (ignores **``limit``** / **``offset``** parameters) distances: uniqueItems: false type: array items: additionalProperties: false type: object properties: distanceKilometers: type: number description: Distance in kilometers between the entity and the coordinate specified in the Geo object. distanceMiles: type: number description: Distance in miles between the entity and the coordinate specified in the Geo object. id: minLength: 0 type: string description: External entity ID entities: uniqueItems: false type: array items: additionalProperties: false type: object properties: meta: additionalProperties: false type: object properties: accountId: minLength: 0 type: string description: ID of the account associated with this Entity countryCode: minLength: 0 type: string description: |- Country code of this Entity's Language Profile (defaults to the country of the account) Filtering Type: `text` createdTimestamp: minLength: 0 type: string description: The timestamp of when the entity record was created. entityType: minLength: 0 type: string description: |- This Entity's type (e.g., location, event) Filtering Type: `text` folderId: minLength: 0 type: string description: |- The ID of the folder containing this Entity Filtering Type: `text` id: minLength: 0 type: string description: |- ID of this Entity Filtering Type: `text` labels: uniqueItems: false type: array items: minLength: 0 type: string description: 'Filtering Type: `text`' description: |- This Entity's labels. If the **`v`** parameter is before `20211215`, this will be an integer. Filtering Type: `list of text` language: minLength: 0 type: string description: |- Language code of this Entity's Language Profile (defaults to the language code of the account) Filtering Type: `text` timestamp: minLength: 0 type: string description: | The timestamp of the most recent change to this entity record. Will be ignored when the client is saving entity data to Yext. **NOTE:** The timestamp may change even if observable fields stay the same. uid: minLength: 0 type: string description: | The internal ID of the entity. This UID is a static, globally unique ID. Note that this value cannot be used in place of id in API calls to retrieve or edit Entity information. If the v param is before `20221206`, the returned value will be a hashed version of the entity UID (aka internal ID of the entity). description: |- Contains the metadata about the entity. ``` Eligible For: * atm * event * faq * healthcareFacility * healthcareProfessional * hotel * job * location * restaurant ``` name: minLength: 0 maxLength: 5000 type: string description: |- Cannot Include: * HTML markup Filtering Type: `text` ``` Eligible For: * atm * board * brand * card * contactCard * event * faq * financialProfessional * healthcareFacility * healthcareProfessional * helpArticle * hotel * hotelRoomType * job * location * organization * product * restaurant ``` address: additionalProperties: false type: object properties: city: minLength: 0 maxLength: 255 type: string description: |- The city the entity (or the entity's location) is in Cannot Include: * a URL or domain name Filtering Type: `text` countryCode: minLength: 0 pattern: ^[a-zA-Z]{2}$ type: string description: 'Filtering Type: `text`' extraDescription: minLength: 0 maxLength: 255 type: string description: |- Provides additional information to help consumers get to the entity. This string appears along with the entity's address (e.g., `In Menlo Mall, 3rd Floor`). It may also be used in conjunction with a hidden address (i.e., when **`addressHidden`** is `true`) to give consumers information about where the entity can be found (e.g., `Servicing the New York area`). Filtering Type: `text` line1: minLength: 0 maxLength: 255 type: string description: |- Cannot Include: * a URL or domain name Filtering Type: `text` line2: minLength: 0 maxLength: 255 type: string description: |- Cannot Include: * a URL or domain name Filtering Type: `text` postalCode: minLength: 0 maxLength: 10 type: string description: |- The entity's postal code. The postal code must be valid for the entity's country. Cannot include a URL or domain name. Cannot Include: * a URL or domain name Filtering Type: `text` region: minLength: 0 maxLength: 255 type: string description: |- The name of the entity's region or state. Cannot Include: * a URL or domain name Filtering Type: `text` sublocality: minLength: 0 maxLength: 255 type: string description: |- The name of the entity's sublocality Cannot Include: * a URL or domain name Filtering Type: `text` description: |- Contains the address of the entity (or where the entity is located) Must be a valid address Cannot be a P.O. Box If the entity is an `event`, either an **`address`** value or a **`linkedLocation`** value can be provided. Filtering Type: `object` ``` Eligible For: * atm * event * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` acceptingNewPatients: type: boolean description: |- Indicates whether the healthcare provider is accepting new patients. Filtering Type: `boolean` ``` Eligible For: * healthcareFacility * healthcareProfessional ``` acceptsReservations: type: boolean description: |- Indicates whether the entity accepts reservations. Filtering Type: `boolean` ``` Eligible For: * restaurant ``` accessHours: additionalProperties: false type: object properties: friday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the access hours are "closed" on Friday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is open on Friday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' holidayHours: description: |- **NOTE:** The list of Holiday Hours that you send us must be comprehensive. For example, if you send us a list of Holiday Hours that does not include Holiday Hours that you sent in your last update, Yext considers the missing Holiday Hours to be deleted, and we remove them. Array must be ordered. Filtering Type: `list of object` uniqueItems: true type: array items: required: - date additionalProperties: false type: object properties: date: format: date type: string description: |- Date on which the holiday hours will be in effect. Cannot be in the past. Date must be on or after 1970-01-01 Date must be before or on 2038-01-01 Filtering Type: `date` isClosed: type: boolean description: |- Indicates if the access hours are "closed" on on the given date. Filtering Type: `boolean` isRegularHours: type: boolean description: |- Indicates whether the holiday hours are the same as the regular business hours for the given date. If set to true, we will update the holiday hours if the regular business hours change for the date's day of the week. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is open on the specified date. Filtering Type: `list of object` description: 'Filtering Type: `object`' monday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the access hours are "closed" on Monday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is open on Monday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' reopenDate: format: date type: string description: |- Date must be on or after 1970-01-01 Date must be before or on 2038-01-01 Filtering Type: `date` saturday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the access hours are "closed" on Saturday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is open on Saturday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' sunday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the access hours are "closed" on Sunday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is open on Sunday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' thursday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the access hours are "closed" on Thursday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is open on Thursday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' tuesday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the access hours are "closed" on Tuesday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is open on Tuesday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' wednesday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the access hours are "closed" on Wednesday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is open on Wednesday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' description: |- Contains the daily access hours, holiday access hours, and reopen date for the Entity. Each day is represented by a sub-field of `accessHours`. (e.g. `monday`, `tuesday`, etc.) Open times can be specified per day through the `openIntervals` field and the `isClosed` flag. Similarly, holiday access hours are represented by the `holidayHours` sub-field. Setting the `reopenDate` sub-field indicates that the business is temporarily closed and will reopen on the specified date. SPECIAL CASES: * To indicate that an Entity is open 24 hours on a specific day, set start to 00:00 and end to 23:59 in `openIntervals` for that day. * To indicate that an Entity has split hours on a specific day (e.g., open from 9:00 AM to 12:00 PM and again from 1:00 PM to 5:00 PM), supply two or more `openIntervals` values with non-overlapping sets of hours. * If you are providing `openIntervals`, you may not set `isClosed` to true for that day. Filtering Type: `hours` ``` Eligible For: * atm * healthcareFacility * hotel * location * restaurant ``` additionalHoursText: minLength: 0 maxLength: 255 type: string description: |- Additional information about hours that does not fit in **`hours`** (e.g., `"Closed during the winter"`) Filtering Type: `text` ``` Eligible For: * atm * contactCard * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` additionalPromotingLocations: description: |- If other locations are promoting this event, a list of those locations' **`id`**s in the Yext Knowledge Manager Array must be ordered. Filtering Type: `list of entityId` ``` Eligible For: * event ``` uniqueItems: true type: array items: type: string description: 'Filtering Type: `entityId`' addressHidden: type: boolean description: |- If `true`, the entity's street address will not be shown on listings. Defaults to `false`. Filtering Type: `boolean` ``` Eligible For: * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` admittingHospitals: description: |- A list of hospitals where the healthcare professional admits patients Array must be ordered. Array may have a maximum of 100 elements. Array item description: >Cannot Include: >* HTML markup Filtering Type: `list of text` ``` Eligible For: * healthcareProfessional ``` uniqueItems: true type: array items: minLength: 0 maxLength: 100 type: string description: |- Cannot Include: * HTML markup Filtering Type: `text` adultPool: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity has a pool for adults only. Filtering Type: `option` ``` Eligible For: * hotel ``` ageRange: additionalProperties: false type: object properties: maxValue: multipleOf: 1 type: number description: |- Maximum age for the event Filtering Type: `integer` minValue: multipleOf: 1 type: number description: |- Minimum age for the event Filtering Type: `integer` description: |- Contains the age range for the event Filtering Type: `object` ``` Eligible For: * event ``` airportShuttle: enum: - AIRPORT_SHUTTLE_AVAILABLE - AIRPORT_SHUTTLE_AVAILABLE_FOR_FREE - NOT_APPLICABLE type: string description: |- Indicates whether the entity offers a shuttle to/from the airport. Filtering Type: `option` ``` Eligible For: * hotel ``` airportTransfer: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity offers a shuttle service of car service to/from nearby airports or train stations. Filtering Type: `option` ``` Eligible For: * hotel ``` allInclusive: enum: - ALL_INCLUSIVE_RATES_AVAILABLE - ALL_INCLUSIVE_RATES_ONLY - NOT_APPLICABLE type: string description: |- Indicates whether the entity offers all-inclusive rates. Filtering Type: `option` ``` Eligible For: * hotel ``` alternateNames: description: |- Other names for your business that you would like us to use when tracking your search performance Array must be ordered. Array may have a maximum of 3 elements. Array item description: >Cannot Include: >* HTML markup Filtering Type: `list of text` ``` Eligible For: * atm * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * organization * restaurant ``` uniqueItems: true type: array items: minLength: 0 maxLength: 100 type: string description: |- Cannot Include: * HTML markup Filtering Type: `text` alternatePhone: minLength: 0 type: string description: |- Must be a valid phone number. If the phone number's calling code is for a country other than the one given in the entity's **`countryCode`**, the phone number provided must contain the calling code (e.g., `+44` in `+442038083831`). Otherwise, the calling code is optional. Filtering Type: `text` ``` Eligible For: * atm * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` alternateWebsites: description: |- Other websites for your business that we should search for when tracking your search performance Array must be ordered. Array may have a maximum of 3 elements. Array item description: >Cannot Include: >* common domain names, e.g., google.com, youtube.com, etc. Filtering Type: `list of text` ``` Eligible For: * atm * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * organization * restaurant ``` uniqueItems: true type: array items: minLength: 0 maxLength: 255 format: uri type: string description: |- Cannot Include: * common domain names, e.g., google.com, youtube.com, etc. Filtering Type: `text` androidAppUrl: minLength: 0 type: string description: |- The URL where consumers can download the entity's Android app Filtering Type: `text` ``` Eligible For: * brand * financialProfessional * hotel * location * restaurant ``` answer: description: |- The answer to the frequently asked question represented by this entity Character limit: 0 .. 15000 Supported formats include: * BOLD * ITALICS * UNDERLINE * BULLETED_LIST * NUMBERED_LIST * HYPERLINK * IMAGE * CODE_SPAN * HEADINGS ``` Eligible For: * faq ``` type: string format: rich-text appleActionLinks: description: |- Use this field to add action links to your Apple Listings. The call to action category will be displayed on the action link button. The App Store URL should contain a valid link to the landing page of an App in the Apple App Store. The Quick Link URL is where a user is taken when an action link is clicked by a user. The App Name sub-field is not displayed on Apple Listings and is only used to distinguish the call-to-action type when utilizing action links in Apple posts. Array must be ordered. Filtering Type: `list of object` ``` Eligible For: * atm * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` uniqueItems: true type: array items: required: - category - quickLinkUrl - appName additionalProperties: false type: object properties: appName: minLength: 0 maxLength: 18 type: string description: 'Filtering Type: `text`' appStoreUrl: minLength: 0 maxLength: 2000 format: uri type: string description: 'Filtering Type: `text`' category: enum: - BOOK_TRAVEL - CHECK_IN - FEES_POLICIES - FLIGHT_STATUS - TICKETS - TICKETING - AMENITIES - FRONT_DESK - PARKING - GIFT_CARD - WAITLIST - DELIVERY - ORDER - TAKEOUT - PICKUP - RESERVE - MENU - APPOINTMENT - PORTFOLIO - QUOTE - SERVICES - STORE_ORDERS - STORE_SHOP - STORE_SUPPORT - SCHEDULE - SHOWTIMES - AVAILABILITY - PRICING - ACTIVITIES - BOOK - BOOK_(HOTEL) - BOOK_(RIDE) - BOOK_(TOUR) - CAREERS - CHARGE - COUPONS - DELIVERY_(RETAIL) - DONATE - EVENTS - ORDER_(RETAIL) - OTHER_MENU - PICKUP_(RETAIL) - RESERVE_(PARKING) - SHOWS - SPORTS - SUPPORT - TEE_TIME - GIFT_CARD_(RESTAURANT) type: string description: 'Filtering Type: `option`' quickLinkUrl: minLength: 0 maxLength: 2000 format: uri type: string description: 'Filtering Type: `text`' description: 'Filtering Type: `object`' appleBusinessDescription: minLength: 0 maxLength: 500 type: string description: |- The business description to be sent to Apple Filtering Type: `text` ``` Eligible For: * atm * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` appleBusinessId: minLength: 0 pattern: ^\d*\.?\d*$ type: string description: |- The ID associated with an individual Business Folder in your Apple account Filtering Type: `text` ``` Eligible For: * atm * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` appleCompanyId: minLength: 0 pattern: ^\d*\.?\d*$ type: string description: |- The ID associated with your Apple account. Numerical values only Filtering Type: `text` ``` Eligible For: * atm * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` appleCoverPhoto: required: - url additionalProperties: false type: object description: |- The cover photo for the entity''s Apple profile Image must be at least 1600 x 1040 pixels Image may be no more than 4864 x 3163 pixels Supported Aspect Ratios: * 154 x 100 **NOTE**: Maximum image size is 5mb after normalization and padding (if applicable). As well, there is a 6 second download limit from the image host. Filtering Type: `object` ``` Eligible For: * atm * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` properties: alternateText: minLength: 0 type: string description: 'Filtering Type: `text`' url: minLength: 0 format: uri type: string description: 'Filtering Type: `text`' appleDisplayName: minLength: 0 maxLength: 5000 type: string description: |- The name to be displayed on Apple for the entity. NOTE: The names of Brands and their respective Locations within an Apple Business Connect Account must match identically. Cannot Include: HTML markup Cannot Include: * HTML markup Filtering Type: `text` ``` Eligible For: * atm * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` applicationUrl: minLength: 0 format: uri type: string description: |- The application URL Filtering Type: `text` ``` Eligible For: * job ``` associations: description: |- Association memberships relevant to the entity (e.g., `"New York Doctors Association"`) All strings must be non-empty when trimmed of whitespace. Array must be ordered. Array may have a maximum of 100 elements. Array item description: >Cannot Include: >* HTML markup Filtering Type: `list of text` ``` Eligible For: * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` uniqueItems: true type: array items: minLength: 0 maxLength: 100 type: string description: |- Cannot Include: * HTML markup Filtering Type: `text` attendance: required: - attendanceMode additionalProperties: false type: object properties: attendanceMode: enum: - OFFLINE - ONLINE - MIXED type: string description: 'Filtering Type: `option`' virtualLocationUrl: minLength: 0 format: uri type: string description: 'Filtering Type: `text`' description: |- Indicates whether the event is online, offline, or a mix. A `virtualLocationUrl` must be specified for online and mixed events. Filtering Type: `object` ``` Eligible For: * event ``` attire: enum: - UNSPECIFIED - DRESSY - CASUAL - FORMAL type: string description: |- The formality of clothing typically worn at this restaurant Filtering Type: `option` ``` Eligible For: * restaurant ``` babysittingOffered: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity offers babysitting. Filtering Type: `option` ``` Eligible For: * hotel ``` baggageStorage: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity offers baggage storage pre check-in and post check-out. Filtering Type: `option` ``` Eligible For: * hotel ``` bar: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity has an indoor or outdoor bar onsite. Filtering Type: `option` ``` Eligible For: * hotel ``` beachAccess: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity has access to a beach. Filtering Type: `option` ``` Eligible For: * hotel ``` beachFrontProperty: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity is physically located next to a beach. Filtering Type: `option` ``` Eligible For: * hotel ``` bicycles: enum: - BICYCLE_RENTALS - BICYCLE_RENTALS_FOR_FREE - NOT_APPLICABLE type: string description: |- Indicates whether the entity offers bicycles for rent or for free. Filtering Type: `option` ``` Eligible For: * hotel ``` bios: additionalProperties: false type: object properties: ids: description: |- IDs of the Bio Lists associated with this entity Array must be ordered. Array may have a maximum of 40 elements. Filtering Type: `list of text` uniqueItems: true type: array items: minLength: 0 type: string description: 'Filtering Type: `text`' label: minLength: 0 maxLength: 30 type: string description: |- Label to be used for this entity's Bio Lists. This label will appear on your entity's listings. Filtering Type: `text` description: |- Information about the Bio Content Lists associated with this entity Filtering Type: `object` ``` Eligible For: * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * organization * restaurant ``` boutiqueStores: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity has a boutique store. Gift shop or convenience store are not eligible. Filtering Type: `option` ``` Eligible For: * hotel ``` brands: description: |- Brands sold by this entity All strings must be non-empty when trimmed of whitespace. Array must be ordered. Array may have a maximum of 100 elements. Array item description: >Cannot Include: >* HTML markup Filtering Type: `list of text` ``` Eligible For: * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` uniqueItems: true type: array items: minLength: 0 maxLength: 100 type: string description: |- Cannot Include: * HTML markup Filtering Type: `text` breakfast: enum: - BREAKFAST_AVAILABLE - BREAKFAST_AVAILABLE_FOR_FREE - NOT_APPLICABLE type: string description: |- Indicates whether the entity offers breakfast. Filtering Type: `option` ``` Eligible For: * hotel ``` brunchHours: additionalProperties: false type: object properties: friday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the brunch hours are "closed" on Friday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is open for brunch on Friday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' holidayHours: description: |- **NOTE:** The list of Holiday Hours that you send us must be comprehensive. For example, if you send us a list of Holiday Hours that does not include Holiday Hours that you sent in your last update, Yext considers the missing Holiday Hours to be deleted, and we remove them. Array must be ordered. Filtering Type: `list of object` uniqueItems: true type: array items: required: - date additionalProperties: false type: object properties: date: format: date type: string description: |- Date on which the holiday hours will be in effect. Cannot be in the past. Date must be on or after 1970-01-01 Date must be before or on 2038-01-01 Filtering Type: `date` isClosed: type: boolean description: |- Indicates if the brunch hours are "closed" on on the given date. Filtering Type: `boolean` isRegularHours: type: boolean description: |- Indicates whether the holiday hours are the same as the regular business hours for the given date. If set to true, we will update the holiday hours if the regular business hours change for the date's day of the week. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is open on the specified date. Filtering Type: `list of object` description: 'Filtering Type: `object`' monday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the brunch hours are "closed" on Monday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is open for brunch on Monday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' reopenDate: format: date type: string description: |- Date must be on or after 1970-01-01 Date must be before or on 2038-01-01 Filtering Type: `date` saturday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the brunch hours are "closed" on Saturday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is open for brunch on Saturday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' sunday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the brunch hours are "closed" on Sunday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is open for brunch on Sunday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' thursday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the brunch hours are "closed" on Thursday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is open for brunch on Thursday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' tuesday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the brunch hours are "closed" on Tuesday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is open for brunch on Tuesday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' wednesday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the brunch hours are "closed" on Wednesday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is open for brunch on Wednesday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' description: |- Contains the daily brunch hours, holiday brunch hours, and reopen date for the Entity. Each day is represented by a sub-field of `brunchHours`. (e.g. `monday`, `tuesday`, etc.) Open times can be specified per day through the `openIntervals` field and the `isClosed` flag. Similarly, holiday brunch hours are represented by the `holidayHours` sub-field. Setting the `reopenDate` sub-field indicates that the business is temporarily closed and will reopen on the specified date. SPECIAL CASES: * To indicate that an Entity is open 24 hours on a specific day, set start to 00:00 and end to 23:59 in `openIntervals` for that day. * To indicate that an Entity has split hours on a specific day (e.g., open from 9:00 AM to 12:00 PM and again from 1:00 PM to 5:00 PM), supply two or more `openIntervals` values with non-overlapping sets of hours. * If you are providing `openIntervals`, you may not set `isClosed` to true for that day. Filtering Type: `hours` ``` Eligible For: * hotel * location * restaurant ``` businessCenter: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity has a business center. Filtering Type: `option` ``` Eligible For: * hotel ``` calendars: additionalProperties: false type: object properties: ids: description: |- IDs of the Calendars associated with this entity Array must be ordered. Array may have a maximum of 40 elements. Filtering Type: `list of text` uniqueItems: true type: array items: minLength: 0 type: string description: 'Filtering Type: `text`' label: minLength: 0 maxLength: 30 type: string description: |- Label to be used for this entity's Calendars. This label will appear on your entity's listings. Filtering Type: `text` description: |- Information about the events Content Lists (Calendars) associated with this entity Filtering Type: `object` ``` Eligible For: * financialProfessional * healthcareFacility * hotel * location * restaurant ``` carRental: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity offers car rental. Filtering Type: `option` ``` Eligible For: * hotel ``` casino: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity has a casino on premise or nearby. Filtering Type: `option` ``` Eligible For: * hotel ``` categories: additionalProperties: false type: object properties: {} description: |- Yext Categories. (Supported for versions > 20240220) A map of category list external IDs (i.e. "yext") to a list of category IDs. IDs must be valid and selectable (i.e., cannot be parent categories). Partial updates are accepted, meaning sending only the "yext" property will have no effect on any category list except the "yext" category. Filtering Type: `object` ``` Eligible For: * atm * event * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` categoryIds: uniqueItems: false type: array items: minLength: 0 type: string description: 'Filtering Type: `text`' description: |- Yext Category IDs. (Deprecated: For versions > 20240220) 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. Filtering Type: `list of text` ``` Eligible For: * atm * event * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` catsAllowed: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates if the entity is cat friendly. Filtering Type: `option` ``` Eligible For: * hotel ``` certifications: description: |- A list of the certifications held by the healthcare professional **NOTE:** This field is only available to locations whose **`entityType`** is `healthcareProfessional`. Array must be ordered. Array may have a maximum of 100 elements. Array item description: >Cannot Include: >* HTML markup Filtering Type: `list of text` ``` Eligible For: * financialProfessional * healthcareProfessional ``` uniqueItems: true type: array items: minLength: 0 maxLength: 200 type: string description: |- Cannot Include: * HTML markup Filtering Type: `text` checkInTime: format: time type: string description: |- The check-in time Filtering Type: `time` ``` Eligible For: * hotel ``` checkOutTime: format: time type: string description: |- The check-out time Filtering Type: `time` ``` Eligible For: * hotel ``` classificationRating: pattern: ^\d*\.?\d*$ type: string description: |- The 1 to 5 star rating of the entitiy based on its services and facilities. Filtering Type: `decimal` ``` Eligible For: * hotel ``` closed: type: boolean description: |- Indicates whether the entity is closed Filtering Type: `boolean` ``` Eligible For: * atm * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` concierge: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity offers concierge service. Filtering Type: `option` ``` Eligible For: * hotel ``` conditionsTreated: description: |- A list of the conditions treated by the healthcare provider Array must be ordered. Array may have a maximum of 100 elements. Array item description: >Cannot Include: >* HTML markup Filtering Type: `list of text` ``` Eligible For: * healthcareFacility * healthcareProfessional ``` uniqueItems: true type: array items: minLength: 0 maxLength: 100 type: string description: |- Cannot Include: * HTML markup Filtering Type: `text` convenienceStore: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity has a convenience store. Filtering Type: `option` ``` Eligible For: * hotel ``` covidMessaging: minLength: 0 maxLength: 15000 type: string description: |- Information or messaging related to COVID-19. Filtering Type: `text` ``` Eligible For: * healthcareFacility * healthcareProfessional * location ``` covidTestAppointmentUrl: minLength: 0 format: uri type: string description: |- An appointment URL for scheduling a COVID-19 test. Filtering Type: `text` ``` Eligible For: * healthcareFacility * location ``` covidTestingAppointmentRequired: type: boolean description: |- Indicates whether an appointment is required for a COVID-19 test. Filtering Type: `boolean` ``` Eligible For: * healthcareFacility * location ``` covidTestingDriveThroughSite: type: boolean description: |- Indicates whether location is a drive-through site for COVID-19 tests. Filtering Type: `boolean` ``` Eligible For: * healthcareFacility * location ``` covidTestingIsFree: type: boolean description: |- Indicates whether location offers free COVID-19 testing. Filtering Type: `boolean` ``` Eligible For: * healthcareFacility * location ``` covidTestingPatientRestrictions: type: boolean description: |- Indicates whether there are patient restrictions for COVID-19 testing. Filtering Type: `boolean` ``` Eligible For: * healthcareFacility * location ``` covidTestingReferralRequired: type: boolean description: |- Indicates whether a referral is required for COVID-19 testing. Filtering Type: `boolean` ``` Eligible For: * healthcareFacility * location ``` covidTestingSiteInstructions: minLength: 0 maxLength: 15000 type: string description: |- Information or instructions for the COVID-19 testing site. Filtering Type: `text` ``` Eligible For: * healthcareFacility * location ``` covidVaccineAppointmentRequired: type: boolean description: |- Indicates whether an appointment is required for a COVID-19 vaccine. Filtering Type: `boolean` ``` Eligible For: * healthcareFacility * location ``` covidVaccineDriveThroughSite: type: boolean description: |- Indicates whether location is a drive-through site for COVID-19 vaccines. Filtering Type: `boolean` ``` Eligible For: * healthcareFacility * location ``` covidVaccineInformationUrl: minLength: 0 format: uri type: string description: |- An information URL for more information about COVID-19 vaccines. Filtering Type: `text` ``` Eligible For: * healthcareFacility * location ``` covidVaccinePatientRestrictions: type: boolean description: |- Indicates whether there are patient restrictions for a COVID-19 vaccine. Filtering Type: `boolean` ``` Eligible For: * healthcareFacility * location ``` covidVaccineReferralRequired: type: boolean description: |- Indicates whether a referral is required for a COVID-19 vaccine. Filtering Type: `boolean` ``` Eligible For: * healthcareFacility * location ``` covidVaccineSiteInstructions: minLength: 0 maxLength: 15000 type: string description: |- Information or instructions for the COVID-19 vaccination site. Filtering Type: `text` ``` Eligible For: * healthcareFacility * location ``` covidVaccinesOffered: uniqueItems: true type: array items: enum: - PFIZER - MODERNA - JOHNSON_&_JOHNSON type: string description: 'Filtering Type: `option`' description: |- Indicates which COVID-19 vaccines the location offers. Filtering Type: `list of option` ``` Eligible For: * healthcareFacility * location ``` currencyExchange: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity offers currency exchange services. Filtering Type: `option` ``` Eligible For: * hotel ``` customKeywords: description: |- Additional keywords you would like us to use when tracking your search performance Array must be ordered. Array may have a maximum of 5 elements. Filtering Type: `list of text` ``` Eligible For: * atm * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * organization * restaurant ``` uniqueItems: true type: array items: minLength: 0 maxLength: 100 type: string description: 'Filtering Type: `text`' datePosted: format: date type: string description: |- The date this entity was posted Filtering Type: `date` ``` Eligible For: * job ``` degrees: description: |- A list of the degrees earned by the healthcare professional Array must be ordered. Filtering Type: `list of option` ``` Eligible For: * healthcareProfessional ``` uniqueItems: true type: array items: enum: - ANP - APN - APRN - ARNP - AUD - BSW - CCCA - CNM - CNP - CNS - CPNP - CRNA - CRNP - DC - DDS - DMD - DNP - DO - DPM - DPT - DSW - DVM - FNP - GNP - LAC - LCSW - LPN - MBA - MBBS - MD - MPAS - MPH - MSW - ND - NNP - NP - OD - PA - PAC - PHARMD - PHD - PNP - PSYD - RD - RSW - VMD - WHNP type: string description: 'Filtering Type: `option`' deliveryHours: additionalProperties: false type: object properties: friday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the delivery hours are "closed" on Friday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is delivering on Friday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' holidayHours: description: |- **NOTE:** The list of Holiday Hours that you send us must be comprehensive. For example, if you send us a list of Holiday Hours that does not include Holiday Hours that you sent in your last update, Yext considers the missing Holiday Hours to be deleted, and we remove them. Array must be ordered. Filtering Type: `list of object` uniqueItems: true type: array items: required: - date additionalProperties: false type: object properties: date: format: date type: string description: |- Date on which the holiday hours will be in effect. Cannot be in the past. Date must be on or after 1970-01-01 Date must be before or on 2038-01-01 Filtering Type: `date` isClosed: type: boolean description: |- Indicates if the delivery hours are "closed" on on the given date. Filtering Type: `boolean` isRegularHours: type: boolean description: |- Indicates whether the holiday hours are the same as the regular business hours for the given date. If set to true, we will update the holiday hours if the regular business hours change for the date's day of the week. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is delivering on the specified date. Filtering Type: `list of object` description: 'Filtering Type: `object`' monday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the delivery hours are "closed" on Monday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is delivering on Monday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' reopenDate: format: date type: string description: |- Date must be on or after 1970-01-01 Date must be before or on 2038-01-01 Filtering Type: `date` saturday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the delivery hours are "closed" on Saturday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is delivering on Saturday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' sunday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the delivery hours are "closed" on Sunday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is delivering on Sunday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' thursday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the delivery hours are "closed" on Thursday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is delivering on Thursday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' tuesday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the delivery hours are "closed" on Tuesday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is delivering on Tuesday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' wednesday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the delivery hours are "closed" on Wednesday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is delivering on Wednesday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' description: |- Contains the daily delivery hours, holiday delivery hours, and reopen date for the Entity. Each day is represented by a sub-field of `deliveryHours`. (e.g. `monday`, `tuesday`, etc.) Open times can be specified per day through the `openIntervals` field and the `isClosed` flag. Similarly, holiday delivery hours are represented by the `holidayHours` sub-field. Setting the `reopenDate` sub-field indicates that the business is temporarily closed and will reopen on the specified date. SPECIAL CASES: * To indicate that an Entity is open 24 hours on a specific day, set start to 00:00 and end to 23:59 in `openIntervals` for that day. * To indicate that an Entity has split hours on a specific day (e.g., open from 9:00 AM to 12:00 PM and again from 1:00 PM to 5:00 PM), supply two or more `openIntervals` values with non-overlapping sets of hours. * If you are providing `openIntervals`, you may not set `isClosed` to true for that day. Filtering Type: `hours` ``` Eligible For: * location * restaurant ``` description: minLength: 10 maxLength: 15000 type: string description: |- A description of the entity Cannot Include: * HTML markup Filtering Type: `text` ``` Eligible For: * atm * contactCard * event * financialProfessional * healthcareFacility * healthcareProfessional * hotel * job * location * organization * restaurant ``` displayCoordinate: additionalProperties: false type: object properties: latitude: minimum: -90 maximum: 90 type: number description: 'Filtering Type: `float`' longitude: minimum: -180 maximum: 180 type: number description: 'Filtering Type: `float`' description: |- Coordinates where the map pin for the entity should be displayed, as provided by you Filtering Type: `object` ``` Eligible For: * atm * event * financialProfessional * healthcareFacility * healthcareProfessional * hotel * job * location * restaurant ``` doctorOnCall: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity has a doctor on premise or on call. Filtering Type: `option` ``` Eligible For: * hotel ``` dogsAllowed: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates if the entity is dog friendly. Filtering Type: `option` ``` Eligible For: * hotel ``` driveThroughHours: additionalProperties: false type: object properties: friday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the drive-through hours are "closed" on Friday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity's drive-through is open on Friday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' holidayHours: description: |- **NOTE:** The list of Holiday Hours that you send us must be comprehensive. For example, if you send us a list of Holiday Hours that does not include Holiday Hours that you sent in your last update, Yext considers the missing Holiday Hours to be deleted, and we remove them. Array must be ordered. Filtering Type: `list of object` uniqueItems: true type: array items: required: - date additionalProperties: false type: object properties: date: format: date type: string description: |- Date on which the holiday hours will be in effect. Cannot be in the past. Date must be on or after 1970-01-01 Date must be before or on 2038-01-01 Filtering Type: `date` isClosed: type: boolean description: |- Indicates if the drive-through hours are "closed" on on the given date. Filtering Type: `boolean` isRegularHours: type: boolean description: |- Indicates whether the holiday hours are the same as the regular business hours for the given date. If set to true, we will update the holiday hours if the regular business hours change for the date's day of the week. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity's drive-through is open on the specified date. Filtering Type: `list of object` description: 'Filtering Type: `object`' monday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the drive-through hours are "closed" on Monday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity's drive-through is open on Monday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' reopenDate: format: date type: string description: |- Date must be on or after 1970-01-01 Date must be before or on 2038-01-01 Filtering Type: `date` saturday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the drive-through hours are "closed" on Saturday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity's drive-through is open on Saturday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' sunday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the drive-through hours are "closed" on Sunday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity's drive-through is open on Sunday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' thursday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the drive-through hours are "closed" on Thursday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity's drive-through is open on Thursday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' tuesday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the drive-through hours are "closed" on Tuesday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity's drive-through is open on Tuesday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' wednesday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the drive-through hours are "closed" on Wednesday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity's drive-through is open on Wednesday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' description: |- Contains the daily drive-through hours, holiday drive-through hours, and reopen date for the Entity. Each day is represented by a sub-field of `driveThroughHours`. (e.g. `monday`, `tuesday`, etc.) Open times can be specified per day through the `openIntervals` field and the `isClosed` flag. Similarly, holiday drive-through hours are represented by the `holidayHours` sub-field. Setting the `reopenDate` sub-field indicates that the business is temporarily closed and will reopen on the specified date. SPECIAL CASES: * To indicate that an Entity is open 24 hours on a specific day, set start to 00:00 and end to 23:59 in `openIntervals` for that day. * To indicate that an Entity has split hours on a specific day (e.g., open from 9:00 AM to 12:00 PM and again from 1:00 PM to 5:00 PM), supply two or more `openIntervals` values with non-overlapping sets of hours. * If you are providing `openIntervals`, you may not set `isClosed` to true for that day. Filtering Type: `hours` ``` Eligible For: * atm * location * restaurant ``` dropoffCoordinate: additionalProperties: false type: object properties: latitude: minimum: -90 maximum: 90 type: number description: 'Filtering Type: `float`' longitude: minimum: -180 maximum: 180 type: number description: 'Filtering Type: `float`' description: |- Coordinates of the drop-off area for the entity, as provided by you Filtering Type: `object` ``` Eligible For: * atm * event * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` educationList: description: |- Information about the education or training completed by the healthcare professional Array must be ordered. Filtering Type: `list of object` ``` Eligible For: * healthcareProfessional ``` uniqueItems: true type: array items: required: - type - institutionName - yearCompleted additionalProperties: false type: object properties: institutionName: minLength: 0 maxLength: 100 type: string description: 'Filtering Type: `text`' type: enum: - FELLOWSHIP - RESIDENCY - INTERNSHIP - MEDICAL_SCHOOL type: string description: 'Filtering Type: `option`' yearCompleted: multipleOf: 1 minimum: 1900 maximum: 2100 type: number description: 'Filtering Type: `integer`' description: 'Filtering Type: `object`' electricChargingStation: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity has electric car chargine stations on premise. Filtering Type: `option` ``` Eligible For: * hotel ``` elevator: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity has an elevator. Filtering Type: `option` ``` Eligible For: * hotel ``` ellipticalMachine: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity has an elliptical machine. Filtering Type: `option` ``` Eligible For: * hotel ``` emails: description: |- Emails addresses for this entity's point of contact Must be valid email addresses Array must be ordered. Array may have a maximum of 5 elements. Filtering Type: `list of text` ``` Eligible For: * contactCard * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * organization * restaurant ``` uniqueItems: true type: array items: minLength: 0 format: email type: string description: 'Filtering Type: `text`' employmentType: enum: - FULL_TIME - PART_TIME - CONTRACTOR - TEMPORARY - INTERN - VOLUNTEER - PER_DIEM - OTHER type: string description: |- The employment type for the open job. Indicates whether the job is full-time, part-time, temporary, etc. Filtering Type: `option` ``` Eligible For: * job ``` eventStatus: enum: - SCHEDULED - RESCHEDULED - POSTPONED - CANCELED - EVENT_MOVED_ONLINE type: string description: |- Information on whether the event will take place as scheduled Filtering Type: `option` ``` Eligible For: * event ``` facebookAbout: minLength: 0 maxLength: 255 type: string description: |- A description of the entity to be used in the "About You" section on Facebook Filtering Type: `text` ``` Eligible For: * atm * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` facebookCallToAction: required: - type additionalProperties: false type: object properties: type: enum: - NONE - BOOK_NOW - CALL_NOW - CONTACT_US - SEND_MESSAGE - USE_APP - PLAY_GAME - SHOP_NOW - SIGN_UP - WATCH_VIDEO - SEND_EMAIL - LEARN_MORE - PURCHASE_GIFT_CARDS - ORDER_NOW - FOLLOW_PAGE type: string description: |- The action the consumer is being prompted to take by the button's text Filtering Type: `option` value: minLength: 0 type: string description: |- Indicates where consumers will be directed to upon clicking the Call-to-Action button (e.g., a URL). It can be a free-form string or an embedded value, depending on what the user specifies. For example, if the user sets the Facebook Call-to-Action as " 'Sign Up' using 'Website URL' " in the Yext platform, **`type`** will be `SIGN_UP` and **`value`** will be `[[websiteUrl]]`. The Call-to-Action will have the same behavior if the user sets the value to "Custom Value" in the platform and embeds a field. Filtering Type: `text` description: |- Designates the Facebook Call-to-Action button text and value Valid contents of **`value`** depends on the Call-to-Action's **`type`**: * `NONE`: (optional) * `BOOK_NOW`: URL * `CALL_NOW`: Phone number * `CONTACT_US`: URL * `SEND_MESSAGE`: Any string * `USE_APP`: URL * `PLAY_GAME`: URL * `SHOP_NOW`: URL * `SIGN_UP`: URL * `WATCH_VIDEO`: URL * `SEND_EMAIL`: Email address * `LEARN_MORE`: URL * `PURCHASE_GIFT_CARDS`: URL * `ORDER_NOW`: URL * `FOLLOW_PAGE`: Any string Filtering Type: `object` ``` Eligible For: * atm * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` facebookCoverPhoto: required: - url additionalProperties: false type: object description: |- The cover photo for the entity's Facebook profile Displayed as a 851 x 315 pixel image You may need a cover photo in order for your listing to appear on Facebook. Please check your listings tab to learn more. Image must be at least 400 x 150 pixels Image area (width x height) may be no more than 41000000 pixels Image may be no more than 30000 x 30000 pixels Supported Aspect Ratios: * 1 x 1 * 4 x 3 * 3 x 2 * 5 x 3 * 16 x 9 * 3 x 1 * 2 x 3 * 5 x 7 * 4 x 5 * 4 x 1 **NOTE**: Maximum image size is 5mb after normalization and padding (if applicable). As well, there is a 6 second download limit from the image host. Filtering Type: `object` ``` Eligible For: * atm * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` properties: alternateText: minLength: 0 type: string description: 'Filtering Type: `text`' url: minLength: 0 format: uri type: string description: 'Filtering Type: `text`' facebookDescriptor: minLength: 3 maxLength: 75 type: string description: |- Location Descriptors are used for Enterprise businesses that sync Facebook listings using brand page location structure. The Location Descriptor is typically an additional geographic description (e.g. geomodifier) that will appear in parentheses after the name on the Facebook listing. Cannot Include: * HTML markup Filtering Type: `text` ``` Eligible For: * atm * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` facebookName: minLength: 0 type: string description: |- The name for this entity's Facebook profile. A separate name may be specified to send only to Facebook in order to comply with any specific Facebook rules or naming conventions. Filtering Type: `text` ``` Eligible For: * atm * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` facebookOverrideCity: minLength: 0 type: string description: |- The city to be displayed on this entity's Facebook profile Filtering Type: `text` ``` Eligible For: * atm * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` facebookPageUrl: minLength: 0 type: string description: |- URL for the entity's Facebook Page. Valid formats: - facebook.com/profile.php?id=[numId] - facebook.com/group.php?gid=[numId] - facebook.com/groups/[numId] - facebook.com/[Name] - facebook.com/pages/[Name]/[numId] - facebook.com/people/[Name]/[numId] where [Name] is a String and [numId] is an Integer The success response will contain a warning message explaining why the URL wasn't stored in the system. Filtering Type: `text` ``` Eligible For: * atm * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * organization * restaurant ``` facebookParentPageId: minLength: 0 maxLength: 65 type: string description: |- The Facebook Page ID of this entity's brand page if in a brand page location structure Filtering Type: `text` ``` Eligible For: * atm * brand * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` facebookProfilePhoto: required: - url additionalProperties: false type: object description: |- The profile picture for the entity's Facebook profile You must have a profile picture in order for your listing to appear on Facebook. Image must be at least 180 x 180 pixels Image area (width x height) may be no more than 41000000 pixels Image may be no more than 30000 x 30000 pixels Supported Aspect Ratios: * 1 x 1 * 4 x 3 * 3 x 2 * 5 x 3 * 16 x 9 * 3 x 1 * 2 x 3 * 5 x 7 * 4 x 5 * 4 x 1 **NOTE**: Maximum image size is 5mb after normalization and padding (if applicable). As well, there is a 6 second download limit from the image host. Filtering Type: `object` ``` Eligible For: * atm * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` properties: alternateText: minLength: 0 type: string description: 'Filtering Type: `text`' url: minLength: 0 format: uri type: string description: 'Filtering Type: `text`' facebookStoreId: minLength: 0 type: string description: |- The Store ID used for this entity in a brand page location structure Filtering Type: `text` ``` Eligible For: * atm * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` facebookVanityUrl: minLength: 0 maxLength: 50 type: string description: |- The username that appear's in the Facebook listing URL to help customers find and remember a brand’s Facebook page. The username is also be used for tagging the Facebook page in other users’ posts, and searching for the Facebook page. Filtering Type: `text` ``` Eligible For: * atm * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` facebookWebsiteOverride: minLength: 0 format: uri type: string description: |- The URL you would like to submit to Facebook in place of the one given in **`websiteUrl`** (if applicable). Filtering Type: `text` ``` Eligible For: * atm * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` fax: minLength: 0 type: string description: |- Must be a valid fax number. If the fax number's calling code is for a country other than the one given in the entity's **`countryCode`**, the fax number provided must contain the calling code (e.g., `+44` in `+442038083831`). Otherwise, the calling code is optional. Filtering Type: `text` ``` Eligible For: * atm * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` featuredMessage: additionalProperties: false type: object properties: description: minLength: 0 maxLength: 50 type: string description: |- The text of Featured Message. Default: `Call today!` Cannot include: - inappropriate language - HTML markup - a URL or domain name - a phone number - control characters ([\x00-\x1F\x7F]) - insufficient spacing If you submit a Featured Message that contains profanity or more than 50 characters, it will be ignored. The success response will contain a warning message explaining why your Featured Message wasn't stored in the system. Cannot Include: * HTML markup Filtering Type: `text` url: minLength: 0 maxLength: 255 format: uri type: string description: |- Valid URL linked to the Featured Message text Filtering Type: `text` description: |- Information about the entity's Featured Message Filtering Type: `object` ``` Eligible For: * atm * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` firstName: minLength: 0 maxLength: 35 type: string description: |- The first name of the healthcare professional Cannot Include: * a URL or domain name * HTML markup Filtering Type: `text` ``` Eligible For: * healthcareProfessional ``` firstPartyReviewPage: minLength: 0 type: string description: |- Link to the review-collection page, where consumers can leave first-party reviews ``` Eligible For: * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` fitnessCenter: enum: - FITNESS_CENTER_AVAILABLE - FITNESS_CENTER_AVAILABLE_FOR_FREE - NOT_APPLICABLE type: string description: |- Indicates whether the entity has a fitness center. Filtering Type: `option` ``` Eligible For: * hotel ``` floorCount: multipleOf: 1 minimum: 0 type: number description: |- The number of floors the entity has from ground floor to top floor. Filtering Type: `integer` ``` Eligible For: * hotel ``` freeWeights: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity has free weights. Filtering Type: `option` ``` Eligible For: * hotel ``` frequentlyAskedQuestions: description: |- A list of questions that are frequently asked about this entity Array must be ordered. Array may have a maximum of 100 elements. Filtering Type: `list of object` ``` Eligible For: * atm * event * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` uniqueItems: true type: array items: required: - question additionalProperties: false type: object properties: answer: minLength: 1 maxLength: 4096 type: string description: 'Filtering Type: `text`' question: minLength: 1 maxLength: 4096 type: string description: 'Filtering Type: `text`' description: 'Filtering Type: `object`' frontDesk: enum: - FRONT_DESK_AVAILABLE - FRONT_DESK_AVAILABLE_24_HOURS - NOT_APPLICABLE type: string description: |- Indicates whether the entity has a front desk. Filtering Type: `option` ``` Eligible For: * hotel ``` fullyVaccinatedStaff: type: boolean description: |- Indicates whether the staff is vaccinated against COVID-19. Filtering Type: `boolean` ``` Eligible For: * healthcareFacility * hotel * location * restaurant ``` gameRoom: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity has a game room. Filtering Type: `option` ``` Eligible For: * hotel ``` gender: enum: - UNSPECIFIED - FEMALE - MALE - NONBINARY - TRANSGENDER_FEMALE - TRANSGENDER_MALE - OTHER - PREFER_NOT_TO_DISCLOSE type: string description: |- The gender of the healthcare professional Filtering Type: `option` ``` Eligible For: * healthcareProfessional ``` geomodifier: minLength: 0 type: string description: |- Provides additional information on where the entity can be found (e.g., `Times Square`, `Global Center Mall`) Filtering Type: `text` ``` Eligible For: * atm * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` giftShop: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity has a gift shop. Filtering Type: `option` ``` Eligible For: * hotel ``` golf: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity has a golf couse on premise or nearby. The golf course may be independently run. Filtering Type: `option` ``` Eligible For: * hotel ``` googleAttributes: additionalProperties: false type: object properties: {} description: |- The unique IDs of the entity's Google Business Profile keywords, as well as the unique IDs of any values selected for each keyword. Valid keywords (e.g., `has_drive_through`, `has_fitting_room`, `kitchen_in_room`) are determined by the entity's primary category. A full list of keywords can be retrieved with the Google Fields: List endpoint. Keyword values provide more details on how the keyword applies to the entity (e.g., if the keyword is `has_drive_through`, its values may be `true` or `false`). * If the **`v`** parameter is before `20181204`: **`googleAttributes`** is formatted as a map of key-value pairs (e.g., `[{ "id": "has_wheelchair_accessible_entrance", "values": [ "true" ] }]`) * If the **`v`** parameter is on or after `20181204`: the contents are formatted as a list of objects (e.g., `{ "has_wheelchair_accessible_entrance": [ "true" ]}`) **NOTE:** The latest Google Attributes are available via the Google Fields: List endpoint. Google Attributes are managed by Google and are subject to change without notice. To prevent errors, make sure your API implementation is not dependent on the presence of specific attributes. Filtering Type: `object` ``` Eligible For: * atm * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` googleCoverPhoto: required: - url additionalProperties: false type: object description: |- The cover photo for the entity's Google profile Image must be at least 250 x 250 pixels Filtering Type: `object` ``` Eligible For: * atm * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` properties: alternateText: minLength: 0 type: string description: 'Filtering Type: `text`' url: minLength: 0 format: uri type: string description: 'Filtering Type: `text`' googleMessaging: additionalProperties: false type: object properties: smsNumber: minLength: 0 type: string description: |- The SMS phone number of the entity's point of contact for messaging/ chat functionality. Must be a valid phone number. If the phone number's calling code is for a country other than the one given in the entity's countryCode, the phone number provided must contain the calling code (e.g., +44 in +442038083831). Otherwise, the calling code is optional. Filtering Type: `text` whatsappMessagingUrl: minLength: 0 maxLength: 2000 format: uri type: string description: |- A valid URL for this entity's WhatsApp account. Must be a valid URL Filtering Type: `text` description: |- Information about Google Messaging, WhatsApp and SMS, for the entity’s point of contact for messaging/chat functionality. NOTE: Only one, either WhatsApp or SMS is displayed on the Google listing. If both SMS Number and WhatsApp URL are provided only SMS Number will be displayed on the listing. Filtering Type: `object` ``` Eligible For: * atm * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` googleMyBusinessLabels: description: |- Google Business Profile Labels help users organize their locations into groups within GBP. Array must be ordered. Array may have a maximum of 10 elements. Array item description: >Cannot Include: >* HTML markup Filtering Type: `list of text` ``` Eligible For: * atm * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` uniqueItems: true type: array items: minLength: 0 maxLength: 50 type: string description: |- Cannot Include: * HTML markup Filtering Type: `text` googlePlaceId: minLength: 0 type: string description: |- The unique identifier of this entity on Google Maps. Filtering Type: `text` ``` Eligible For: * atm * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` googleProfilePhoto: required: - url additionalProperties: false type: object description: |- The profile photo for the entity's Google profile Image must be at least 250 x 250 pixels Image may be no more than 5000 x 5000 pixels Supported Aspect Ratios: * 1 x 1 **NOTE**: Maximum image size is 5mb after normalization and padding (if applicable). As well, there is a 6 second download limit from the image host. Filtering Type: `object` ``` Eligible For: * atm * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` properties: alternateText: minLength: 0 type: string description: 'Filtering Type: `text`' url: minLength: 0 format: uri type: string description: 'Filtering Type: `text`' googleWebsiteOverride: minLength: 0 format: uri type: string description: |- 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. Filtering Type: `text` ``` Eligible For: * atm * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` happyHours: additionalProperties: false type: object properties: friday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the happy hours are "closed" on Friday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity's happy hours on Friday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' holidayHours: description: |- **NOTE:** The list of Holiday Hours that you send us must be comprehensive. For example, if you send us a list of Holiday Hours that does not include Holiday Hours that you sent in your last update, Yext considers the missing Holiday Hours to be deleted, and we remove them. Array must be ordered. Filtering Type: `list of object` uniqueItems: true type: array items: required: - date additionalProperties: false type: object properties: date: format: date type: string description: |- Date on which the holiday hours will be in effect. Cannot be in the past. Date must be on or after 1970-01-01 Date must be before or on 2038-01-01 Filtering Type: `date` isClosed: type: boolean description: |- Indicates if the happy hours are "closed" on on the given date. Filtering Type: `boolean` isRegularHours: type: boolean description: |- Indicates whether the holiday hours are the same as the regular business hours for the given date. If set to true, we will update the holiday hours if the regular business hours change for the date's day of the week. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for the Entity's happy hours on the specified date. Filtering Type: `list of object` description: 'Filtering Type: `object`' monday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the happy hours are "closed" on Monday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for the Entity's happy hours on Monday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' reopenDate: format: date type: string description: |- Date must be on or after 1970-01-01 Date must be before or on 2038-01-01 Filtering Type: `date` saturday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the happy hours are "closed" on Saturday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for the Entity's happy hours on Saturday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' sunday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the happy hours are "closed" on Sunday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for the Entity's happy hours on Sunday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' thursday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the happy hours are "closed" on Thursday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for the Entity's happy hours on Thursday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' tuesday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the happy hours are "closed" on Tuesday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for the Entity's happy hours on Tuesday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' wednesday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the happy hours are "closed" on Wednesday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for the Entity's happy hours on Wednesday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' description: |- Contains the daily happy hours, holiday happy hours, and reopen date for the Entity. Each day is represented by a sub-field of `happyHours`. (e.g. `monday`, `tuesday`, etc.) Open times can be specified per day through the `openIntervals` field and the `isClosed` flag. Similarly, holiday happy hours are represented by the `holidayHours` sub-field. Setting the `reopenDate` sub-field indicates that the business is temporarily closed and will reopen on the specified date. SPECIAL CASES: * To indicate that an Entity is open 24 hours on a specific day, set start to 00:00 and end to 23:59 in `openIntervals` for that day. * To indicate that an Entity has split hours on a specific day (e.g., open from 9:00 AM to 12:00 PM and again from 1:00 PM to 5:00 PM), supply two or more `openIntervals` values with non-overlapping sets of hours. * If you are providing `openIntervals`, you may not set `isClosed` to true for that day. Filtering Type: `hours` ``` Eligible For: * hotel * location * restaurant ``` headshot: required: - url additionalProperties: false type: object description: |- A portrait of the healthcare professional Filtering Type: `object` ``` Eligible For: * contactCard * financialProfessional * healthcareProfessional ``` properties: alternateText: minLength: 0 type: string description: 'Filtering Type: `text`' url: minLength: 0 format: uri type: string description: 'Filtering Type: `text`' hiringOrganization: minLength: 0 type: string description: |- The organization that is hiring for the open job Filtering Type: `text` ``` Eligible For: * job ``` holidayHoursConversationEnabled: type: boolean description: |- Indicates whether holiday-hour confirmation alerts are enabled for the Yext Knowledge Assistant for this entity Filtering Type: `boolean` ``` Eligible For: * atm * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` horsebackRiding: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity offers horseback riding. Filtering Type: `option` ``` Eligible For: * hotel ``` hotTub: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity has a hot tub. Filtering Type: `option` ``` Eligible For: * hotel ``` hours: additionalProperties: false type: object properties: friday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the hours of operation are "closed" on Friday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is open on Friday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' holidayHours: description: |- **NOTE:** The list of Holiday Hours that you send us must be comprehensive. For example, if you send us a list of Holiday Hours that does not include Holiday Hours that you sent in your last update, Yext considers the missing Holiday Hours to be deleted, and we remove them. Array must be ordered. Filtering Type: `list of object` uniqueItems: true type: array items: required: - date additionalProperties: false type: object properties: date: format: date type: string description: |- Date on which the holiday hours will be in effect. Cannot be in the past. Date must be on or after 1970-01-01 Date must be before or on 2038-01-01 Filtering Type: `date` isClosed: type: boolean description: |- Indicates if the hours of operation are "closed" on on the given date. Filtering Type: `boolean` isRegularHours: type: boolean description: |- Indicates whether the holiday hours are the same as the regular business hours for the given date. If set to true, we will update the holiday hours if the regular business hours change for the date's day of the week. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is open on the specified date. Filtering Type: `list of object` description: 'Filtering Type: `object`' monday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the hours of operation are "closed" on Monday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is open on Monday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' reopenDate: format: date type: string description: |- Date must be on or after 1970-01-01 Date must be before or on 2038-01-01 Filtering Type: `date` saturday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the hours of operation are "closed" on Saturday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is open on Saturday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' sunday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the hours of operation are "closed" on Sunday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is open on Sunday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' thursday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the hours of operation are "closed" on Thursday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is open on Thursday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' tuesday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the hours of operation are "closed" on Tuesday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is open on Tuesday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' wednesday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the hours of operation are "closed" on Wednesday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is open on Wednesday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' description: |- Contains the daily hours, holiday hours, and reopen date for the Entity. Each day is represented by a sub-field of `hours`. (e.g. `monday`, `tuesday`, etc.) Open times can be specified per day through the `openIntervals` field and the `isClosed` flag. Similarly, holiday hours are represented by the `holidayHours` sub-field. Setting the `reopenDate` sub-field indicates that the business is temporarily closed and will reopen on the specified date. SPECIAL CASES: * To indicate that an Entity is open 24 hours on a specific day, set start to 00:00 and end to 23:59 in `openIntervals` for that day. * To indicate that an Entity has split hours on a specific day (e.g., open from 9:00 AM to 12:00 PM and again from 1:00 PM to 5:00 PM), supply two or more `openIntervals` values with non-overlapping sets of hours. * If you are providing `openIntervals`, you may not set `isClosed` to true for that day. Filtering Type: `hours` ``` Eligible For: * atm * contactCard * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` housekeeping: enum: - HOUSEKEEPING_AVAILABLE - HOUSEKEEPING_AVAILABLE_DAILY - NOT_APPLICABLE type: string description: |- Indicates whether the entity offers housekeeping services. Filtering Type: `option` ``` Eligible For: * hotel ``` impressum: minLength: 0 maxLength: 2000 type: string description: |- A statement of the ownership and authorship of a document. Individuals or organizations based in many German-speaking countries are required by law to include an Impressum in published media. Filtering Type: `text` ``` Eligible For: * atm * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` indoorPoolCount: multipleOf: 1 minimum: 0 type: number description: |- A count of the number of indoor pools Filtering Type: `integer` ``` Eligible For: * hotel ``` instagramHandle: minLength: 0 maxLength: 30 type: string description: |- Valid Instagram username for the entity without the leading "@" (e.g., `NewCityAuto`) Filtering Type: `text` ``` Eligible For: * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * organization * restaurant ``` insuranceAccepted: description: |- A list of insurance policies accepted by the healthcare provider Array must be ordered. Array may have a maximum of 100 elements. Array item description: >Cannot Include: >* HTML markup Filtering Type: `list of text` ``` Eligible For: * healthcareFacility * healthcareProfessional ``` uniqueItems: true type: array items: minLength: 0 maxLength: 100 type: string description: |- Cannot Include: * HTML markup Filtering Type: `text` iosAppUrl: minLength: 0 type: string description: |- The URL where consumers can download the entity's app to their iPhone or iPad Filtering Type: `text` ``` Eligible For: * brand * financialProfessional * hotel * location * restaurant ``` isClusterPrimary: type: boolean description: |- Indicates whether the healthcare entity is the primary entity in its group Filtering Type: `boolean` ``` Eligible For: * healthcareProfessional ``` isFreeEvent: type: boolean description: |- Indicates whether or not the event is free Filtering Type: `boolean` ``` Eligible For: * event ``` isoRegionCode: minLength: 0 type: string description: |- The ISO 3166-2 region code for the entity Yext will determine the entity's code and update **`isoRegionCode`** with that value. If Yext is unable to determine the code for the entity, the entity'ss ISO 3166-1 alpha-2 country code will be used. Filtering Type: `text` ``` Eligible For: * atm * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` keywords: description: |- Keywords that describe the entity. All strings must be non-empty when trimmed of whitespace. Array must be ordered. Array may have a maximum of 100 elements. Array item description: >Cannot Include: >* HTML markup Filtering Type: `list of text` ``` Eligible For: * atm * card * event * faq * financialProfessional * healthcareFacility * healthcareProfessional * helpArticle * hotel * job * location * product * restaurant ``` uniqueItems: true type: array items: minLength: 0 maxLength: 100 type: string description: |- Cannot Include: * HTML markup Filtering Type: `text` kidFriendly: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates if the entity is kid friendly. Filtering Type: `option` ``` Eligible For: * hotel ``` kidsClub: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates if the property has a Kids Club. Filtering Type: `option` ``` Eligible For: * hotel ``` kidsStayFree: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity allows kids to stay free. Filtering Type: `option` ``` Eligible For: * hotel ``` kitchenHours: additionalProperties: false type: object properties: friday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the kitchen hours are "closed" on Friday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity's kitchen is open on Friday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' holidayHours: description: |- **NOTE:** The list of Holiday Hours that you send us must be comprehensive. For example, if you send us a list of Holiday Hours that does not include Holiday Hours that you sent in your last update, Yext considers the missing Holiday Hours to be deleted, and we remove them. Array must be ordered. Filtering Type: `list of object` uniqueItems: true type: array items: required: - date additionalProperties: false type: object properties: date: format: date type: string description: |- Date on which the holiday hours will be in effect. Cannot be in the past. Date must be on or after 1970-01-01 Date must be before or on 2038-01-01 Filtering Type: `date` isClosed: type: boolean description: |- Indicates if the kitchen hours are "closed" on on the given date. Filtering Type: `boolean` isRegularHours: type: boolean description: |- Indicates whether the holiday hours are the same as the regular business hours for the given date. If set to true, we will update the holiday hours if the regular business hours change for the date's day of the week. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity's kitchen is open on the specified date. Filtering Type: `list of object` description: 'Filtering Type: `object`' monday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the kitchen hours are "closed" on Monday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity's kitchen is open on Monday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' reopenDate: format: date type: string description: |- Date must be on or after 1970-01-01 Date must be before or on 2038-01-01 Filtering Type: `date` saturday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the kitchen hours are "closed" on Saturday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity's kitchen is open on Saturday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' sunday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the kitchen hours are "closed" on Sunday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity's kitchen is open on Sunday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' thursday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the kitchen hours are "closed" on Thursday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity's kitchen is open on Thursday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' tuesday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the kitchen hours are "closed" on Tuesday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity's kitchen open on Tuesday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' wednesday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the kitchen hours are "closed" on Wednesday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity's kitchen is open on Wednesday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' description: |- Contains the daily kitchen hours, holiday kitchen hours, and reopen date for the Entity. Each day is represented by a sub-field of `kitchenHours`. (e.g. `monday`, `tuesday`, etc.) Open times can be specified per day through the `openIntervals` field and the `isClosed` flag. Similarly, holiday kitchen hours are represented by the `holidayHours` sub-field. Setting the `reopenDate` sub-field indicates that the business is temporarily closed and will reopen on the specified date. SPECIAL CASES: * To indicate that an Entity is open 24 hours on a specific day, set start to 00:00 and end to 23:59 in `openIntervals` for that day. * To indicate that an Entity has split hours on a specific day (e.g., open from 9:00 AM to 12:00 PM and again from 1:00 PM to 5:00 PM), supply two or more `openIntervals` values with non-overlapping sets of hours. * If you are providing `openIntervals`, you may not set `isClosed` to true for that day. Filtering Type: `hours` ``` Eligible For: * hotel * location * restaurant ``` labels: uniqueItems: false type: array items: minLength: 0 type: string description: |- The IDs of the entity labels that have been added to this entity. Entity labels help you identify entities that share a certain characteristic; they do not appear on your entity'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. Filtering Type: `opaque` ``` Eligible For: * atm * board * brand * card * contactCard * event * faq * financialProfessional * healthcareFacility * healthcareProfessional * helpArticle * hotel * hotelRoomType * job * location * organization * product * restaurant ``` landingPageUrl: minLength: 0 format: uri type: string description: |- The URL of this entity's Landing Page that was created with Yext Pages Filtering Type: `text` ``` Eligible For: * atm * card * event * faq * financialProfessional * healthcareFacility * healthcareProfessional * helpArticle * hotel * job * location * product * restaurant ``` languages: description: |- The langauges in which consumers can commicate with this entity or its staff members All strings must be non-empty when trimmed of whitespace. Array must be ordered. Array may have a maximum of 100 elements. Array item description: >Cannot Include: >* HTML markup Filtering Type: `list of text` ``` Eligible For: * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` uniqueItems: true type: array items: minLength: 0 maxLength: 100 type: string description: |- Cannot Include: * HTML markup Filtering Type: `text` lastName: minLength: 0 maxLength: 35 type: string description: |- The last name of the healthcare professional Cannot Include: * a URL or domain name * HTML markup Filtering Type: `text` ``` Eligible For: * healthcareProfessional ``` laundry: enum: - FULL_SERVICE - SELF_SERVICE - NOT_APPLICABLE type: string description: |- Indicates whether the entity offers laundry services. Filtering Type: `option` ``` Eligible For: * hotel ``` lazyRiver: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates if the property has a lazy river Filtering Type: `option` ``` Eligible For: * hotel ``` lifeguard: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates if the property has a lifeguard on duty Filtering Type: `option` ``` Eligible For: * hotel ``` linkedInUrl: minLength: 0 format: uri type: string description: |- URL for your LinkedIn account, format should be https://www.linkedin.com/in/yourUsername Filtering Type: `text` ``` Eligible For: * contactCard * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * organization * restaurant ``` linkedLocation: type: string description: |- location ID of the event location, if the event is held at a location managed in the Yext Knowledge Manager Filtering Type: `entityId` ``` Eligible For: * contactCard * event ``` localPhone: minLength: 0 type: string description: |- Must be a valid, non-toll-free phone number, based on the country specified in **`address.region`**. Phone numbers for US entities must contain 10 digits. Filtering Type: `text` ``` Eligible For: * atm * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` localShuttle: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity offers local shuttle services. Filtering Type: `option` ``` Eligible For: * hotel ``` locatedIn: type: string description: |- For atms, the external ID of the entity that the atm is installed in. The entity must be in the same business account as the atm. Filtering Type: `entityId` ``` Eligible For: * atm ``` location: additionalProperties: false type: object properties: existingLocation: type: string description: |- A location entity referenced by Yext ID or Entity ID where this job opening exists Filtering Type: `entityId` externalLocation: minLength: 0 maxLength: 255 type: string description: |- A location string where this job opening exists Cannot Include: * a URL or domain name * HTML markup Filtering Type: `text` description: |- The location where this job opening exists as either an existing location or an external location Filtering Type: `object` ``` Eligible For: * job ``` locationType: enum: - LOCATION - HEALTHCARE_FACILITY - HEALTHCARE_PROFESSIONAL - ATM - RESTAURANT - HOTEL type: string description: |- Indicates the entity's type, if it is not an event Filtering Type: `option` ``` Eligible For: * atm * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` logo: required: - image additionalProperties: false type: object description: |- An image of the entity's logo Supported Aspect Ratios: * 1 x 1 **NOTE**: Maximum image size is 5mb after normalization and padding (if applicable). As well, there is a 6 second download limit from the image host. Filtering Type: `object` ``` Eligible For: * atm * contactCard * faq * financialProfessional * healthcareFacility * healthcareProfessional * hotel * job * location * organization * restaurant ``` properties: clickthroughUrl: minLength: 0 format: uri type: string description: 'Filtering Type: `text`' description: minLength: 0 type: string description: 'Filtering Type: `text`' details: minLength: 0 type: string description: 'Filtering Type: `text`' image: required: - url additionalProperties: false type: object description: |- Supported Aspect Ratios: * 1 x 1 **NOTE**: Maximum image size is 5mb after normalization and padding (if applicable). As well, there is a 6 second download limit from the image host. Filtering Type: `object` properties: alternateText: minLength: 0 type: string description: 'Filtering Type: `text`' url: minLength: 0 format: uri type: string description: 'Filtering Type: `text`' mainPhone: minLength: 0 type: string description: |- The main phone number of the entity's point of contact Must be a valid phone number. If the phone number's calling code is for a country other than the one given in the entity's **`countryCode`**, the phone number provided must contain the calling code (e.g., `+44` in `+442038083831`). Otherwise, the calling code is optional. Filtering Type: `text` ``` Eligible For: * atm * contactCard * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * organization * restaurant ``` massage: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity offers massage services. Filtering Type: `option` ``` Eligible For: * hotel ``` maxAgeOfKidsStayFree: multipleOf: 1 minimum: 0 type: number description: |- The maximum age specified by the property for children to stay in the room/suite of a parent or adult without an additional fee Filtering Type: `integer` ``` Eligible For: * hotel ``` maxNumberOfKidsStayFree: multipleOf: 1 minimum: 0 type: number description: |- The maximum number of children who can stay in the room/suite of a parent or adult without an additional fee Filtering Type: `integer` ``` Eligible For: * hotel ``` mealsServed: uniqueItems: true type: array items: enum: - BREAKFAST - LUNCH - BRUNCH - DINNER - HAPPY_HOUR - LATE_NIGHT type: string description: 'Filtering Type: `option`' description: |- Types of meals served at this restaurant Filtering Type: `list of option` ``` Eligible For: * restaurant ``` meetingRoomCount: multipleOf: 1 minimum: 0 type: number description: |- The number of meeting rooms the entity has. Filtering Type: `integer` ``` Eligible For: * hotel ``` menuUrl: additionalProperties: false type: object properties: displayUrl: minLength: 0 maxLength: 2000 format: uri type: string description: |- The URL that is shown on your listings in place of **`menuUrl.url`**. You can use **`menuUrl.displayUrl`** to display a short, memorable web address that redirects consumers to the URL given in **`menuUrl.url`**. Filtering Type: `text` preferDisplayUrl: type: boolean description: |- If set to true, only the display URL will be sent to those publishers who do not support separate display and tracking URLs for this field. Filtering Type: `boolean` url: minLength: 0 maxLength: 2000 format: uri type: string description: |- A valid URL where consumers can view the entity's menu Filtering Type: `text` description: |- Information about the URL where consumers can view the entity's menu Filtering Type: `object` ``` Eligible For: * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` menus: additionalProperties: false type: object properties: ids: description: |- IDs of the Menu Lists associated with this entity Array must be ordered. Array may have a maximum of 40 elements. Filtering Type: `list of text` uniqueItems: true type: array items: minLength: 0 type: string description: 'Filtering Type: `text`' label: minLength: 0 maxLength: 30 type: string description: |- Label to be used for this entity's Menu Lists. This label will appear on your entity's listings. Filtering Type: `text` description: |- Information about the Menu Content Lists associated with this entity Filtering Type: `object` ``` Eligible For: * hotel * location * restaurant ``` middleName: minLength: 0 maxLength: 35 type: string description: |- The middle name of the healthcare professional Cannot Include: * a URL or domain name * HTML markup Filtering Type: `text` ``` Eligible For: * healthcareProfessional ``` mobilePhone: minLength: 0 type: string description: |- Must be a valid phone number. If the phone number's calling code is for a country other than the one given in the entity's **`countryCode`**, the phone number provided must contain the calling code (e.g., `+44` in `+442038083831`). Otherwise, the calling code is optional. Filtering Type: `text` ``` Eligible For: * atm * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` mobilityAccessible: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity is mobility/wheelchair accessible Filtering Type: `option` ``` Eligible For: * hotel ``` nightclub: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity has a nightclub. Filtering Type: `option` ``` Eligible For: * hotel ``` npi: minLength: 0 type: string description: |- The National Provider Identifier (NPI) of the healthcare provider Filtering Type: `text` ``` Eligible For: * healthcareFacility * healthcareProfessional ``` nudgeEnabled: type: boolean description: |- Indicates whether Knowledge Nudge is enabled for the Yext Knowledge Assistant for this entity Filtering Type: `boolean` ``` Eligible For: * atm * faq * financialProfessional * healthcareFacility * healthcareProfessional * helpArticle * hotel * job * location * organization * product * restaurant ``` officeName: minLength: 0 type: string description: |- The name of the office where the healthcare professional works, if different from **`name`** Filtering Type: `text` ``` Eligible For: * healthcareProfessional ``` onlineServiceHours: additionalProperties: false type: object properties: friday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the online service hours are "closed" on Friday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for the Entity's online service hours on Friday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' holidayHours: description: |- **NOTE:** The list of Holiday Hours that you send us must be comprehensive. For example, if you send us a list of Holiday Hours that does not include Holiday Hours that you sent in your last update, Yext considers the missing Holiday Hours to be deleted, and we remove them. Array must be ordered. Filtering Type: `list of object` uniqueItems: true type: array items: required: - date additionalProperties: false type: object properties: date: format: date type: string description: |- Date on which the holiday hours will be in effect. Cannot be in the past. Date must be on or after 1970-01-01 Date must be before or on 2038-01-01 Filtering Type: `date` isClosed: type: boolean description: |- Indicates if the online service hours are "closed" on on the given date. Filtering Type: `boolean` isRegularHours: type: boolean description: |- Indicates whether the holiday hours are the same as the regular business hours for the given date. If set to true, we will update the holiday hours if the regular business hours change for the date's day of the week. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for the Entity's online service hours on the specified date. Filtering Type: `list of object` description: 'Filtering Type: `object`' monday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the online service hours are "closed" on Monday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for the Entity's online service hours on Monday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' reopenDate: format: date type: string description: |- Date must be on or after 1970-01-01 Date must be before or on 2038-01-01 Filtering Type: `date` saturday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the online service hours are "closed" on Saturday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for the Entity's online service hours on Saturday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' sunday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the online service hours are "closed" on Sunday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for the Entity's online service hours on Sunday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' thursday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the online service hours are "closed" on Thursday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for the Entity's online service hours on Thursday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' tuesday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the online service hours are "closed" on Tuesday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for the Entity's online service hours on Tuesday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' wednesday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the online service hours are "closed" on Wednesday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for the Entity's online service hours on Wednesday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' description: |- Contains the daily online service hours, holiday online service hours, and reopen date for the Entity. Each day is represented by a sub-field of `onlineServiceHours`. (e.g. `monday`, `tuesday`, etc.) Open times can be specified per day through the `openIntervals` field and the `isClosed` flag. Similarly, holiday online service hours are represented by the `holidayHours` sub-field. Setting the `reopenDate` sub-field indicates that the business is temporarily closed and will reopen on the specified date. SPECIAL CASES: * To indicate that an Entity is open 24 hours on a specific day, set start to 00:00 and end to 23:59 in `openIntervals` for that day. * To indicate that an Entity has split hours on a specific day (e.g., open from 9:00 AM to 12:00 PM and again from 1:00 PM to 5:00 PM), supply two or more `openIntervals` values with non-overlapping sets of hours. * If you are providing `openIntervals`, you may not set `isClosed` to true for that day. Filtering Type: `hours` ``` Eligible For: * financialProfessional * healthcareFacility * healthcareProfessional * location * restaurant ``` openDate: format: date type: string description: |- The date that the entity is set to open for the first time. Must be formatted in YYYY-MM-DD format. Date must be on or after 1970-01-01 Date must be before or on 2038-01-01 Filtering Type: `date` ``` Eligible For: * atm * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` operatingCountries: uniqueItems: true type: array items: enum: - AD - AE - AF - AG - AI - AL - AM - AO - AR - AS - AT - AU - AW - AX - AZ - BA - BB - BD - BE - BF - BG - BH - BI - BJ - BL - BM - BN - BO - BQ - BR - BS - BT - BW - BY - BZ - CA - CD - CF - CG - CH - CI - CK - CL - CM - CN - CO - CR - CU - CV - CW - CY - CZ - DE - DJ - DK - DM - DO - DZ - EC - EE - EG - EH - ER - ES - ET - FI - FJ - FK - FM - FO - FR - GA - GB - GD - GE - GF - GG - GH - GI - GL - GM - GN - GP - GQ - GR - GT - GU - GW - GY - HK - HN - HR - HT - HU - ID - IE - IL - IM - IN - IQ - IR - IS - IT - JE - JM - JO - JP - KE - KG - KH - KI - KM - KN - KR - KW - KY - KZ - LA - LB - LC - LI - LK - LR - LS - LT - LU - LV - LY - MA - MC - MD - ME - MF - MG - MH - MK - ML - MM - MN - MO - MP - MQ - MR - MS - MT - MU - MV - MW - MX - MY - MZ - NA - NC - NE - NG - NI - NL - 'NO' - NP - NR - NZ - OM - PA - PE - PF - PG - PH - PK - PL - PM - PR - PS - PT - PW - PY - QA - RE - RO - RS - RU - RW - SA - SB - SC - SD - SE - SG - SH - SI - SJ - SK - SL - SM - SN - SO - SR - SS - ST - SV - SX - SY - SZ - TC - TD - TG - TH - TJ - TL - TM - TN - TO - TR - TT - TV - TW - TZ - UA - UG - US - UY - UZ - VA - VC - VE - VG - VI - VN - VU - WF - WS - XK - YE - YT - ZA - ZM - ZW type: string description: 'Filtering Type: `option`' description: |- The list of countries the business operates in Filtering Type: `list of option` ``` Eligible For: * organization ``` orderUrl: additionalProperties: false type: object properties: displayUrl: minLength: 0 maxLength: 2000 format: uri type: string description: |- The URL that is shown on your listings in place of **`orderUrl.url`**. You can use **`orderUrl.displayUrl`** to display a short, memorable web address that redirects consumers to the URL given in **`orderUrl.url`**. Filtering Type: `text` preferDisplayUrl: type: boolean description: |- If set to true, only the display URL will be sent to those publishers who do not support separate display and tracking URLs for this field. Filtering Type: `boolean` url: minLength: 0 maxLength: 2000 format: uri type: string description: |- A valid URL used to place an order at this entity Filtering Type: `text` description: |- Information about the URL used to place orders that will be fulfilled by the entity Filtering Type: `object` ``` Eligible For: * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` organizerEmail: minLength: 0 format: email type: string description: |- Point of contact for the event organizer (not to be published publicly) Filtering Type: `text` ``` Eligible For: * event ``` organizerName: minLength: 0 type: string description: |- Point of contact for the event organizer (not to be published publicly) Filtering Type: `text` ``` Eligible For: * event ``` organizerPhone: minLength: 0 type: string description: |- Point of contact for the event organizer (not to be published publicly) Filtering Type: `text` ``` Eligible For: * event ``` outdoorPoolCount: multipleOf: 1 minimum: 0 type: number description: |- The number of outdoor pools the entity has. Filtering Type: `integer` ``` Eligible For: * hotel ``` parking: enum: - PARKING_AVAILABLE - PARKING_AVAILABLE_FOR_FREE - NOT_APPLICABLE type: string description: |- Indicates whether the entity offers parking services. Filtering Type: `option` ``` Eligible For: * hotel ``` paymentOptions: uniqueItems: true type: array items: enum: - AFTERPAY - ALIPAY - AMERICANEXPRESS - ANDROIDPAY - APPLEPAY - ATM - ATMQUICK - BACS - BANCONTACT - BANKDEPOSIT - BANKPAY - BGO - BITCOIN - Bar - CARTASI - CASH - CCS - CHECK - CHEQUESVACANCES - CONB - CONTACTLESSPAYME - CVVV - DEBITCARD - DEBITNOTE - DINERSCLUB - DIRECTDEBIT - DISCOVER - ECKARTE - ECOCHEQUE - EKENA - EMV - FINANCING - GIFTCARD - GOPAY - HAYAKAKEN - HEBAG - IBOD - ICCARDS - ICOCA - ID - IDEAL - INCA - INVOICE - JCB - JCoinPay - JKOPAY - KITACA - KLA - KLARNA - LINEPAY - MAESTRO - MANACA - MASTERCARD - MIPAY - MONIZZE - MPAY - Manuelle Lastsch - Merpay - NANACO - NEXI - NIMOCA - OREM - PASMO - PAYBACKPAY - PAYBOX - PAYCONIQ - PAYPAL - PAYPAY - PAYSEC - PIN - POSTEPAY - QRCODE - QUICPAY - RAKUTENEDY - RAKUTENPAY - SAMSUNGPAY - SODEXO - SUGOCA - SUICA - SWISH - TICKETRESTAURANT - TOICA - TRAVELERSCHECK - TSCUBIC - TWINT - UNIONPAY - VEV - VISA - VISAELECTRON - VOB - VOUCHER - VPAY - WAON - WECHATPAY - WIRETRANSFER - Yucho Pay - ZELLE - auPay - dBarai - Überweisung type: string description: 'Filtering Type: `option`' description: |- The payment methods accepted by this entity Valid elements depend on the entity's country. Filtering Type: `list of option` ``` Eligible For: * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` performers: description: |- Performers at the event Array must be ordered. Array may have a maximum of 100 elements. Filtering Type: `list of text` ``` Eligible For: * event ``` uniqueItems: true type: array items: minLength: 0 maxLength: 100 type: string description: 'Filtering Type: `text`' petsAllowed: enum: - PETS_WELCOME - PETS_WELCOME_FOR_FREE - NOT_APPLICABLE - NOT_ALLOWED type: string description: |- Indicates if the entity is pet friendly. Filtering Type: `option` ``` Eligible For: * hotel ``` photoGallery: description: |- **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. Array must be ordered. Array may have a maximum of 500 elements. Array item description: >Supported Aspect Ratios: >* 1 x 1 >* 4 x 3 >* 3 x 2 >* 5 x 3 >* 16 x 9 >* 3 x 1 >* 2 x 3 >* 5 x 7 >* 4 x 5 >* 4 x 1 > >**NOTE**: Maximum image size is 5mb after normalization and padding (if applicable). As well, there is a 6 second download limit from the image host. > Filtering Type: `list of object` ``` Eligible For: * atm * event * financialProfessional * healthcareFacility * healthcareProfessional * hotel * hotelRoomType * location * organization * product * restaurant ``` uniqueItems: false type: array items: required: - image additionalProperties: false type: object description: |- Supported Aspect Ratios: * 1 x 1 * 4 x 3 * 3 x 2 * 5 x 3 * 16 x 9 * 3 x 1 * 2 x 3 * 5 x 7 * 4 x 5 * 4 x 1 **NOTE**: Maximum image size is 5mb after normalization and padding (if applicable). As well, there is a 6 second download limit from the image host. Filtering Type: `object` properties: clickthroughUrl: minLength: 0 format: uri type: string description: 'Filtering Type: `text`' description: minLength: 0 type: string description: 'Filtering Type: `text`' details: minLength: 0 type: string description: 'Filtering Type: `text`' image: required: - url additionalProperties: false type: object description: |- Supported Aspect Ratios: * 1 x 1 * 4 x 3 * 3 x 2 * 5 x 3 * 16 x 9 * 3 x 1 * 2 x 3 * 5 x 7 * 4 x 5 * 4 x 1 **NOTE**: Maximum image size is 5mb after normalization and padding (if applicable). As well, there is a 6 second download limit from the image host. Filtering Type: `object` properties: alternateText: minLength: 0 type: string description: 'Filtering Type: `text`' url: minLength: 0 format: uri type: string description: 'Filtering Type: `text`' pickupCoordinate: additionalProperties: false type: object properties: latitude: minimum: -90 maximum: 90 type: number description: 'Filtering Type: `float`' longitude: minimum: -180 maximum: 180 type: number description: 'Filtering Type: `float`' description: |- Coordinates of where consumers can be picked up at the entity, as provided by you Filtering Type: `object` ``` Eligible For: * atm * event * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` pickupHours: additionalProperties: false type: object properties: friday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the pickup hours are "closed" on Friday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is open for pickup on Friday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' holidayHours: description: |- **NOTE:** The list of Holiday Hours that you send us must be comprehensive. For example, if you send us a list of Holiday Hours that does not include Holiday Hours that you sent in your last update, Yext considers the missing Holiday Hours to be deleted, and we remove them. Array must be ordered. Filtering Type: `list of object` uniqueItems: true type: array items: required: - date additionalProperties: false type: object properties: date: format: date type: string description: |- Date on which the holiday hours will be in effect. Cannot be in the past. Date must be on or after 1970-01-01 Date must be before or on 2038-01-01 Filtering Type: `date` isClosed: type: boolean description: |- Indicates if the pickup hours are "closed" on on the given date. Filtering Type: `boolean` isRegularHours: type: boolean description: |- Indicates whether the holiday hours are the same as the regular business hours for the given date. If set to true, we will update the holiday hours if the regular business hours change for the date's day of the week. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is open for pickup on the specified date. Filtering Type: `list of object` description: 'Filtering Type: `object`' monday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the pickup hours are "closed" on Monday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is open for pickup on Monday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' reopenDate: format: date type: string description: |- Date must be on or after 1970-01-01 Date must be before or on 2038-01-01 Filtering Type: `date` saturday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the pickup hours are "closed" on Saturday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is open for pickup on Saturday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' sunday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the pickup hours are "closed" on Sunday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is open for pickup on Sunday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' thursday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the pickup hours are "closed" on Thursday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is open for pickup on Thursday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' tuesday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the pickup hours are "closed" on Tuesday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is open for pickup on Tuesday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' wednesday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the pickup hours are "closed" on Wednesday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is open for pickup on Wednesday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' description: |- Contains the daily pickup hours, holiday pickup hours, and reopen date for the Entity. Each day is represented by a sub-field of `pickupHours`. (e.g. `monday`, `tuesday`, etc.) Open times can be specified per day through the `openIntervals` field and the `isClosed` flag. Similarly, holiday pickup hours are represented by the `holidayHours` sub-field. Setting the `reopenDate` sub-field indicates that the business is temporarily closed and will reopen on the specified date. SPECIAL CASES: * To indicate that an Entity is open 24 hours on a specific day, set start to 00:00 and end to 23:59 in `openIntervals` for that day. * To indicate that an Entity has split hours on a specific day (e.g., open from 9:00 AM to 12:00 PM and again from 1:00 PM to 5:00 PM), supply two or more `openIntervals` values with non-overlapping sets of hours. * If you are providing `openIntervals`, you may not set `isClosed` to true for that day. Filtering Type: `hours` ``` Eligible For: * healthcareFacility * location * restaurant ``` pinterestUrl: minLength: 0 format: uri type: string description: |- URL for your Pinterest account, format should be https://www.pinterest.com/yourUsername Filtering Type: `text` ``` Eligible For: * contactCard * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * organization * restaurant ``` priceRange: enum: - UNSPECIFIED - ONE - TWO - THREE - FOUR type: string description: |- he typical price of products sold by this location, on a scale of 1 (low) to 4 (high) Filtering Type: `option` ``` Eligible For: * atm * healthcareFacility * healthcareProfessional * location * restaurant ``` primaryConversationContact: minLength: 0 type: string description: |- ID of the user who is the primary Knowledge Assistant contact for the entity Filtering Type: `option` ``` Eligible For: * atm * faq * financialProfessional * healthcareFacility * healthcareProfessional * helpArticle * hotel * job * location * organization * product * restaurant ``` privateBeach: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity has access to a private beach. Filtering Type: `option` ``` Eligible For: * hotel ``` privateCarService: enum: - PRIVATE_CAR_SERVICE - PRIVATE_CAR_SERVICE_FOR_FREE - NOT_APPLICABLE type: string description: |- Indicates whether the entity offers private car services. Filtering Type: `option` ``` Eligible For: * hotel ``` productLists: additionalProperties: false type: object properties: ids: description: |- IDs of the Products & Services Lists associated with this entity Array must be ordered. Array may have a maximum of 40 elements. Filtering Type: `list of text` uniqueItems: true type: array items: minLength: 0 type: string description: 'Filtering Type: `text`' label: minLength: 0 maxLength: 30 type: string description: |- Label to be used for this entity's Products & Services Lists. This label will appear on your entity's listings. Filtering Type: `text` description: |- Information about the Products & Services Content Lists associated with this entity Filtering Type: `object` ``` Eligible For: * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` products: description: |- Products sold by this entity All strings must be non-empty when trimmed of whitespace. Array must be ordered. Array may have a maximum of 100 elements. Array item description: >Cannot Include: >* HTML markup Filtering Type: `list of text` ``` Eligible For: * financialProfessional * location ``` uniqueItems: true type: array items: minLength: 0 maxLength: 100 type: string description: |- Cannot Include: * HTML markup Filtering Type: `text` questionsAndAnswers: type: boolean description: |- Indicates whether Yext Knowledge Assistant question-and-answer conversations are enabled for this entity Filtering Type: `boolean` ``` Eligible For: * atm * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * organization * restaurant ``` rankTrackingCompetitors: description: |- Information about the competitors whose search performance you would like to compare to your own Array must be ordered. Array may have a maximum of 5 elements. Filtering Type: `list of object` ``` Eligible For: * atm * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * organization * restaurant ``` uniqueItems: true type: array items: required: - name - website additionalProperties: false type: object properties: name: minLength: 0 maxLength: 100 type: string description: |- A name of a competitor Cannot Include: * HTML markup Filtering Type: `text` website: minLength: 0 maxLength: 255 format: uri type: string description: |- The business website of a competitor Cannot Include: * common domain names, e.g., google.com, youtube.com, etc. Filtering Type: `text` description: 'Filtering Type: `object`' rankTrackingEnabled: type: boolean description: |- Indicates whether Rank Tracking is enabled Filtering Type: `boolean` ``` Eligible For: * atm * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * organization * restaurant ``` rankTrackingFrequency: enum: - WEEKLY - MONTHLY - QUARTERLY type: string description: |- How often we send search queries to track your search performance Filtering Type: `option` ``` Eligible For: * atm * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * organization * restaurant ``` rankTrackingQueryTemplates: description: |- The ways in which your keywords will be arranged in the search queries we use to track your performance Array must have a minimum of 2 elements. Array may have a maximum of 4 elements. Filtering Type: `list of option` ``` Eligible For: * atm * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * organization * restaurant ``` uniqueItems: true type: array items: enum: - KEYWORD - KEYWORD_ZIP - KEYWORD_CITY - KEYWORD_IN_CITY - KEYWORD_NEAR_ME - KEYWORD_CITY_STATE type: string description: 'Filtering Type: `option`' rankTrackingSites: uniqueItems: true type: array items: enum: - GOOGLE_DESKTOP - GOOGLE_MOBILE - BING_DESKTOP - BING_MOBILE - YAHOO_DESKTOP - YAHOO_MOBILE type: string description: 'Filtering Type: `option`' description: |- The search engines that we will use to track your performance Filtering Type: `list of option` ``` Eligible For: * atm * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * organization * restaurant ``` reservationUrl: additionalProperties: false type: object properties: displayUrl: minLength: 0 maxLength: 2000 format: uri type: string description: |- The URL that is shown on your listings in place of **`reservationUrl.url`**. You can use **`reservationUrl.displayUrl`** to display a short, memorable web address that redirects consumers to the URL given in **`reservationUrl.url`**. Must be a valid URL and be specified along with **`reservationUrl.url`**. Filtering Type: `text` preferDisplayUrl: type: boolean description: |- If set to true, only the display URL will be sent to those publishers who do not support separate display and tracking URLs for this field. Filtering Type: `boolean` url: minLength: 0 maxLength: 2000 format: uri type: string description: |- A valid URL used to make reservations at this entity Filtering Type: `text` description: |- Information about the URL consumers can visit to make reservations at this entity Filtering Type: `object` ``` Eligible For: * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` restaurantCount: multipleOf: 1 minimum: 0 type: number description: |- The number of restaurants the entity has. Filtering Type: `integer` ``` Eligible For: * hotel ``` reviewGenerationUrl: minLength: 0 type: string description: |- The URL given Review Invitation emails where consumers can leave a review about the entity ``` Eligible For: * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` reviewResponseConversationEnabled: type: boolean description: |- Indicates whether Yext Knowledge Assistant review-response conversations are enabled for this entity Filtering Type: `boolean` ``` Eligible For: * atm * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` roomCount: multipleOf: 1 minimum: 0 type: number description: |- The number of rooms the entity has. Filtering Type: `integer` ``` Eligible For: * hotel ``` roomService: enum: - ROOM_SERVICE_AVAILABLE - ROOM_SERVICE_AVAILABLE_24_HOURS - NOT_APPLICABLE type: string description: |- Indicates whether the entity offers room service. Filtering Type: `option` ``` Eligible For: * hotel ``` routableCoordinate: additionalProperties: false type: object properties: latitude: minimum: -90 maximum: 90 type: number description: 'Filtering Type: `float`' longitude: minimum: -180 maximum: 180 type: number description: 'Filtering Type: `float`' description: |- Destination coordinates to use for driving directions to the entity, as provided by you Filtering Type: `object` ``` Eligible For: * atm * event * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` salon: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity has a salon. Filtering Type: `option` ``` Eligible For: * hotel ``` sauna: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity has a sauna. Filtering Type: `option` ``` Eligible For: * hotel ``` scuba: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity offers scuba diving. Filtering Type: `option` ``` Eligible For: * hotel ``` selfParking: enum: - SELF_PARKING_AVAILABLE - SELF_PARKING_AVAILABLE_FOR_FREE - NOT_APPLICABLE type: string description: |- Indicates whether the entity offers self parking services. Filtering Type: `option` ``` Eligible For: * hotel ``` seniorHours: additionalProperties: false type: object properties: friday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the senior hours are "closed" on Friday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for the Entity's senior hours on Friday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' holidayHours: description: |- **NOTE:** The list of Holiday Hours that you send us must be comprehensive. For example, if you send us a list of Holiday Hours that does not include Holiday Hours that you sent in your last update, Yext considers the missing Holiday Hours to be deleted, and we remove them. Array must be ordered. Filtering Type: `list of object` uniqueItems: true type: array items: required: - date additionalProperties: false type: object properties: date: format: date type: string description: |- Date on which the holiday hours will be in effect. Cannot be in the past. Date must be on or after 1970-01-01 Date must be before or on 2038-01-01 Filtering Type: `date` isClosed: type: boolean description: |- Indicates if the senior hours are "closed" on on the given date. Filtering Type: `boolean` isRegularHours: type: boolean description: |- Indicates whether the holiday hours are the same as the regular business hours for the given date. If set to true, we will update the holiday hours if the regular business hours change for the date's day of the week. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for the Entity's senior hours on the specified date. Filtering Type: `list of object` description: 'Filtering Type: `object`' monday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the senior hours are "closed" on Monday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for the Entity's senior hours on Monday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' reopenDate: format: date type: string description: |- Date must be on or after 1970-01-01 Date must be before or on 2038-01-01 Filtering Type: `date` saturday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the senior hours are "closed" on Saturday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for the Entity's senior hours on Saturday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' sunday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the senior hours are "closed" on Sunday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for the Entity's senior hours on Sunday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' thursday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the senior hours are "closed" on Thursday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for the Entity's senior hours on Thursday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' tuesday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the senior hours are "closed" on Tuesday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for the Entity's senior hours on Tuesday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' wednesday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the senior hours are "closed" on Wednesday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for the Entity's senior hours on Wednesday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' description: |- Contains the daily senior hours, holiday senior hours, and reopen date for the Entity. Each day is represented by a sub-field of `seniorHours`. (e.g. `monday`, `tuesday`, etc.) Open times can be specified per day through the `openIntervals` field and the `isClosed` flag. Similarly, holiday senior hours are represented by the `holidayHours` sub-field. Setting the `reopenDate` sub-field indicates that the business is temporarily closed and will reopen on the specified date. SPECIAL CASES: * To indicate that an Entity is open 24 hours on a specific day, set start to 00:00 and end to 23:59 in `openIntervals` for that day. * To indicate that an Entity has split hours on a specific day (e.g., open from 9:00 AM to 12:00 PM and again from 1:00 PM to 5:00 PM), supply two or more `openIntervals` values with non-overlapping sets of hours. * If you are providing `openIntervals`, you may not set `isClosed` to true for that day. Filtering Type: `hours` ``` Eligible For: * location * restaurant ``` serviceArea: additionalProperties: false type: object properties: places: description: |- A list of places served by the entity, where each place is either: - a postal code, or - the name of a city. Array must be ordered. Array may have a maximum of 200 elements. Filtering Type: `list of text` uniqueItems: true type: array items: minLength: 0 maxLength: 100 type: string description: 'Filtering Type: `text`' description: |- Information about the area that is served by this entity. It is specified as a list of cities and/or postal codes. **Only for Google Business Profile and Bing:** Currently, **serviceArea** is only supported by Google Business Profile and Bing and will not affect your listings on other sites. Filtering Type: `object` ``` Eligible For: * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` serviceAreaPlaces: description: |- Information about the area that is served by this entity. It is specified as a list of service area names, their associated types and google place ids. **Only for Google Business Profile and Bing:** Currently, **serviceArea** is only supported by Google Business Profile and Bing and will not affect your listings on other sites. Array may have a maximum of 200 elements. Filtering Type: `list of object` ``` Eligible For: * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` uniqueItems: true type: array items: additionalProperties: false type: object properties: name: minLength: 0 maxLength: 100 type: string description: 'Filtering Type: `text`' googlePlaceId: minLength: 0 type: string description: 'Filtering Type: `text`' type: enum: - POSTAL_CODE - REGION - COUNTY - CITY - SUBLOCALITY type: string description: 'Filtering Type: `option`' description: 'Filtering Type: `object`' services: description: |- Services offered by this entity All strings must be non-empty when trimmed of whitespace. Array must be ordered. Array may have a maximum of 100 elements. Array item description: >Cannot Include: >* HTML markup Filtering Type: `list of text` ``` Eligible For: * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` uniqueItems: true type: array items: minLength: 0 maxLength: 100 type: string description: |- Cannot Include: * HTML markup Filtering Type: `text` smokeFreeProperty: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates if the entity is smoke free. Filtering Type: `option` ``` Eligible For: * hotel ``` snorkeling: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity offers snorkeling. Filtering Type: `option` ``` Eligible For: * hotel ``` socialHour: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity offers a social hour. Filtering Type: `option` ``` Eligible For: * hotel ``` spa: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity has a spa. Filtering Type: `option` ``` Eligible For: * hotel ``` specialities: description: |- Up to 100 of this entity's specialities (e.g., for food and dining: `Chicago style`) All strings must be non-empty when trimmed of whitespace. Array must be ordered. Array may have a maximum of 100 elements. Array item description: >Cannot Include: >* HTML markup Filtering Type: `list of text` ``` Eligible For: * financialProfessional * location * restaurant ``` uniqueItems: true type: array items: minLength: 0 maxLength: 100 type: string description: |- Cannot Include: * HTML markup Filtering Type: `text` tableService: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity has a sit-down restaurant. Filtering Type: `option` ``` Eligible For: * hotel ``` takeoutHours: additionalProperties: false type: object properties: friday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the takeout hours are "closed" on Friday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is open for takeout on Friday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' holidayHours: description: |- **NOTE:** The list of Holiday Hours that you send us must be comprehensive. For example, if you send us a list of Holiday Hours that does not include Holiday Hours that you sent in your last update, Yext considers the missing Holiday Hours to be deleted, and we remove them. Array must be ordered. Filtering Type: `list of object` uniqueItems: true type: array items: required: - date additionalProperties: false type: object properties: date: format: date type: string description: |- Date on which the holiday hours will be in effect. Cannot be in the past. Date must be on or after 1970-01-01 Date must be before or on 2038-01-01 Filtering Type: `date` isClosed: type: boolean description: |- Indicates if the takeout hours are "closed" on on the given date. Filtering Type: `boolean` isRegularHours: type: boolean description: |- Indicates whether the holiday hours are the same as the regular business hours for the given date. If set to true, we will update the holiday hours if the regular business hours change for the date's day of the week. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is open for takeout on the specified date. Filtering Type: `list of object` description: 'Filtering Type: `object`' monday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the takeout hours are "closed" on Monday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is open for takeout on Monday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' reopenDate: format: date type: string description: |- Date must be on or after 1970-01-01 Date must be before or on 2038-01-01 Filtering Type: `date` saturday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the takeout hours are "closed" on Saturday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is open for takeout on Saturday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' sunday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the takeout hours are "closed" on Sunday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is open for takeout on Sunday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' thursday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the takeout hours are "closed" on Thursday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is open for takeout on Thursday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' tuesday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the takeout hours are "closed" on Tuesday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is open for takeout on Tuesday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' wednesday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the takeout hours are "closed" on Wednesday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is open for takeout on Wednesday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' description: |- Contains the daily takeout hours, holiday takeout hours, and reopen date for the Entity. Each day is represented by a sub-field of `takeoutHours`. (e.g. `monday`, `tuesday`, etc.) Open times can be specified per day through the `openIntervals` field and the `isClosed` flag. Similarly, holiday takeout hours are represented by the `holidayHours` sub-field. Setting the `reopenDate` sub-field indicates that the business is temporarily closed and will reopen on the specified date. SPECIAL CASES: * To indicate that an Entity is open 24 hours on a specific day, set start to 00:00 and end to 23:59 in `openIntervals` for that day. * To indicate that an Entity has split hours on a specific day (e.g., open from 9:00 AM to 12:00 PM and again from 1:00 PM to 5:00 PM), supply two or more `openIntervals` values with non-overlapping sets of hours. * If you are providing `openIntervals`, you may not set `isClosed` to true for that day. Filtering Type: `hours` ``` Eligible For: * location * restaurant ``` tennis: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity has tennis courts. Filtering Type: `option` ``` Eligible For: * hotel ``` thermalPool: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity has a thermal pool. Filtering Type: `option` ``` Eligible For: * hotel ``` ticketAvailability: enum: - IN_STOCK - SOLD_OUT - PRE_ORDER - UNSPECIFIED type: string description: |- Information about the availability of tickets for the event Filtering Type: `option` ``` Eligible For: * event ``` ticketPriceRange: additionalProperties: false type: object properties: currencyCode: minLength: 0 type: string description: |- Three letter currency code (ISO standard) Filtering Type: `text` maxValue: pattern: ^\d*\.?\d*$ type: string description: |- Maximum ticket price Filtering Type: `decimal` minValue: pattern: ^\d*\.?\d*$ type: string description: |- Minimum ticket price Filtering Type: `decimal` description: |- Contains the price range for the event Filtering Type: `object` ``` Eligible For: * event ``` ticketSaleDateTime: format: date-time type: string description: |- The date/time tickets are available for sale (local time) Filtering Type: `datetime` ``` Eligible For: * event ``` ticketUrl: minLength: 0 format: uri type: string description: |- URL to purchase tickets for the event (if ticketed) Filtering Type: `text` ``` Eligible For: * event ``` tikTokUrl: minLength: 0 format: uri type: string description: |- URL for your TikTok profile, format should be https://www.tiktok.com/yourUsername Filtering Type: `text` ``` Eligible For: * contactCard * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * organization * restaurant ``` time: additionalProperties: false type: object properties: end: format: date-time type: string description: |- End date/time of the event, in local time (see timezone field) Standard ISO 8601 datetime without timezone Format: `YYYY-MM-DDThh:mm` Filtering Type: `datetime` start: format: date-time type: string description: |- Start date/time of the event, in local time (see timezone field) Standard ISO 8601 datetime without timezone Format: `YYYY-MM-DDThh:mm` Filtering Type: `datetime` description: |- Contains the start/end times for the event Filtering Type: `object` ``` Eligible For: * event ``` timeZoneUtcOffset: minLength: 0 type: string description: |- Represents the time zone offset of the entity from UTC, in `±hh:mm` format. For example, if the entity is 4 hours ahead of UTC time, the offset will be `+04:00`. If the entity is 15.5 hours behind UTC time, the offset will be `-15:30`. If the entity is in UTC time, the offset will be `+00:00`. ``` Eligible For: * atm * event * faq * healthcareFacility * healthcareProfessional * hotel * job * location * restaurant ``` timezone: minLength: 0 type: string description: |- The timezone of the entity, in the standard `IANA time zone database` format (tz database). e.g. `"America/New_York"` Filtering Type: `option` ``` Eligible For: * atm * board * card * contactCard * event * faq * financialProfessional * healthcareFacility * healthcareProfessional * helpArticle * hotel * hotelRoomType * job * location * organization * product * restaurant ``` tollFreePhone: minLength: 0 type: string description: |- Must be a valid phone number. If the phone number's calling code is for a country other than the one given in the entity's **`countryCode`**, the phone number provided must contain the calling code (e.g., `+44` in `+442038083831`). Otherwise, the calling code is optional. Filtering Type: `text` ``` Eligible For: * atm * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` treadmill: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity has a treadmill. Filtering Type: `option` ``` Eligible For: * hotel ``` ttyPhone: minLength: 0 type: string description: |- Must be a valid phone number. If the phone number's calling code is for a country other than the one given in the entity's **`countryCode`**, the phone number provided must contain the calling code (e.g., `+44` in `+442038083831`). Otherwise, the calling code is optional. Filtering Type: `text` ``` Eligible For: * atm * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` turndownService: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity offers turndown service. Filtering Type: `option` ``` Eligible For: * hotel ``` twitterHandle: minLength: 0 maxLength: 15 type: string description: |- Valid Twitter handle for the entity without the leading "@" (e.g., `JohnSmith`) 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. Filtering Type: `text` ``` Eligible For: * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * organization * restaurant ``` uberLink: required: - presentation additionalProperties: false type: object properties: presentation: enum: - BUTTON - LINK type: string description: |- Indicates whether the embedded Uber link for this entity 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 entity set as the trip destination. If the Uber app is not installed, the consumer will be prompted to download it. Filtering Type: `option` text: minLength: 0 maxLength: 100 type: string description: |- The text of the embedded Uber link Default is `Ride there with Uber`. **NOTE:** This field is only available if **`uberLink.presentation`** is `LINK`. Filtering Type: `text` description: |- Information about the Yext-powered link that can be copied and pasted into the markup of Yext Pages where the embedded Uber link should appear Filtering Type: `object` ``` Eligible For: * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` uberTripBranding: required: - text - url - description additionalProperties: false type: object properties: description: minLength: 0 maxLength: 150 type: string description: |- A longer description that will appear near the call-to-action in the Uber app during a trip to your entity. **NOTE:** If a value for **`uberTripBranding.description`** is provided, values must also be provided for **`uberTripBranding.text`** and **`uberTripBranding.url`**. Filtering Type: `text` text: minLength: 0 maxLength: 28 type: string description: |- The text of the call-to-action that will appear in the Uber app during a trip to your entity (e.g., `Check out our menu!`) **NOTE:** If a value for **`uberTripBranding.text`** is provided, values must also be provided for **`uberTripBranding.url`** and **`uberTripBranding.description`**. Filtering Type: `text` url: minLength: 0 format: uri type: string description: |- 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 entity. **NOTE:** If a value for **`uberTripBranding.url`** is provided, values must also be provided for **`uberTripBranding.text`** and **`uberTripBranding.description`**. Filtering Type: `text` description: |- Information about the call-to-action consumers will see in the Uber app during a trip to your entity Filtering Type: `object` ``` Eligible For: * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` valetParking: enum: - VALET_PARKING_AVAILABLE - VALET_PARKING_AVAILABLE_FOR_FREE - NOT_APPLICABLE type: string description: |- Indicates whether the entity offers valet parking services. Filtering Type: `option` ``` Eligible For: * hotel ``` validThrough: format: date-time type: string description: |- The date this entity is valid through. Filtering Type: `datetime` ``` Eligible For: * job ``` vendingMachine: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity has a vending machine. Filtering Type: `option` ``` Eligible For: * hotel ``` venueName: minLength: 0 type: string description: |- Name of the venue where the event is being held Filtering Type: `text` ``` Eligible For: * event ``` videos: description: |- Valid YouTube URLs for embedding a video on some publisher sites **NOTE:** Currently, only the first URL in the Array appears in your listings. Array must be ordered. Filtering Type: `list of object` ``` Eligible For: * financialProfessional * healthcareFacility * healthcareProfessional * hotel * hotelRoomType * location * organization * product * restaurant ``` uniqueItems: true type: array items: required: - video additionalProperties: false type: object properties: description: minLength: 0 maxLength: 140 type: string description: |- Cannot Include: * HTML markup Filtering Type: `text` video: required: - url additionalProperties: false type: object properties: url: minLength: 0 format: uri type: string description: 'Filtering Type: `text`' description: 'Filtering Type: `object`' description: 'Filtering Type: `object`' wadingPool: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity has a wading pool. Filtering Type: `option` ``` Eligible For: * hotel ``` wakeUpCalls: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity offers wake up call services. Filtering Type: `option` ``` Eligible For: * hotel ``` walkableCoordinate: additionalProperties: false type: object properties: latitude: minimum: -90 maximum: 90 type: number description: 'Filtering Type: `float`' longitude: minimum: -180 maximum: 180 type: number description: 'Filtering Type: `float`' description: |- Destination coordinates to use for walking directions to the entity, as provided by you Filtering Type: `object` ``` Eligible For: * atm * event * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` waterPark: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity has a water park. Filtering Type: `option` ``` Eligible For: * hotel ``` waterSkiing: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity offers water skiing. Filtering Type: `option` ``` Eligible For: * hotel ``` watercraft: enum: - WATERCRAFT_RENTALS - WATERCRAFT_RENTALS_FOR_FREE - NOT_APPLICABLE type: string description: |- Indicates whether the entity offers any kind of watercrafts. Filtering Type: `option` ``` Eligible For: * hotel ``` waterslide: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity has a water slide. Filtering Type: `option` ``` Eligible For: * hotel ``` wavePool: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity has a wave pool. Filtering Type: `option` ``` Eligible For: * hotel ``` websiteUrl: additionalProperties: false type: object properties: displayUrl: minLength: 0 maxLength: 2000 format: uri type: string description: |- The URL that is shown on your listings in place of **`websiteUrl.url`**. You can use **`websiteUrl.displayUrl`** to display a short, memorable web address that redirects consumers to the URL given in **`websiteUrl.url`**. Must be a valid URL and be specified along with **`websiteUrl.url`**. Filtering Type: `text` preferDisplayUrl: type: boolean description: |- If set to true, only the display URL will be sent to those publishers who do not support separate display and tracking URLs for this field. Filtering Type: `boolean` url: minLength: 0 maxLength: 2000 format: uri type: string description: |- A valid URL for this entity's website Filtering Type: `text` description: |- Information about the website for this entity Filtering Type: `object` ``` Eligible For: * atm * contactCard * event * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * organization * restaurant ``` weightMachine: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity has a weight machine. Filtering Type: `option` ``` Eligible For: * hotel ``` wheelchairAccessible: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates if the entity is wheelchair accessible. Filtering Type: `option` ``` Eligible For: * hotel ``` wifiAvailable: enum: - WIFI_AVAILABLE - WIFI_AVAILABLE_FOR_FREE - NOT_APPLICABLE type: string description: |- Indicates whether the entity has WiFi available Filtering Type: `option` ``` Eligible For: * hotel ``` workRemote: type: boolean description: |- Indicates whether the job is remote. Filtering Type: `boolean` ``` Eligible For: * job ``` yearEstablished: multipleOf: 1 minimum: 1000 maximum: 2028 type: number description: |- The year the entity was established. Filtering Type: `integer` ``` Eligible For: * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` yearLastRenovated: multipleOf: 1 minimum: 1000 maximum: 2028 type: number description: |- The most recent year the entity was partially or completely renovated. Filtering Type: `integer` ``` Eligible For: * hotel ``` yextDisplayCoordinate: additionalProperties: false type: object properties: latitude: minimum: -90 maximum: 90 type: number description: 'Filtering Type: `float`' longitude: minimum: -180 maximum: 180 type: number description: 'Filtering Type: `float`' description: |- Coordinates where the map pin for the entity should be displayed, as calculated by Yext Filtering Type: `object` ``` Eligible For: * atm * event * financialProfessional * healthcareFacility * healthcareProfessional * hotel * job * location * restaurant ``` yextDropoffCoordinate: additionalProperties: false type: object properties: latitude: minimum: -90 maximum: 90 type: number description: 'Filtering Type: `float`' longitude: minimum: -180 maximum: 180 type: number description: 'Filtering Type: `float`' description: |- Coordinates of where consumers can be dropped off at the entity, as calculated by Yext Filtering Type: `object` ``` Eligible For: * atm * event * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` yextPickupCoordinate: additionalProperties: false type: object properties: latitude: minimum: -90 maximum: 90 type: number description: 'Filtering Type: `float`' longitude: minimum: -180 maximum: 180 type: number description: 'Filtering Type: `float`' description: |- Coordinates of where consumers can be picked up at the entity, as calculated by Yext Filtering Type: `object` ``` Eligible For: * atm * event * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` yextRoutableCoordinate: additionalProperties: false type: object properties: latitude: minimum: -90 maximum: 90 type: number description: 'Filtering Type: `float`' longitude: minimum: -180 maximum: 180 type: number description: 'Filtering Type: `float`' description: |- Destination coordinates to use for driving directions to the entity, as calculated by Yext Filtering Type: `object` ``` Eligible For: * atm * event * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` yextWalkableCoordinate: additionalProperties: false type: object properties: latitude: minimum: -90 maximum: 90 type: number description: 'Filtering Type: `float`' longitude: minimum: -180 maximum: 180 type: number description: 'Filtering Type: `float`' description: |- Destination coordinates to use for walking directions to the entity, as calculated by Yext Filtering Type: `object` ``` Eligible For: * atm * event * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` youTubeChannelUrl: minLength: 0 format: uri type: string description: |- URL for your YouTube channel, format should be https://www.youtube.com/c/yourUsername Filtering Type: `text` ``` Eligible For: * contactCard * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * organization * restaurant ``` geo: additionalProperties: false type: object properties: address: required: - line1 - region - postalCode - country - city additionalProperties: false type: object properties: city: minLength: 0 type: string description: Locality (city) field as returned by geocoder. If no value, returns "" country: minLength: 0 type: string description: Country field as returned by geocoder. If no value, returns "" line1: minLength: 0 type: string description: Address line 1 field as returned by geocoder. If no value, returns "" line2: minLength: 0 type: string description: Address line 2 field as returned by geocoder. If no value, returns "" postalCode: minLength: 0 type: string description: PostalCode (ZIP) field as returned by geocoder. If no value, returns "" region: minLength: 0 type: string description: Region (state) field as returned by geocoder. If no value, returns "" sublocality: minLength: 0 type: string description: Sublocality field as returned by geocoder. If no value, returns "" description: Address field as returned by geocoder. If no value, returns "" coordinate: required: - latitude - longitude - granularity additionalProperties: false type: object properties: granularity: enum: - POINT - ADDRESS - STREET - SUBLOCALITY - LOCALITY - POSTALCODE - REGION - COUNTRY - UNKNOWN type: string description: Country field as returned by geocoder. If no value, returns "" latitude: type: number description: Latitude as returned by geocoder. If no value, returns "" longitude: type: number description: Longitude as returned by geocoder. If no value, returns "" description: If location provided in geosearch cannot be geocoded, this field will be set to null. randomizationToken: minLength: 0 type: string description: | Returned only when a **`randomization`** or **`randomizationToken`** parameter is specified. This token should be included as the **`randomizationToken`** parameter, along with an **`offset`** parameter value for moving through subsequent randomized results. description: |- Filtering Type: `object` ``` Eligible For: * card * helpArticle ``` headers: {} '400': description: Error Response content: application/json: schema: additionalProperties: false type: object properties: meta: additionalProperties: false type: object properties: errors: uniqueItems: false type: array items: additionalProperties: false type: object properties: code: multipleOf: 1 type: number description: | Code that uniquely identifies the error or warning. message: minLength: 0 type: string description: Message explaining the problem. type: enum: - FATAL_ERROR - NON_FATAL_ERROR - WARNING type: string description: List of errors and warnings. uuid: minLength: 0 type: string description: 'Filtering Type: `object`' headers: {} /accounts/{accountId}/entityschema/{entityType}/{entityId}/{languageCode}: get: operationId: getEntitySchema parameters: - $ref: '#/components/parameters/accountId' - $ref: '#/components/parameters/entityId' - $ref: '#/components/parameters/languageCode' - $ref: '#/components/parameters/entityTypePath' - $ref: '#/components/parameters/v' tags: - Live API summary: 'Entities Schema: Get' description: Gets the schema.org-compliant schema for the primary profile of a single Entity. Schema will vary depending on entity type. responses: '200': $ref: '#/components/responses/EntitySchemaResponse' default: $ref: '#/components/responses/ErrorResponse' /accounts/{accountId}/entityprofiles/{entityId}/{languageCode}: get: operationId: getLanguageProfile parameters: - schema: minLength: 0 type: string name: accountId in: path required: true - schema: minLength: 0 type: string description: The external ID of the requested Entity name: entityId in: path required: true - schema: minLength: 0 type: string description: The language code corresponding to the language of the profiles that the user wishes to retrieve name: languageCode in: path required: true - schema: minLength: 0 type: string description: A date in `YYYYMMDD` format. name: v in: query required: true - schema: minLength: 0 type: string description: | Optional parameter to return fields of type **Markdown** as HTML. - `false`: **Markdown** fields will be returned as JSON - `true`: **Markdown** fields will be returned as HTML name: convertMarkdownToHTML in: query required: false - schema: minLength: 0 type: string description: | Optional parameter to return fields of type **Rich Text** as HTML. - `false`: **Rich Text** fields will be returned as JSON - `true`: **Rich Text** fields will be returned as HTML name: convertRichTextToHTML in: query required: false - schema: minLength: 0 type: string description: Comma-separated list of field names. When present, only the fields listed will be returned. You can use dot notation to specify substructures (e.g., `"address.line1"`). Custom fields are specified in the same way, albeit with their `c_*` name. name: fields in: query required: false - schema: minLength: 0 type: string default: markdown description: | Present if and only if at least one field is of type "**Legacy Rich Text**." Valid values: * `markdown` * `html` * `none` name: format in: query required: false tags: - Live API summary: 'Entity Language Profiles: Get' description: | Retrieve a Language Profile for an Entity **NOTE:** * Responses will contain resolved values for embedded fields * If the `fields` parameter is unspecified, responses will contain the full entity profile for the requested language responses: '200': description: Success Response content: application/json: schema: additionalProperties: false type: object properties: meta: additionalProperties: false type: object properties: uuid: minLength: 0 type: string description: Unique ID for this request / response. response: additionalProperties: false type: object properties: meta: additionalProperties: false type: object properties: accountId: minLength: 0 type: string description: ID of the account associated with this Entity countryCode: minLength: 0 type: string description: |- Country code of this Entity's Language Profile (defaults to the country of the account) Filtering Type: `text` createdTimestamp: minLength: 0 type: string description: The timestamp of when the entity record was created. entityType: minLength: 0 type: string description: |- This Entity's type (e.g., location, event) Filtering Type: `text` folderId: minLength: 0 type: string description: |- The ID of the folder containing this Entity Filtering Type: `text` id: minLength: 0 type: string description: |- ID of this Entity Filtering Type: `text` labels: uniqueItems: false type: array items: minLength: 0 type: string description: 'Filtering Type: `text`' description: |- This Entity's labels. If the **`v`** parameter is before `20211215`, this will be an integer. Filtering Type: `list of text` language: minLength: 0 type: string description: |- Language code of this Entity's Language Profile (defaults to the language code of the account) Filtering Type: `text` timestamp: minLength: 0 type: string description: | The timestamp of the most recent change to this entity record. Will be ignored when the client is saving entity data to Yext. **NOTE:** The timestamp may change even if observable fields stay the same. uid: minLength: 0 type: string description: | The internal ID of the entity. This UID is a static, globally unique ID. Note that this value cannot be used in place of id in API calls to retrieve or edit Entity information. If the v param is before `20221206`, the returned value will be a hashed version of the entity UID (aka internal ID of the entity). description: |- Contains the metadata about the entity. ``` Eligible For: * atm * event * faq * healthcareFacility * healthcareProfessional * hotel * job * location * restaurant ``` name: minLength: 0 maxLength: 5000 type: string description: |- Cannot Include: * HTML markup Filtering Type: `text` ``` Eligible For: * atm * board * brand * card * contactCard * event * faq * financialProfessional * healthcareFacility * healthcareProfessional * helpArticle * hotel * hotelRoomType * job * location * organization * product * restaurant ``` address: additionalProperties: false type: object properties: city: minLength: 0 maxLength: 255 type: string description: |- The city the entity (or the entity's location) is in Cannot Include: * a URL or domain name Filtering Type: `text` countryCode: minLength: 0 pattern: ^[a-zA-Z]{2}$ type: string description: 'Filtering Type: `text`' extraDescription: minLength: 0 maxLength: 255 type: string description: |- Provides additional information to help consumers get to the entity. This string appears along with the entity's address (e.g., `In Menlo Mall, 3rd Floor`). It may also be used in conjunction with a hidden address (i.e., when **`addressHidden`** is `true`) to give consumers information about where the entity can be found (e.g., `Servicing the New York area`). Filtering Type: `text` line1: minLength: 0 maxLength: 255 type: string description: |- Cannot Include: * a URL or domain name Filtering Type: `text` line2: minLength: 0 maxLength: 255 type: string description: |- Cannot Include: * a URL or domain name Filtering Type: `text` postalCode: minLength: 0 maxLength: 10 type: string description: |- The entity's postal code. The postal code must be valid for the entity's country. Cannot include a URL or domain name. Cannot Include: * a URL or domain name Filtering Type: `text` region: minLength: 0 maxLength: 255 type: string description: |- The name of the entity's region or state. Cannot Include: * a URL or domain name Filtering Type: `text` sublocality: minLength: 0 maxLength: 255 type: string description: |- The name of the entity's sublocality Cannot Include: * a URL or domain name Filtering Type: `text` description: |- Contains the address of the entity (or where the entity is located) Must be a valid address Cannot be a P.O. Box If the entity is an `event`, either an **`address`** value or a **`linkedLocation`** value can be provided. Filtering Type: `object` ``` Eligible For: * atm * event * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` acceptingNewPatients: type: boolean description: |- Indicates whether the healthcare provider is accepting new patients. Filtering Type: `boolean` ``` Eligible For: * healthcareFacility * healthcareProfessional ``` acceptsReservations: type: boolean description: |- Indicates whether the entity accepts reservations. Filtering Type: `boolean` ``` Eligible For: * restaurant ``` accessHours: additionalProperties: false type: object properties: friday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the access hours are "closed" on Friday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is open on Friday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' holidayHours: description: |- **NOTE:** The list of Holiday Hours that you send us must be comprehensive. For example, if you send us a list of Holiday Hours that does not include Holiday Hours that you sent in your last update, Yext considers the missing Holiday Hours to be deleted, and we remove them. Array must be ordered. Filtering Type: `list of object` uniqueItems: true type: array items: required: - date additionalProperties: false type: object properties: date: format: date type: string description: |- Date on which the holiday hours will be in effect. Cannot be in the past. Date must be on or after 1970-01-01 Date must be before or on 2038-01-01 Filtering Type: `date` isClosed: type: boolean description: |- Indicates if the access hours are "closed" on on the given date. Filtering Type: `boolean` isRegularHours: type: boolean description: |- Indicates whether the holiday hours are the same as the regular business hours for the given date. If set to true, we will update the holiday hours if the regular business hours change for the date's day of the week. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is open on the specified date. Filtering Type: `list of object` description: 'Filtering Type: `object`' monday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the access hours are "closed" on Monday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is open on Monday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' reopenDate: format: date type: string description: |- Date must be on or after 1970-01-01 Date must be before or on 2038-01-01 Filtering Type: `date` saturday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the access hours are "closed" on Saturday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is open on Saturday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' sunday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the access hours are "closed" on Sunday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is open on Sunday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' thursday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the access hours are "closed" on Thursday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is open on Thursday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' tuesday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the access hours are "closed" on Tuesday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is open on Tuesday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' wednesday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the access hours are "closed" on Wednesday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is open on Wednesday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' description: |- Contains the daily access hours, holiday access hours, and reopen date for the Entity. Each day is represented by a sub-field of `accessHours`. (e.g. `monday`, `tuesday`, etc.) Open times can be specified per day through the `openIntervals` field and the `isClosed` flag. Similarly, holiday access hours are represented by the `holidayHours` sub-field. Setting the `reopenDate` sub-field indicates that the business is temporarily closed and will reopen on the specified date. SPECIAL CASES: * To indicate that an Entity is open 24 hours on a specific day, set start to 00:00 and end to 23:59 in `openIntervals` for that day. * To indicate that an Entity has split hours on a specific day (e.g., open from 9:00 AM to 12:00 PM and again from 1:00 PM to 5:00 PM), supply two or more `openIntervals` values with non-overlapping sets of hours. * If you are providing `openIntervals`, you may not set `isClosed` to true for that day. Filtering Type: `hours` ``` Eligible For: * atm * healthcareFacility * hotel * location * restaurant ``` additionalHoursText: minLength: 0 maxLength: 255 type: string description: |- Additional information about hours that does not fit in **`hours`** (e.g., `"Closed during the winter"`) Filtering Type: `text` ``` Eligible For: * atm * contactCard * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` additionalPromotingLocations: description: |- If other locations are promoting this event, a list of those locations' **`id`**s in the Yext Knowledge Manager Array must be ordered. Filtering Type: `list of entityId` ``` Eligible For: * event ``` uniqueItems: true type: array items: type: string description: 'Filtering Type: `entityId`' addressHidden: type: boolean description: |- If `true`, the entity's street address will not be shown on listings. Defaults to `false`. Filtering Type: `boolean` ``` Eligible For: * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` admittingHospitals: description: |- A list of hospitals where the healthcare professional admits patients Array must be ordered. Array may have a maximum of 100 elements. Array item description: >Cannot Include: >* HTML markup Filtering Type: `list of text` ``` Eligible For: * healthcareProfessional ``` uniqueItems: true type: array items: minLength: 0 maxLength: 100 type: string description: |- Cannot Include: * HTML markup Filtering Type: `text` adultPool: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity has a pool for adults only. Filtering Type: `option` ``` Eligible For: * hotel ``` ageRange: additionalProperties: false type: object properties: maxValue: multipleOf: 1 type: number description: |- Maximum age for the event Filtering Type: `integer` minValue: multipleOf: 1 type: number description: |- Minimum age for the event Filtering Type: `integer` description: |- Contains the age range for the event Filtering Type: `object` ``` Eligible For: * event ``` airportShuttle: enum: - AIRPORT_SHUTTLE_AVAILABLE - AIRPORT_SHUTTLE_AVAILABLE_FOR_FREE - NOT_APPLICABLE type: string description: |- Indicates whether the entity offers a shuttle to/from the airport. Filtering Type: `option` ``` Eligible For: * hotel ``` airportTransfer: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity offers a shuttle service of car service to/from nearby airports or train stations. Filtering Type: `option` ``` Eligible For: * hotel ``` allInclusive: enum: - ALL_INCLUSIVE_RATES_AVAILABLE - ALL_INCLUSIVE_RATES_ONLY - NOT_APPLICABLE type: string description: |- Indicates whether the entity offers all-inclusive rates. Filtering Type: `option` ``` Eligible For: * hotel ``` alternateNames: description: |- Other names for your business that you would like us to use when tracking your search performance Array must be ordered. Array may have a maximum of 3 elements. Array item description: >Cannot Include: >* HTML markup Filtering Type: `list of text` ``` Eligible For: * atm * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * organization * restaurant ``` uniqueItems: true type: array items: minLength: 0 maxLength: 100 type: string description: |- Cannot Include: * HTML markup Filtering Type: `text` alternatePhone: minLength: 0 type: string description: |- Must be a valid phone number. If the phone number's calling code is for a country other than the one given in the entity's **`countryCode`**, the phone number provided must contain the calling code (e.g., `+44` in `+442038083831`). Otherwise, the calling code is optional. Filtering Type: `text` ``` Eligible For: * atm * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` alternateWebsites: description: |- Other websites for your business that we should search for when tracking your search performance Array must be ordered. Array may have a maximum of 3 elements. Array item description: >Cannot Include: >* common domain names, e.g., google.com, youtube.com, etc. Filtering Type: `list of text` ``` Eligible For: * atm * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * organization * restaurant ``` uniqueItems: true type: array items: minLength: 0 maxLength: 255 format: uri type: string description: |- Cannot Include: * common domain names, e.g., google.com, youtube.com, etc. Filtering Type: `text` androidAppUrl: minLength: 0 type: string description: |- The URL where consumers can download the entity's Android app Filtering Type: `text` ``` Eligible For: * brand * financialProfessional * hotel * location * restaurant ``` answer: description: |- The answer to the frequently asked question represented by this entity Character limit: 0 .. 15000 Supported formats include: * BOLD * ITALICS * UNDERLINE * BULLETED_LIST * NUMBERED_LIST * HYPERLINK * IMAGE * CODE_SPAN * HEADINGS ``` Eligible For: * faq ``` type: string format: rich-text appleActionLinks: description: |- Use this field to add action links to your Apple Listings. The call to action category will be displayed on the action link button. The App Store URL should contain a valid link to the landing page of an App in the Apple App Store. The Quick Link URL is where a user is taken when an action link is clicked by a user. The App Name sub-field is not displayed on Apple Listings and is only used to distinguish the call-to-action type when utilizing action links in Apple posts. Array must be ordered. Filtering Type: `list of object` ``` Eligible For: * atm * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` uniqueItems: true type: array items: required: - category - quickLinkUrl - appName additionalProperties: false type: object properties: appName: minLength: 0 maxLength: 18 type: string description: 'Filtering Type: `text`' appStoreUrl: minLength: 0 maxLength: 2000 format: uri type: string description: 'Filtering Type: `text`' category: enum: - BOOK_TRAVEL - CHECK_IN - FEES_POLICIES - FLIGHT_STATUS - TICKETS - TICKETING - AMENITIES - FRONT_DESK - PARKING - GIFT_CARD - WAITLIST - DELIVERY - ORDER - TAKEOUT - PICKUP - RESERVE - MENU - APPOINTMENT - PORTFOLIO - QUOTE - SERVICES - STORE_ORDERS - STORE_SHOP - STORE_SUPPORT - SCHEDULE - SHOWTIMES - AVAILABILITY - PRICING - ACTIVITIES - BOOK - BOOK_(HOTEL) - BOOK_(RIDE) - BOOK_(TOUR) - CAREERS - CHARGE - COUPONS - DELIVERY_(RETAIL) - DONATE - EVENTS - ORDER_(RETAIL) - OTHER_MENU - PICKUP_(RETAIL) - RESERVE_(PARKING) - SHOWS - SPORTS - SUPPORT - TEE_TIME - GIFT_CARD_(RESTAURANT) type: string description: 'Filtering Type: `option`' quickLinkUrl: minLength: 0 maxLength: 2000 format: uri type: string description: 'Filtering Type: `text`' description: 'Filtering Type: `object`' appleBusinessDescription: minLength: 0 maxLength: 500 type: string description: |- The business description to be sent to Apple Filtering Type: `text` ``` Eligible For: * atm * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` appleBusinessId: minLength: 0 pattern: ^\d*\.?\d*$ type: string description: |- The ID associated with an individual Business Folder in your Apple account Filtering Type: `text` ``` Eligible For: * atm * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` appleCompanyId: minLength: 0 pattern: ^\d*\.?\d*$ type: string description: |- The ID associated with your Apple account. Numerical values only Filtering Type: `text` ``` Eligible For: * atm * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` appleCoverPhoto: required: - url additionalProperties: false type: object description: |- The cover photo for the entity''s Apple profile Image must be at least 1600 x 1040 pixels Image may be no more than 4864 x 3163 pixels Supported Aspect Ratios: * 154 x 100 **NOTE**: Maximum image size is 5mb after normalization and padding (if applicable). As well, there is a 6 second download limit from the image host. Filtering Type: `object` ``` Eligible For: * atm * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` properties: alternateText: minLength: 0 type: string description: 'Filtering Type: `text`' url: minLength: 0 format: uri type: string description: 'Filtering Type: `text`' appleDisplayName: minLength: 0 maxLength: 5000 type: string description: |- The name to be displayed on Apple for the entity. NOTE: The names of Brands and their respective Locations within an Apple Business Connect Account must match identically. Cannot Include: HTML markup Cannot Include: * HTML markup Filtering Type: `text` ``` Eligible For: * atm * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` applicationUrl: minLength: 0 format: uri type: string description: |- The application URL Filtering Type: `text` ``` Eligible For: * job ``` associations: description: |- Association memberships relevant to the entity (e.g., `"New York Doctors Association"`) All strings must be non-empty when trimmed of whitespace. Array must be ordered. Array may have a maximum of 100 elements. Array item description: >Cannot Include: >* HTML markup Filtering Type: `list of text` ``` Eligible For: * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` uniqueItems: true type: array items: minLength: 0 maxLength: 100 type: string description: |- Cannot Include: * HTML markup Filtering Type: `text` attendance: required: - attendanceMode additionalProperties: false type: object properties: attendanceMode: enum: - OFFLINE - ONLINE - MIXED type: string description: 'Filtering Type: `option`' virtualLocationUrl: minLength: 0 format: uri type: string description: 'Filtering Type: `text`' description: |- Indicates whether the event is online, offline, or a mix. A `virtualLocationUrl` must be specified for online and mixed events. Filtering Type: `object` ``` Eligible For: * event ``` attire: enum: - UNSPECIFIED - DRESSY - CASUAL - FORMAL type: string description: |- The formality of clothing typically worn at this restaurant Filtering Type: `option` ``` Eligible For: * restaurant ``` babysittingOffered: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity offers babysitting. Filtering Type: `option` ``` Eligible For: * hotel ``` baggageStorage: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity offers baggage storage pre check-in and post check-out. Filtering Type: `option` ``` Eligible For: * hotel ``` bar: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity has an indoor or outdoor bar onsite. Filtering Type: `option` ``` Eligible For: * hotel ``` beachAccess: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity has access to a beach. Filtering Type: `option` ``` Eligible For: * hotel ``` beachFrontProperty: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity is physically located next to a beach. Filtering Type: `option` ``` Eligible For: * hotel ``` bicycles: enum: - BICYCLE_RENTALS - BICYCLE_RENTALS_FOR_FREE - NOT_APPLICABLE type: string description: |- Indicates whether the entity offers bicycles for rent or for free. Filtering Type: `option` ``` Eligible For: * hotel ``` bios: additionalProperties: false type: object properties: ids: description: |- IDs of the Bio Lists associated with this entity Array must be ordered. Array may have a maximum of 40 elements. Filtering Type: `list of text` uniqueItems: true type: array items: minLength: 0 type: string description: 'Filtering Type: `text`' label: minLength: 0 maxLength: 30 type: string description: |- Label to be used for this entity's Bio Lists. This label will appear on your entity's listings. Filtering Type: `text` description: |- Information about the Bio Content Lists associated with this entity Filtering Type: `object` ``` Eligible For: * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * organization * restaurant ``` boutiqueStores: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity has a boutique store. Gift shop or convenience store are not eligible. Filtering Type: `option` ``` Eligible For: * hotel ``` brands: description: |- Brands sold by this entity All strings must be non-empty when trimmed of whitespace. Array must be ordered. Array may have a maximum of 100 elements. Array item description: >Cannot Include: >* HTML markup Filtering Type: `list of text` ``` Eligible For: * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` uniqueItems: true type: array items: minLength: 0 maxLength: 100 type: string description: |- Cannot Include: * HTML markup Filtering Type: `text` breakfast: enum: - BREAKFAST_AVAILABLE - BREAKFAST_AVAILABLE_FOR_FREE - NOT_APPLICABLE type: string description: |- Indicates whether the entity offers breakfast. Filtering Type: `option` ``` Eligible For: * hotel ``` brunchHours: additionalProperties: false type: object properties: friday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the brunch hours are "closed" on Friday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is open for brunch on Friday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' holidayHours: description: |- **NOTE:** The list of Holiday Hours that you send us must be comprehensive. For example, if you send us a list of Holiday Hours that does not include Holiday Hours that you sent in your last update, Yext considers the missing Holiday Hours to be deleted, and we remove them. Array must be ordered. Filtering Type: `list of object` uniqueItems: true type: array items: required: - date additionalProperties: false type: object properties: date: format: date type: string description: |- Date on which the holiday hours will be in effect. Cannot be in the past. Date must be on or after 1970-01-01 Date must be before or on 2038-01-01 Filtering Type: `date` isClosed: type: boolean description: |- Indicates if the brunch hours are "closed" on on the given date. Filtering Type: `boolean` isRegularHours: type: boolean description: |- Indicates whether the holiday hours are the same as the regular business hours for the given date. If set to true, we will update the holiday hours if the regular business hours change for the date's day of the week. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is open on the specified date. Filtering Type: `list of object` description: 'Filtering Type: `object`' monday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the brunch hours are "closed" on Monday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is open for brunch on Monday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' reopenDate: format: date type: string description: |- Date must be on or after 1970-01-01 Date must be before or on 2038-01-01 Filtering Type: `date` saturday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the brunch hours are "closed" on Saturday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is open for brunch on Saturday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' sunday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the brunch hours are "closed" on Sunday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is open for brunch on Sunday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' thursday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the brunch hours are "closed" on Thursday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is open for brunch on Thursday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' tuesday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the brunch hours are "closed" on Tuesday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is open for brunch on Tuesday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' wednesday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the brunch hours are "closed" on Wednesday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is open for brunch on Wednesday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' description: |- Contains the daily brunch hours, holiday brunch hours, and reopen date for the Entity. Each day is represented by a sub-field of `brunchHours`. (e.g. `monday`, `tuesday`, etc.) Open times can be specified per day through the `openIntervals` field and the `isClosed` flag. Similarly, holiday brunch hours are represented by the `holidayHours` sub-field. Setting the `reopenDate` sub-field indicates that the business is temporarily closed and will reopen on the specified date. SPECIAL CASES: * To indicate that an Entity is open 24 hours on a specific day, set start to 00:00 and end to 23:59 in `openIntervals` for that day. * To indicate that an Entity has split hours on a specific day (e.g., open from 9:00 AM to 12:00 PM and again from 1:00 PM to 5:00 PM), supply two or more `openIntervals` values with non-overlapping sets of hours. * If you are providing `openIntervals`, you may not set `isClosed` to true for that day. Filtering Type: `hours` ``` Eligible For: * hotel * location * restaurant ``` businessCenter: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity has a business center. Filtering Type: `option` ``` Eligible For: * hotel ``` calendars: additionalProperties: false type: object properties: ids: description: |- IDs of the Calendars associated with this entity Array must be ordered. Array may have a maximum of 40 elements. Filtering Type: `list of text` uniqueItems: true type: array items: minLength: 0 type: string description: 'Filtering Type: `text`' label: minLength: 0 maxLength: 30 type: string description: |- Label to be used for this entity's Calendars. This label will appear on your entity's listings. Filtering Type: `text` description: |- Information about the events Content Lists (Calendars) associated with this entity Filtering Type: `object` ``` Eligible For: * financialProfessional * healthcareFacility * hotel * location * restaurant ``` carRental: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity offers car rental. Filtering Type: `option` ``` Eligible For: * hotel ``` casino: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity has a casino on premise or nearby. Filtering Type: `option` ``` Eligible For: * hotel ``` categories: additionalProperties: false type: object properties: {} description: |- Yext Categories. (Supported for versions > 20240220) A map of category list external IDs (i.e. "yext") to a list of category IDs. IDs must be valid and selectable (i.e., cannot be parent categories). Partial updates are accepted, meaning sending only the "yext" property will have no effect on any category list except the "yext" category. Filtering Type: `object` ``` Eligible For: * atm * event * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` categoryIds: uniqueItems: false type: array items: minLength: 0 type: string description: 'Filtering Type: `text`' description: |- Yext Category IDs. (Deprecated: For versions > 20240220) 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. Filtering Type: `list of text` ``` Eligible For: * atm * event * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` catsAllowed: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates if the entity is cat friendly. Filtering Type: `option` ``` Eligible For: * hotel ``` certifications: description: |- A list of the certifications held by the healthcare professional **NOTE:** This field is only available to locations whose **`entityType`** is `healthcareProfessional`. Array must be ordered. Array may have a maximum of 100 elements. Array item description: >Cannot Include: >* HTML markup Filtering Type: `list of text` ``` Eligible For: * financialProfessional * healthcareProfessional ``` uniqueItems: true type: array items: minLength: 0 maxLength: 200 type: string description: |- Cannot Include: * HTML markup Filtering Type: `text` checkInTime: format: time type: string description: |- The check-in time Filtering Type: `time` ``` Eligible For: * hotel ``` checkOutTime: format: time type: string description: |- The check-out time Filtering Type: `time` ``` Eligible For: * hotel ``` classificationRating: pattern: ^\d*\.?\d*$ type: string description: |- The 1 to 5 star rating of the entitiy based on its services and facilities. Filtering Type: `decimal` ``` Eligible For: * hotel ``` closed: type: boolean description: |- Indicates whether the entity is closed Filtering Type: `boolean` ``` Eligible For: * atm * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` concierge: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity offers concierge service. Filtering Type: `option` ``` Eligible For: * hotel ``` conditionsTreated: description: |- A list of the conditions treated by the healthcare provider Array must be ordered. Array may have a maximum of 100 elements. Array item description: >Cannot Include: >* HTML markup Filtering Type: `list of text` ``` Eligible For: * healthcareFacility * healthcareProfessional ``` uniqueItems: true type: array items: minLength: 0 maxLength: 100 type: string description: |- Cannot Include: * HTML markup Filtering Type: `text` convenienceStore: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity has a convenience store. Filtering Type: `option` ``` Eligible For: * hotel ``` covidMessaging: minLength: 0 maxLength: 15000 type: string description: |- Information or messaging related to COVID-19. Filtering Type: `text` ``` Eligible For: * healthcareFacility * healthcareProfessional * location ``` covidTestAppointmentUrl: minLength: 0 format: uri type: string description: |- An appointment URL for scheduling a COVID-19 test. Filtering Type: `text` ``` Eligible For: * healthcareFacility * location ``` covidTestingAppointmentRequired: type: boolean description: |- Indicates whether an appointment is required for a COVID-19 test. Filtering Type: `boolean` ``` Eligible For: * healthcareFacility * location ``` covidTestingDriveThroughSite: type: boolean description: |- Indicates whether location is a drive-through site for COVID-19 tests. Filtering Type: `boolean` ``` Eligible For: * healthcareFacility * location ``` covidTestingIsFree: type: boolean description: |- Indicates whether location offers free COVID-19 testing. Filtering Type: `boolean` ``` Eligible For: * healthcareFacility * location ``` covidTestingPatientRestrictions: type: boolean description: |- Indicates whether there are patient restrictions for COVID-19 testing. Filtering Type: `boolean` ``` Eligible For: * healthcareFacility * location ``` covidTestingReferralRequired: type: boolean description: |- Indicates whether a referral is required for COVID-19 testing. Filtering Type: `boolean` ``` Eligible For: * healthcareFacility * location ``` covidTestingSiteInstructions: minLength: 0 maxLength: 15000 type: string description: |- Information or instructions for the COVID-19 testing site. Filtering Type: `text` ``` Eligible For: * healthcareFacility * location ``` covidVaccineAppointmentRequired: type: boolean description: |- Indicates whether an appointment is required for a COVID-19 vaccine. Filtering Type: `boolean` ``` Eligible For: * healthcareFacility * location ``` covidVaccineDriveThroughSite: type: boolean description: |- Indicates whether location is a drive-through site for COVID-19 vaccines. Filtering Type: `boolean` ``` Eligible For: * healthcareFacility * location ``` covidVaccineInformationUrl: minLength: 0 format: uri type: string description: |- An information URL for more information about COVID-19 vaccines. Filtering Type: `text` ``` Eligible For: * healthcareFacility * location ``` covidVaccinePatientRestrictions: type: boolean description: |- Indicates whether there are patient restrictions for a COVID-19 vaccine. Filtering Type: `boolean` ``` Eligible For: * healthcareFacility * location ``` covidVaccineReferralRequired: type: boolean description: |- Indicates whether a referral is required for a COVID-19 vaccine. Filtering Type: `boolean` ``` Eligible For: * healthcareFacility * location ``` covidVaccineSiteInstructions: minLength: 0 maxLength: 15000 type: string description: |- Information or instructions for the COVID-19 vaccination site. Filtering Type: `text` ``` Eligible For: * healthcareFacility * location ``` covidVaccinesOffered: uniqueItems: true type: array items: enum: - PFIZER - MODERNA - JOHNSON_&_JOHNSON type: string description: 'Filtering Type: `option`' description: |- Indicates which COVID-19 vaccines the location offers. Filtering Type: `list of option` ``` Eligible For: * healthcareFacility * location ``` currencyExchange: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity offers currency exchange services. Filtering Type: `option` ``` Eligible For: * hotel ``` customKeywords: description: |- Additional keywords you would like us to use when tracking your search performance Array must be ordered. Array may have a maximum of 5 elements. Filtering Type: `list of text` ``` Eligible For: * atm * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * organization * restaurant ``` uniqueItems: true type: array items: minLength: 0 maxLength: 100 type: string description: 'Filtering Type: `text`' datePosted: format: date type: string description: |- The date this entity was posted Filtering Type: `date` ``` Eligible For: * job ``` degrees: description: |- A list of the degrees earned by the healthcare professional Array must be ordered. Filtering Type: `list of option` ``` Eligible For: * healthcareProfessional ``` uniqueItems: true type: array items: enum: - ANP - APN - APRN - ARNP - AUD - BSW - CCCA - CNM - CNP - CNS - CPNP - CRNA - CRNP - DC - DDS - DMD - DNP - DO - DPM - DPT - DSW - DVM - FNP - GNP - LAC - LCSW - LPN - MBA - MBBS - MD - MPAS - MPH - MSW - ND - NNP - NP - OD - PA - PAC - PHARMD - PHD - PNP - PSYD - RD - RSW - VMD - WHNP type: string description: 'Filtering Type: `option`' deliveryHours: additionalProperties: false type: object properties: friday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the delivery hours are "closed" on Friday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is delivering on Friday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' holidayHours: description: |- **NOTE:** The list of Holiday Hours that you send us must be comprehensive. For example, if you send us a list of Holiday Hours that does not include Holiday Hours that you sent in your last update, Yext considers the missing Holiday Hours to be deleted, and we remove them. Array must be ordered. Filtering Type: `list of object` uniqueItems: true type: array items: required: - date additionalProperties: false type: object properties: date: format: date type: string description: |- Date on which the holiday hours will be in effect. Cannot be in the past. Date must be on or after 1970-01-01 Date must be before or on 2038-01-01 Filtering Type: `date` isClosed: type: boolean description: |- Indicates if the delivery hours are "closed" on on the given date. Filtering Type: `boolean` isRegularHours: type: boolean description: |- Indicates whether the holiday hours are the same as the regular business hours for the given date. If set to true, we will update the holiday hours if the regular business hours change for the date's day of the week. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is delivering on the specified date. Filtering Type: `list of object` description: 'Filtering Type: `object`' monday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the delivery hours are "closed" on Monday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is delivering on Monday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' reopenDate: format: date type: string description: |- Date must be on or after 1970-01-01 Date must be before or on 2038-01-01 Filtering Type: `date` saturday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the delivery hours are "closed" on Saturday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is delivering on Saturday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' sunday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the delivery hours are "closed" on Sunday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is delivering on Sunday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' thursday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the delivery hours are "closed" on Thursday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is delivering on Thursday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' tuesday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the delivery hours are "closed" on Tuesday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is delivering on Tuesday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' wednesday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the delivery hours are "closed" on Wednesday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is delivering on Wednesday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' description: |- Contains the daily delivery hours, holiday delivery hours, and reopen date for the Entity. Each day is represented by a sub-field of `deliveryHours`. (e.g. `monday`, `tuesday`, etc.) Open times can be specified per day through the `openIntervals` field and the `isClosed` flag. Similarly, holiday delivery hours are represented by the `holidayHours` sub-field. Setting the `reopenDate` sub-field indicates that the business is temporarily closed and will reopen on the specified date. SPECIAL CASES: * To indicate that an Entity is open 24 hours on a specific day, set start to 00:00 and end to 23:59 in `openIntervals` for that day. * To indicate that an Entity has split hours on a specific day (e.g., open from 9:00 AM to 12:00 PM and again from 1:00 PM to 5:00 PM), supply two or more `openIntervals` values with non-overlapping sets of hours. * If you are providing `openIntervals`, you may not set `isClosed` to true for that day. Filtering Type: `hours` ``` Eligible For: * location * restaurant ``` description: minLength: 10 maxLength: 15000 type: string description: |- A description of the entity Cannot Include: * HTML markup Filtering Type: `text` ``` Eligible For: * atm * contactCard * event * financialProfessional * healthcareFacility * healthcareProfessional * hotel * job * location * organization * restaurant ``` displayCoordinate: additionalProperties: false type: object properties: latitude: minimum: -90 maximum: 90 type: number description: 'Filtering Type: `float`' longitude: minimum: -180 maximum: 180 type: number description: 'Filtering Type: `float`' description: |- Coordinates where the map pin for the entity should be displayed, as provided by you Filtering Type: `object` ``` Eligible For: * atm * event * financialProfessional * healthcareFacility * healthcareProfessional * hotel * job * location * restaurant ``` doctorOnCall: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity has a doctor on premise or on call. Filtering Type: `option` ``` Eligible For: * hotel ``` dogsAllowed: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates if the entity is dog friendly. Filtering Type: `option` ``` Eligible For: * hotel ``` driveThroughHours: additionalProperties: false type: object properties: friday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the drive-through hours are "closed" on Friday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity's drive-through is open on Friday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' holidayHours: description: |- **NOTE:** The list of Holiday Hours that you send us must be comprehensive. For example, if you send us a list of Holiday Hours that does not include Holiday Hours that you sent in your last update, Yext considers the missing Holiday Hours to be deleted, and we remove them. Array must be ordered. Filtering Type: `list of object` uniqueItems: true type: array items: required: - date additionalProperties: false type: object properties: date: format: date type: string description: |- Date on which the holiday hours will be in effect. Cannot be in the past. Date must be on or after 1970-01-01 Date must be before or on 2038-01-01 Filtering Type: `date` isClosed: type: boolean description: |- Indicates if the drive-through hours are "closed" on on the given date. Filtering Type: `boolean` isRegularHours: type: boolean description: |- Indicates whether the holiday hours are the same as the regular business hours for the given date. If set to true, we will update the holiday hours if the regular business hours change for the date's day of the week. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity's drive-through is open on the specified date. Filtering Type: `list of object` description: 'Filtering Type: `object`' monday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the drive-through hours are "closed" on Monday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity's drive-through is open on Monday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' reopenDate: format: date type: string description: |- Date must be on or after 1970-01-01 Date must be before or on 2038-01-01 Filtering Type: `date` saturday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the drive-through hours are "closed" on Saturday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity's drive-through is open on Saturday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' sunday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the drive-through hours are "closed" on Sunday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity's drive-through is open on Sunday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' thursday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the drive-through hours are "closed" on Thursday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity's drive-through is open on Thursday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' tuesday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the drive-through hours are "closed" on Tuesday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity's drive-through is open on Tuesday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' wednesday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the drive-through hours are "closed" on Wednesday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity's drive-through is open on Wednesday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' description: |- Contains the daily drive-through hours, holiday drive-through hours, and reopen date for the Entity. Each day is represented by a sub-field of `driveThroughHours`. (e.g. `monday`, `tuesday`, etc.) Open times can be specified per day through the `openIntervals` field and the `isClosed` flag. Similarly, holiday drive-through hours are represented by the `holidayHours` sub-field. Setting the `reopenDate` sub-field indicates that the business is temporarily closed and will reopen on the specified date. SPECIAL CASES: * To indicate that an Entity is open 24 hours on a specific day, set start to 00:00 and end to 23:59 in `openIntervals` for that day. * To indicate that an Entity has split hours on a specific day (e.g., open from 9:00 AM to 12:00 PM and again from 1:00 PM to 5:00 PM), supply two or more `openIntervals` values with non-overlapping sets of hours. * If you are providing `openIntervals`, you may not set `isClosed` to true for that day. Filtering Type: `hours` ``` Eligible For: * atm * location * restaurant ``` dropoffCoordinate: additionalProperties: false type: object properties: latitude: minimum: -90 maximum: 90 type: number description: 'Filtering Type: `float`' longitude: minimum: -180 maximum: 180 type: number description: 'Filtering Type: `float`' description: |- Coordinates of the drop-off area for the entity, as provided by you Filtering Type: `object` ``` Eligible For: * atm * event * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` educationList: description: |- Information about the education or training completed by the healthcare professional Array must be ordered. Filtering Type: `list of object` ``` Eligible For: * healthcareProfessional ``` uniqueItems: true type: array items: required: - type - institutionName - yearCompleted additionalProperties: false type: object properties: institutionName: minLength: 0 maxLength: 100 type: string description: 'Filtering Type: `text`' type: enum: - FELLOWSHIP - RESIDENCY - INTERNSHIP - MEDICAL_SCHOOL type: string description: 'Filtering Type: `option`' yearCompleted: multipleOf: 1 minimum: 1900 maximum: 2100 type: number description: 'Filtering Type: `integer`' description: 'Filtering Type: `object`' electricChargingStation: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity has electric car chargine stations on premise. Filtering Type: `option` ``` Eligible For: * hotel ``` elevator: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity has an elevator. Filtering Type: `option` ``` Eligible For: * hotel ``` ellipticalMachine: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity has an elliptical machine. Filtering Type: `option` ``` Eligible For: * hotel ``` emails: description: |- Emails addresses for this entity's point of contact Must be valid email addresses Array must be ordered. Array may have a maximum of 5 elements. Filtering Type: `list of text` ``` Eligible For: * contactCard * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * organization * restaurant ``` uniqueItems: true type: array items: minLength: 0 format: email type: string description: 'Filtering Type: `text`' employmentType: enum: - FULL_TIME - PART_TIME - CONTRACTOR - TEMPORARY - INTERN - VOLUNTEER - PER_DIEM - OTHER type: string description: |- The employment type for the open job. Indicates whether the job is full-time, part-time, temporary, etc. Filtering Type: `option` ``` Eligible For: * job ``` eventStatus: enum: - SCHEDULED - RESCHEDULED - POSTPONED - CANCELED - EVENT_MOVED_ONLINE type: string description: |- Information on whether the event will take place as scheduled Filtering Type: `option` ``` Eligible For: * event ``` facebookAbout: minLength: 0 maxLength: 255 type: string description: |- A description of the entity to be used in the "About You" section on Facebook Filtering Type: `text` ``` Eligible For: * atm * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` facebookCallToAction: required: - type additionalProperties: false type: object properties: type: enum: - NONE - BOOK_NOW - CALL_NOW - CONTACT_US - SEND_MESSAGE - USE_APP - PLAY_GAME - SHOP_NOW - SIGN_UP - WATCH_VIDEO - SEND_EMAIL - LEARN_MORE - PURCHASE_GIFT_CARDS - ORDER_NOW - FOLLOW_PAGE type: string description: |- The action the consumer is being prompted to take by the button's text Filtering Type: `option` value: minLength: 0 type: string description: |- Indicates where consumers will be directed to upon clicking the Call-to-Action button (e.g., a URL). It can be a free-form string or an embedded value, depending on what the user specifies. For example, if the user sets the Facebook Call-to-Action as " 'Sign Up' using 'Website URL' " in the Yext platform, **`type`** will be `SIGN_UP` and **`value`** will be `[[websiteUrl]]`. The Call-to-Action will have the same behavior if the user sets the value to "Custom Value" in the platform and embeds a field. Filtering Type: `text` description: |- Designates the Facebook Call-to-Action button text and value Valid contents of **`value`** depends on the Call-to-Action's **`type`**: * `NONE`: (optional) * `BOOK_NOW`: URL * `CALL_NOW`: Phone number * `CONTACT_US`: URL * `SEND_MESSAGE`: Any string * `USE_APP`: URL * `PLAY_GAME`: URL * `SHOP_NOW`: URL * `SIGN_UP`: URL * `WATCH_VIDEO`: URL * `SEND_EMAIL`: Email address * `LEARN_MORE`: URL * `PURCHASE_GIFT_CARDS`: URL * `ORDER_NOW`: URL * `FOLLOW_PAGE`: Any string Filtering Type: `object` ``` Eligible For: * atm * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` facebookCoverPhoto: required: - url additionalProperties: false type: object description: |- The cover photo for the entity's Facebook profile Displayed as a 851 x 315 pixel image You may need a cover photo in order for your listing to appear on Facebook. Please check your listings tab to learn more. Image must be at least 400 x 150 pixels Image area (width x height) may be no more than 41000000 pixels Image may be no more than 30000 x 30000 pixels Supported Aspect Ratios: * 1 x 1 * 4 x 3 * 3 x 2 * 5 x 3 * 16 x 9 * 3 x 1 * 2 x 3 * 5 x 7 * 4 x 5 * 4 x 1 **NOTE**: Maximum image size is 5mb after normalization and padding (if applicable). As well, there is a 6 second download limit from the image host. Filtering Type: `object` ``` Eligible For: * atm * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` properties: alternateText: minLength: 0 type: string description: 'Filtering Type: `text`' url: minLength: 0 format: uri type: string description: 'Filtering Type: `text`' facebookDescriptor: minLength: 3 maxLength: 75 type: string description: |- Location Descriptors are used for Enterprise businesses that sync Facebook listings using brand page location structure. The Location Descriptor is typically an additional geographic description (e.g. geomodifier) that will appear in parentheses after the name on the Facebook listing. Cannot Include: * HTML markup Filtering Type: `text` ``` Eligible For: * atm * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` facebookName: minLength: 0 type: string description: |- The name for this entity's Facebook profile. A separate name may be specified to send only to Facebook in order to comply with any specific Facebook rules or naming conventions. Filtering Type: `text` ``` Eligible For: * atm * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` facebookOverrideCity: minLength: 0 type: string description: |- The city to be displayed on this entity's Facebook profile Filtering Type: `text` ``` Eligible For: * atm * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` facebookPageUrl: minLength: 0 type: string description: |- URL for the entity's Facebook Page. Valid formats: - facebook.com/profile.php?id=[numId] - facebook.com/group.php?gid=[numId] - facebook.com/groups/[numId] - facebook.com/[Name] - facebook.com/pages/[Name]/[numId] - facebook.com/people/[Name]/[numId] where [Name] is a String and [numId] is an Integer The success response will contain a warning message explaining why the URL wasn't stored in the system. Filtering Type: `text` ``` Eligible For: * atm * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * organization * restaurant ``` facebookParentPageId: minLength: 0 maxLength: 65 type: string description: |- The Facebook Page ID of this entity's brand page if in a brand page location structure Filtering Type: `text` ``` Eligible For: * atm * brand * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` facebookProfilePhoto: required: - url additionalProperties: false type: object description: |- The profile picture for the entity's Facebook profile You must have a profile picture in order for your listing to appear on Facebook. Image must be at least 180 x 180 pixels Image area (width x height) may be no more than 41000000 pixels Image may be no more than 30000 x 30000 pixels Supported Aspect Ratios: * 1 x 1 * 4 x 3 * 3 x 2 * 5 x 3 * 16 x 9 * 3 x 1 * 2 x 3 * 5 x 7 * 4 x 5 * 4 x 1 **NOTE**: Maximum image size is 5mb after normalization and padding (if applicable). As well, there is a 6 second download limit from the image host. Filtering Type: `object` ``` Eligible For: * atm * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` properties: alternateText: minLength: 0 type: string description: 'Filtering Type: `text`' url: minLength: 0 format: uri type: string description: 'Filtering Type: `text`' facebookStoreId: minLength: 0 type: string description: |- The Store ID used for this entity in a brand page location structure Filtering Type: `text` ``` Eligible For: * atm * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` facebookVanityUrl: minLength: 0 maxLength: 50 type: string description: |- The username that appear's in the Facebook listing URL to help customers find and remember a brand’s Facebook page. The username is also be used for tagging the Facebook page in other users’ posts, and searching for the Facebook page. Filtering Type: `text` ``` Eligible For: * atm * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` facebookWebsiteOverride: minLength: 0 format: uri type: string description: |- The URL you would like to submit to Facebook in place of the one given in **`websiteUrl`** (if applicable). Filtering Type: `text` ``` Eligible For: * atm * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` fax: minLength: 0 type: string description: |- Must be a valid fax number. If the fax number's calling code is for a country other than the one given in the entity's **`countryCode`**, the fax number provided must contain the calling code (e.g., `+44` in `+442038083831`). Otherwise, the calling code is optional. Filtering Type: `text` ``` Eligible For: * atm * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` featuredMessage: additionalProperties: false type: object properties: description: minLength: 0 maxLength: 50 type: string description: |- The text of Featured Message. Default: `Call today!` Cannot include: - inappropriate language - HTML markup - a URL or domain name - a phone number - control characters ([\x00-\x1F\x7F]) - insufficient spacing If you submit a Featured Message that contains profanity or more than 50 characters, it will be ignored. The success response will contain a warning message explaining why your Featured Message wasn't stored in the system. Cannot Include: * HTML markup Filtering Type: `text` url: minLength: 0 maxLength: 255 format: uri type: string description: |- Valid URL linked to the Featured Message text Filtering Type: `text` description: |- Information about the entity's Featured Message Filtering Type: `object` ``` Eligible For: * atm * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` firstName: minLength: 0 maxLength: 35 type: string description: |- The first name of the healthcare professional Cannot Include: * a URL or domain name * HTML markup Filtering Type: `text` ``` Eligible For: * healthcareProfessional ``` firstPartyReviewPage: minLength: 0 type: string description: |- Link to the review-collection page, where consumers can leave first-party reviews ``` Eligible For: * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` fitnessCenter: enum: - FITNESS_CENTER_AVAILABLE - FITNESS_CENTER_AVAILABLE_FOR_FREE - NOT_APPLICABLE type: string description: |- Indicates whether the entity has a fitness center. Filtering Type: `option` ``` Eligible For: * hotel ``` floorCount: multipleOf: 1 minimum: 0 type: number description: |- The number of floors the entity has from ground floor to top floor. Filtering Type: `integer` ``` Eligible For: * hotel ``` freeWeights: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity has free weights. Filtering Type: `option` ``` Eligible For: * hotel ``` frequentlyAskedQuestions: description: |- A list of questions that are frequently asked about this entity Array must be ordered. Array may have a maximum of 100 elements. Filtering Type: `list of object` ``` Eligible For: * atm * event * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` uniqueItems: true type: array items: required: - question additionalProperties: false type: object properties: answer: minLength: 1 maxLength: 4096 type: string description: 'Filtering Type: `text`' question: minLength: 1 maxLength: 4096 type: string description: 'Filtering Type: `text`' description: 'Filtering Type: `object`' frontDesk: enum: - FRONT_DESK_AVAILABLE - FRONT_DESK_AVAILABLE_24_HOURS - NOT_APPLICABLE type: string description: |- Indicates whether the entity has a front desk. Filtering Type: `option` ``` Eligible For: * hotel ``` fullyVaccinatedStaff: type: boolean description: |- Indicates whether the staff is vaccinated against COVID-19. Filtering Type: `boolean` ``` Eligible For: * healthcareFacility * hotel * location * restaurant ``` gameRoom: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity has a game room. Filtering Type: `option` ``` Eligible For: * hotel ``` gender: enum: - UNSPECIFIED - FEMALE - MALE - NONBINARY - TRANSGENDER_FEMALE - TRANSGENDER_MALE - OTHER - PREFER_NOT_TO_DISCLOSE type: string description: |- The gender of the healthcare professional Filtering Type: `option` ``` Eligible For: * healthcareProfessional ``` geomodifier: minLength: 0 type: string description: |- Provides additional information on where the entity can be found (e.g., `Times Square`, `Global Center Mall`) Filtering Type: `text` ``` Eligible For: * atm * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` giftShop: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity has a gift shop. Filtering Type: `option` ``` Eligible For: * hotel ``` golf: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity has a golf couse on premise or nearby. The golf course may be independently run. Filtering Type: `option` ``` Eligible For: * hotel ``` googleAttributes: additionalProperties: false type: object properties: {} description: |- The unique IDs of the entity's Google Business Profile keywords, as well as the unique IDs of any values selected for each keyword. Valid keywords (e.g., `has_drive_through`, `has_fitting_room`, `kitchen_in_room`) are determined by the entity's primary category. A full list of keywords can be retrieved with the Google Fields: List endpoint. Keyword values provide more details on how the keyword applies to the entity (e.g., if the keyword is `has_drive_through`, its values may be `true` or `false`). * If the **`v`** parameter is before `20181204`: **`googleAttributes`** is formatted as a map of key-value pairs (e.g., `[{ "id": "has_wheelchair_accessible_entrance", "values": [ "true" ] }]`) * If the **`v`** parameter is on or after `20181204`: the contents are formatted as a list of objects (e.g., `{ "has_wheelchair_accessible_entrance": [ "true" ]}`) **NOTE:** The latest Google Attributes are available via the Google Fields: List endpoint. Google Attributes are managed by Google and are subject to change without notice. To prevent errors, make sure your API implementation is not dependent on the presence of specific attributes. Filtering Type: `object` ``` Eligible For: * atm * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` googleCoverPhoto: required: - url additionalProperties: false type: object description: |- The cover photo for the entity's Google profile Image must be at least 250 x 250 pixels Filtering Type: `object` ``` Eligible For: * atm * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` properties: alternateText: minLength: 0 type: string description: 'Filtering Type: `text`' url: minLength: 0 format: uri type: string description: 'Filtering Type: `text`' googleMessaging: additionalProperties: false type: object properties: smsNumber: minLength: 0 type: string description: |- The SMS phone number of the entity's point of contact for messaging/ chat functionality. Must be a valid phone number. If the phone number's calling code is for a country other than the one given in the entity's countryCode, the phone number provided must contain the calling code (e.g., +44 in +442038083831). Otherwise, the calling code is optional. Filtering Type: `text` whatsappMessagingUrl: minLength: 0 maxLength: 2000 format: uri type: string description: |- A valid URL for this entity's WhatsApp account. Must be a valid URL Filtering Type: `text` description: |- Information about Google Messaging, WhatsApp and SMS, for the entity’s point of contact for messaging/chat functionality. NOTE: Only one, either WhatsApp or SMS is displayed on the Google listing. If both SMS Number and WhatsApp URL are provided only SMS Number will be displayed on the listing. Filtering Type: `object` ``` Eligible For: * atm * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` googleMyBusinessLabels: description: |- Google Business Profile Labels help users organize their locations into groups within GBP. Array must be ordered. Array may have a maximum of 10 elements. Array item description: >Cannot Include: >* HTML markup Filtering Type: `list of text` ``` Eligible For: * atm * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` uniqueItems: true type: array items: minLength: 0 maxLength: 50 type: string description: |- Cannot Include: * HTML markup Filtering Type: `text` googlePlaceId: minLength: 0 type: string description: |- The unique identifier of this entity on Google Maps. Filtering Type: `text` ``` Eligible For: * atm * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` googleProfilePhoto: required: - url additionalProperties: false type: object description: |- The profile photo for the entity's Google profile Image must be at least 250 x 250 pixels Image may be no more than 5000 x 5000 pixels Supported Aspect Ratios: * 1 x 1 **NOTE**: Maximum image size is 5mb after normalization and padding (if applicable). As well, there is a 6 second download limit from the image host. Filtering Type: `object` ``` Eligible For: * atm * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` properties: alternateText: minLength: 0 type: string description: 'Filtering Type: `text`' url: minLength: 0 format: uri type: string description: 'Filtering Type: `text`' googleWebsiteOverride: minLength: 0 format: uri type: string description: |- 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. Filtering Type: `text` ``` Eligible For: * atm * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` happyHours: additionalProperties: false type: object properties: friday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the happy hours are "closed" on Friday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity's happy hours on Friday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' holidayHours: description: |- **NOTE:** The list of Holiday Hours that you send us must be comprehensive. For example, if you send us a list of Holiday Hours that does not include Holiday Hours that you sent in your last update, Yext considers the missing Holiday Hours to be deleted, and we remove them. Array must be ordered. Filtering Type: `list of object` uniqueItems: true type: array items: required: - date additionalProperties: false type: object properties: date: format: date type: string description: |- Date on which the holiday hours will be in effect. Cannot be in the past. Date must be on or after 1970-01-01 Date must be before or on 2038-01-01 Filtering Type: `date` isClosed: type: boolean description: |- Indicates if the happy hours are "closed" on on the given date. Filtering Type: `boolean` isRegularHours: type: boolean description: |- Indicates whether the holiday hours are the same as the regular business hours for the given date. If set to true, we will update the holiday hours if the regular business hours change for the date's day of the week. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for the Entity's happy hours on the specified date. Filtering Type: `list of object` description: 'Filtering Type: `object`' monday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the happy hours are "closed" on Monday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for the Entity's happy hours on Monday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' reopenDate: format: date type: string description: |- Date must be on or after 1970-01-01 Date must be before or on 2038-01-01 Filtering Type: `date` saturday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the happy hours are "closed" on Saturday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for the Entity's happy hours on Saturday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' sunday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the happy hours are "closed" on Sunday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for the Entity's happy hours on Sunday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' thursday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the happy hours are "closed" on Thursday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for the Entity's happy hours on Thursday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' tuesday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the happy hours are "closed" on Tuesday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for the Entity's happy hours on Tuesday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' wednesday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the happy hours are "closed" on Wednesday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for the Entity's happy hours on Wednesday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' description: |- Contains the daily happy hours, holiday happy hours, and reopen date for the Entity. Each day is represented by a sub-field of `happyHours`. (e.g. `monday`, `tuesday`, etc.) Open times can be specified per day through the `openIntervals` field and the `isClosed` flag. Similarly, holiday happy hours are represented by the `holidayHours` sub-field. Setting the `reopenDate` sub-field indicates that the business is temporarily closed and will reopen on the specified date. SPECIAL CASES: * To indicate that an Entity is open 24 hours on a specific day, set start to 00:00 and end to 23:59 in `openIntervals` for that day. * To indicate that an Entity has split hours on a specific day (e.g., open from 9:00 AM to 12:00 PM and again from 1:00 PM to 5:00 PM), supply two or more `openIntervals` values with non-overlapping sets of hours. * If you are providing `openIntervals`, you may not set `isClosed` to true for that day. Filtering Type: `hours` ``` Eligible For: * hotel * location * restaurant ``` headshot: required: - url additionalProperties: false type: object description: |- A portrait of the healthcare professional Filtering Type: `object` ``` Eligible For: * contactCard * financialProfessional * healthcareProfessional ``` properties: alternateText: minLength: 0 type: string description: 'Filtering Type: `text`' url: minLength: 0 format: uri type: string description: 'Filtering Type: `text`' hiringOrganization: minLength: 0 type: string description: |- The organization that is hiring for the open job Filtering Type: `text` ``` Eligible For: * job ``` holidayHoursConversationEnabled: type: boolean description: |- Indicates whether holiday-hour confirmation alerts are enabled for the Yext Knowledge Assistant for this entity Filtering Type: `boolean` ``` Eligible For: * atm * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` horsebackRiding: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity offers horseback riding. Filtering Type: `option` ``` Eligible For: * hotel ``` hotTub: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity has a hot tub. Filtering Type: `option` ``` Eligible For: * hotel ``` hours: additionalProperties: false type: object properties: friday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the hours of operation are "closed" on Friday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is open on Friday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' holidayHours: description: |- **NOTE:** The list of Holiday Hours that you send us must be comprehensive. For example, if you send us a list of Holiday Hours that does not include Holiday Hours that you sent in your last update, Yext considers the missing Holiday Hours to be deleted, and we remove them. Array must be ordered. Filtering Type: `list of object` uniqueItems: true type: array items: required: - date additionalProperties: false type: object properties: date: format: date type: string description: |- Date on which the holiday hours will be in effect. Cannot be in the past. Date must be on or after 1970-01-01 Date must be before or on 2038-01-01 Filtering Type: `date` isClosed: type: boolean description: |- Indicates if the hours of operation are "closed" on on the given date. Filtering Type: `boolean` isRegularHours: type: boolean description: |- Indicates whether the holiday hours are the same as the regular business hours for the given date. If set to true, we will update the holiday hours if the regular business hours change for the date's day of the week. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is open on the specified date. Filtering Type: `list of object` description: 'Filtering Type: `object`' monday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the hours of operation are "closed" on Monday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is open on Monday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' reopenDate: format: date type: string description: |- Date must be on or after 1970-01-01 Date must be before or on 2038-01-01 Filtering Type: `date` saturday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the hours of operation are "closed" on Saturday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is open on Saturday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' sunday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the hours of operation are "closed" on Sunday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is open on Sunday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' thursday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the hours of operation are "closed" on Thursday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is open on Thursday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' tuesday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the hours of operation are "closed" on Tuesday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is open on Tuesday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' wednesday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the hours of operation are "closed" on Wednesday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is open on Wednesday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' description: |- Contains the daily hours, holiday hours, and reopen date for the Entity. Each day is represented by a sub-field of `hours`. (e.g. `monday`, `tuesday`, etc.) Open times can be specified per day through the `openIntervals` field and the `isClosed` flag. Similarly, holiday hours are represented by the `holidayHours` sub-field. Setting the `reopenDate` sub-field indicates that the business is temporarily closed and will reopen on the specified date. SPECIAL CASES: * To indicate that an Entity is open 24 hours on a specific day, set start to 00:00 and end to 23:59 in `openIntervals` for that day. * To indicate that an Entity has split hours on a specific day (e.g., open from 9:00 AM to 12:00 PM and again from 1:00 PM to 5:00 PM), supply two or more `openIntervals` values with non-overlapping sets of hours. * If you are providing `openIntervals`, you may not set `isClosed` to true for that day. Filtering Type: `hours` ``` Eligible For: * atm * contactCard * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` housekeeping: enum: - HOUSEKEEPING_AVAILABLE - HOUSEKEEPING_AVAILABLE_DAILY - NOT_APPLICABLE type: string description: |- Indicates whether the entity offers housekeeping services. Filtering Type: `option` ``` Eligible For: * hotel ``` impressum: minLength: 0 maxLength: 2000 type: string description: |- A statement of the ownership and authorship of a document. Individuals or organizations based in many German-speaking countries are required by law to include an Impressum in published media. Filtering Type: `text` ``` Eligible For: * atm * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` indoorPoolCount: multipleOf: 1 minimum: 0 type: number description: |- A count of the number of indoor pools Filtering Type: `integer` ``` Eligible For: * hotel ``` instagramHandle: minLength: 0 maxLength: 30 type: string description: |- Valid Instagram username for the entity without the leading "@" (e.g., `NewCityAuto`) Filtering Type: `text` ``` Eligible For: * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * organization * restaurant ``` insuranceAccepted: description: |- A list of insurance policies accepted by the healthcare provider Array must be ordered. Array may have a maximum of 100 elements. Array item description: >Cannot Include: >* HTML markup Filtering Type: `list of text` ``` Eligible For: * healthcareFacility * healthcareProfessional ``` uniqueItems: true type: array items: minLength: 0 maxLength: 100 type: string description: |- Cannot Include: * HTML markup Filtering Type: `text` iosAppUrl: minLength: 0 type: string description: |- The URL where consumers can download the entity's app to their iPhone or iPad Filtering Type: `text` ``` Eligible For: * brand * financialProfessional * hotel * location * restaurant ``` isClusterPrimary: type: boolean description: |- Indicates whether the healthcare entity is the primary entity in its group Filtering Type: `boolean` ``` Eligible For: * healthcareProfessional ``` isFreeEvent: type: boolean description: |- Indicates whether or not the event is free Filtering Type: `boolean` ``` Eligible For: * event ``` isoRegionCode: minLength: 0 type: string description: |- The ISO 3166-2 region code for the entity Yext will determine the entity's code and update **`isoRegionCode`** with that value. If Yext is unable to determine the code for the entity, the entity'ss ISO 3166-1 alpha-2 country code will be used. Filtering Type: `text` ``` Eligible For: * atm * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` keywords: description: |- Keywords that describe the entity. All strings must be non-empty when trimmed of whitespace. Array must be ordered. Array may have a maximum of 100 elements. Array item description: >Cannot Include: >* HTML markup Filtering Type: `list of text` ``` Eligible For: * atm * card * event * faq * financialProfessional * healthcareFacility * healthcareProfessional * helpArticle * hotel * job * location * product * restaurant ``` uniqueItems: true type: array items: minLength: 0 maxLength: 100 type: string description: |- Cannot Include: * HTML markup Filtering Type: `text` kidFriendly: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates if the entity is kid friendly. Filtering Type: `option` ``` Eligible For: * hotel ``` kidsClub: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates if the property has a Kids Club. Filtering Type: `option` ``` Eligible For: * hotel ``` kidsStayFree: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity allows kids to stay free. Filtering Type: `option` ``` Eligible For: * hotel ``` kitchenHours: additionalProperties: false type: object properties: friday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the kitchen hours are "closed" on Friday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity's kitchen is open on Friday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' holidayHours: description: |- **NOTE:** The list of Holiday Hours that you send us must be comprehensive. For example, if you send us a list of Holiday Hours that does not include Holiday Hours that you sent in your last update, Yext considers the missing Holiday Hours to be deleted, and we remove them. Array must be ordered. Filtering Type: `list of object` uniqueItems: true type: array items: required: - date additionalProperties: false type: object properties: date: format: date type: string description: |- Date on which the holiday hours will be in effect. Cannot be in the past. Date must be on or after 1970-01-01 Date must be before or on 2038-01-01 Filtering Type: `date` isClosed: type: boolean description: |- Indicates if the kitchen hours are "closed" on on the given date. Filtering Type: `boolean` isRegularHours: type: boolean description: |- Indicates whether the holiday hours are the same as the regular business hours for the given date. If set to true, we will update the holiday hours if the regular business hours change for the date's day of the week. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity's kitchen is open on the specified date. Filtering Type: `list of object` description: 'Filtering Type: `object`' monday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the kitchen hours are "closed" on Monday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity's kitchen is open on Monday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' reopenDate: format: date type: string description: |- Date must be on or after 1970-01-01 Date must be before or on 2038-01-01 Filtering Type: `date` saturday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the kitchen hours are "closed" on Saturday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity's kitchen is open on Saturday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' sunday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the kitchen hours are "closed" on Sunday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity's kitchen is open on Sunday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' thursday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the kitchen hours are "closed" on Thursday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity's kitchen is open on Thursday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' tuesday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the kitchen hours are "closed" on Tuesday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity's kitchen open on Tuesday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' wednesday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the kitchen hours are "closed" on Wednesday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity's kitchen is open on Wednesday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' description: |- Contains the daily kitchen hours, holiday kitchen hours, and reopen date for the Entity. Each day is represented by a sub-field of `kitchenHours`. (e.g. `monday`, `tuesday`, etc.) Open times can be specified per day through the `openIntervals` field and the `isClosed` flag. Similarly, holiday kitchen hours are represented by the `holidayHours` sub-field. Setting the `reopenDate` sub-field indicates that the business is temporarily closed and will reopen on the specified date. SPECIAL CASES: * To indicate that an Entity is open 24 hours on a specific day, set start to 00:00 and end to 23:59 in `openIntervals` for that day. * To indicate that an Entity has split hours on a specific day (e.g., open from 9:00 AM to 12:00 PM and again from 1:00 PM to 5:00 PM), supply two or more `openIntervals` values with non-overlapping sets of hours. * If you are providing `openIntervals`, you may not set `isClosed` to true for that day. Filtering Type: `hours` ``` Eligible For: * hotel * location * restaurant ``` labels: uniqueItems: false type: array items: minLength: 0 type: string description: |- The IDs of the entity labels that have been added to this entity. Entity labels help you identify entities that share a certain characteristic; they do not appear on your entity'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. Filtering Type: `opaque` ``` Eligible For: * atm * board * brand * card * contactCard * event * faq * financialProfessional * healthcareFacility * healthcareProfessional * helpArticle * hotel * hotelRoomType * job * location * organization * product * restaurant ``` landingPageUrl: minLength: 0 format: uri type: string description: |- The URL of this entity's Landing Page that was created with Yext Pages Filtering Type: `text` ``` Eligible For: * atm * card * event * faq * financialProfessional * healthcareFacility * healthcareProfessional * helpArticle * hotel * job * location * product * restaurant ``` languages: description: |- The langauges in which consumers can commicate with this entity or its staff members All strings must be non-empty when trimmed of whitespace. Array must be ordered. Array may have a maximum of 100 elements. Array item description: >Cannot Include: >* HTML markup Filtering Type: `list of text` ``` Eligible For: * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` uniqueItems: true type: array items: minLength: 0 maxLength: 100 type: string description: |- Cannot Include: * HTML markup Filtering Type: `text` lastName: minLength: 0 maxLength: 35 type: string description: |- The last name of the healthcare professional Cannot Include: * a URL or domain name * HTML markup Filtering Type: `text` ``` Eligible For: * healthcareProfessional ``` laundry: enum: - FULL_SERVICE - SELF_SERVICE - NOT_APPLICABLE type: string description: |- Indicates whether the entity offers laundry services. Filtering Type: `option` ``` Eligible For: * hotel ``` lazyRiver: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates if the property has a lazy river Filtering Type: `option` ``` Eligible For: * hotel ``` lifeguard: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates if the property has a lifeguard on duty Filtering Type: `option` ``` Eligible For: * hotel ``` linkedInUrl: minLength: 0 format: uri type: string description: |- URL for your LinkedIn account, format should be https://www.linkedin.com/in/yourUsername Filtering Type: `text` ``` Eligible For: * contactCard * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * organization * restaurant ``` linkedLocation: type: string description: |- location ID of the event location, if the event is held at a location managed in the Yext Knowledge Manager Filtering Type: `entityId` ``` Eligible For: * contactCard * event ``` localPhone: minLength: 0 type: string description: |- Must be a valid, non-toll-free phone number, based on the country specified in **`address.region`**. Phone numbers for US entities must contain 10 digits. Filtering Type: `text` ``` Eligible For: * atm * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` localShuttle: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity offers local shuttle services. Filtering Type: `option` ``` Eligible For: * hotel ``` locatedIn: type: string description: |- For atms, the external ID of the entity that the atm is installed in. The entity must be in the same business account as the atm. Filtering Type: `entityId` ``` Eligible For: * atm ``` location: additionalProperties: false type: object properties: existingLocation: type: string description: |- A location entity referenced by Yext ID or Entity ID where this job opening exists Filtering Type: `entityId` externalLocation: minLength: 0 maxLength: 255 type: string description: |- A location string where this job opening exists Cannot Include: * a URL or domain name * HTML markup Filtering Type: `text` description: |- The location where this job opening exists as either an existing location or an external location Filtering Type: `object` ``` Eligible For: * job ``` locationType: enum: - LOCATION - HEALTHCARE_FACILITY - HEALTHCARE_PROFESSIONAL - ATM - RESTAURANT - HOTEL type: string description: |- Indicates the entity's type, if it is not an event Filtering Type: `option` ``` Eligible For: * atm * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` logo: required: - image additionalProperties: false type: object description: |- An image of the entity's logo Supported Aspect Ratios: * 1 x 1 **NOTE**: Maximum image size is 5mb after normalization and padding (if applicable). As well, there is a 6 second download limit from the image host. Filtering Type: `object` ``` Eligible For: * atm * contactCard * faq * financialProfessional * healthcareFacility * healthcareProfessional * hotel * job * location * organization * restaurant ``` properties: clickthroughUrl: minLength: 0 format: uri type: string description: 'Filtering Type: `text`' description: minLength: 0 type: string description: 'Filtering Type: `text`' details: minLength: 0 type: string description: 'Filtering Type: `text`' image: required: - url additionalProperties: false type: object description: |- Supported Aspect Ratios: * 1 x 1 **NOTE**: Maximum image size is 5mb after normalization and padding (if applicable). As well, there is a 6 second download limit from the image host. Filtering Type: `object` properties: alternateText: minLength: 0 type: string description: 'Filtering Type: `text`' url: minLength: 0 format: uri type: string description: 'Filtering Type: `text`' mainPhone: minLength: 0 type: string description: |- The main phone number of the entity's point of contact Must be a valid phone number. If the phone number's calling code is for a country other than the one given in the entity's **`countryCode`**, the phone number provided must contain the calling code (e.g., `+44` in `+442038083831`). Otherwise, the calling code is optional. Filtering Type: `text` ``` Eligible For: * atm * contactCard * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * organization * restaurant ``` massage: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity offers massage services. Filtering Type: `option` ``` Eligible For: * hotel ``` maxAgeOfKidsStayFree: multipleOf: 1 minimum: 0 type: number description: |- The maximum age specified by the property for children to stay in the room/suite of a parent or adult without an additional fee Filtering Type: `integer` ``` Eligible For: * hotel ``` maxNumberOfKidsStayFree: multipleOf: 1 minimum: 0 type: number description: |- The maximum number of children who can stay in the room/suite of a parent or adult without an additional fee Filtering Type: `integer` ``` Eligible For: * hotel ``` mealsServed: uniqueItems: true type: array items: enum: - BREAKFAST - LUNCH - BRUNCH - DINNER - HAPPY_HOUR - LATE_NIGHT type: string description: 'Filtering Type: `option`' description: |- Types of meals served at this restaurant Filtering Type: `list of option` ``` Eligible For: * restaurant ``` meetingRoomCount: multipleOf: 1 minimum: 0 type: number description: |- The number of meeting rooms the entity has. Filtering Type: `integer` ``` Eligible For: * hotel ``` menuUrl: additionalProperties: false type: object properties: displayUrl: minLength: 0 maxLength: 2000 format: uri type: string description: |- The URL that is shown on your listings in place of **`menuUrl.url`**. You can use **`menuUrl.displayUrl`** to display a short, memorable web address that redirects consumers to the URL given in **`menuUrl.url`**. Filtering Type: `text` preferDisplayUrl: type: boolean description: |- If set to true, only the display URL will be sent to those publishers who do not support separate display and tracking URLs for this field. Filtering Type: `boolean` url: minLength: 0 maxLength: 2000 format: uri type: string description: |- A valid URL where consumers can view the entity's menu Filtering Type: `text` description: |- Information about the URL where consumers can view the entity's menu Filtering Type: `object` ``` Eligible For: * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` menus: additionalProperties: false type: object properties: ids: description: |- IDs of the Menu Lists associated with this entity Array must be ordered. Array may have a maximum of 40 elements. Filtering Type: `list of text` uniqueItems: true type: array items: minLength: 0 type: string description: 'Filtering Type: `text`' label: minLength: 0 maxLength: 30 type: string description: |- Label to be used for this entity's Menu Lists. This label will appear on your entity's listings. Filtering Type: `text` description: |- Information about the Menu Content Lists associated with this entity Filtering Type: `object` ``` Eligible For: * hotel * location * restaurant ``` middleName: minLength: 0 maxLength: 35 type: string description: |- The middle name of the healthcare professional Cannot Include: * a URL or domain name * HTML markup Filtering Type: `text` ``` Eligible For: * healthcareProfessional ``` mobilePhone: minLength: 0 type: string description: |- Must be a valid phone number. If the phone number's calling code is for a country other than the one given in the entity's **`countryCode`**, the phone number provided must contain the calling code (e.g., `+44` in `+442038083831`). Otherwise, the calling code is optional. Filtering Type: `text` ``` Eligible For: * atm * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` mobilityAccessible: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity is mobility/wheelchair accessible Filtering Type: `option` ``` Eligible For: * hotel ``` nightclub: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity has a nightclub. Filtering Type: `option` ``` Eligible For: * hotel ``` npi: minLength: 0 type: string description: |- The National Provider Identifier (NPI) of the healthcare provider Filtering Type: `text` ``` Eligible For: * healthcareFacility * healthcareProfessional ``` nudgeEnabled: type: boolean description: |- Indicates whether Knowledge Nudge is enabled for the Yext Knowledge Assistant for this entity Filtering Type: `boolean` ``` Eligible For: * atm * faq * financialProfessional * healthcareFacility * healthcareProfessional * helpArticle * hotel * job * location * organization * product * restaurant ``` officeName: minLength: 0 type: string description: |- The name of the office where the healthcare professional works, if different from **`name`** Filtering Type: `text` ``` Eligible For: * healthcareProfessional ``` onlineServiceHours: additionalProperties: false type: object properties: friday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the online service hours are "closed" on Friday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for the Entity's online service hours on Friday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' holidayHours: description: |- **NOTE:** The list of Holiday Hours that you send us must be comprehensive. For example, if you send us a list of Holiday Hours that does not include Holiday Hours that you sent in your last update, Yext considers the missing Holiday Hours to be deleted, and we remove them. Array must be ordered. Filtering Type: `list of object` uniqueItems: true type: array items: required: - date additionalProperties: false type: object properties: date: format: date type: string description: |- Date on which the holiday hours will be in effect. Cannot be in the past. Date must be on or after 1970-01-01 Date must be before or on 2038-01-01 Filtering Type: `date` isClosed: type: boolean description: |- Indicates if the online service hours are "closed" on on the given date. Filtering Type: `boolean` isRegularHours: type: boolean description: |- Indicates whether the holiday hours are the same as the regular business hours for the given date. If set to true, we will update the holiday hours if the regular business hours change for the date's day of the week. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for the Entity's online service hours on the specified date. Filtering Type: `list of object` description: 'Filtering Type: `object`' monday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the online service hours are "closed" on Monday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for the Entity's online service hours on Monday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' reopenDate: format: date type: string description: |- Date must be on or after 1970-01-01 Date must be before or on 2038-01-01 Filtering Type: `date` saturday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the online service hours are "closed" on Saturday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for the Entity's online service hours on Saturday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' sunday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the online service hours are "closed" on Sunday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for the Entity's online service hours on Sunday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' thursday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the online service hours are "closed" on Thursday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for the Entity's online service hours on Thursday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' tuesday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the online service hours are "closed" on Tuesday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for the Entity's online service hours on Tuesday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' wednesday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the online service hours are "closed" on Wednesday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for the Entity's online service hours on Wednesday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' description: |- Contains the daily online service hours, holiday online service hours, and reopen date for the Entity. Each day is represented by a sub-field of `onlineServiceHours`. (e.g. `monday`, `tuesday`, etc.) Open times can be specified per day through the `openIntervals` field and the `isClosed` flag. Similarly, holiday online service hours are represented by the `holidayHours` sub-field. Setting the `reopenDate` sub-field indicates that the business is temporarily closed and will reopen on the specified date. SPECIAL CASES: * To indicate that an Entity is open 24 hours on a specific day, set start to 00:00 and end to 23:59 in `openIntervals` for that day. * To indicate that an Entity has split hours on a specific day (e.g., open from 9:00 AM to 12:00 PM and again from 1:00 PM to 5:00 PM), supply two or more `openIntervals` values with non-overlapping sets of hours. * If you are providing `openIntervals`, you may not set `isClosed` to true for that day. Filtering Type: `hours` ``` Eligible For: * financialProfessional * healthcareFacility * healthcareProfessional * location * restaurant ``` openDate: format: date type: string description: |- The date that the entity is set to open for the first time. Must be formatted in YYYY-MM-DD format. Date must be on or after 1970-01-01 Date must be before or on 2038-01-01 Filtering Type: `date` ``` Eligible For: * atm * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` operatingCountries: uniqueItems: true type: array items: enum: - AD - AE - AF - AG - AI - AL - AM - AO - AR - AS - AT - AU - AW - AX - AZ - BA - BB - BD - BE - BF - BG - BH - BI - BJ - BL - BM - BN - BO - BQ - BR - BS - BT - BW - BY - BZ - CA - CD - CF - CG - CH - CI - CK - CL - CM - CN - CO - CR - CU - CV - CW - CY - CZ - DE - DJ - DK - DM - DO - DZ - EC - EE - EG - EH - ER - ES - ET - FI - FJ - FK - FM - FO - FR - GA - GB - GD - GE - GF - GG - GH - GI - GL - GM - GN - GP - GQ - GR - GT - GU - GW - GY - HK - HN - HR - HT - HU - ID - IE - IL - IM - IN - IQ - IR - IS - IT - JE - JM - JO - JP - KE - KG - KH - KI - KM - KN - KR - KW - KY - KZ - LA - LB - LC - LI - LK - LR - LS - LT - LU - LV - LY - MA - MC - MD - ME - MF - MG - MH - MK - ML - MM - MN - MO - MP - MQ - MR - MS - MT - MU - MV - MW - MX - MY - MZ - NA - NC - NE - NG - NI - NL - 'NO' - NP - NR - NZ - OM - PA - PE - PF - PG - PH - PK - PL - PM - PR - PS - PT - PW - PY - QA - RE - RO - RS - RU - RW - SA - SB - SC - SD - SE - SG - SH - SI - SJ - SK - SL - SM - SN - SO - SR - SS - ST - SV - SX - SY - SZ - TC - TD - TG - TH - TJ - TL - TM - TN - TO - TR - TT - TV - TW - TZ - UA - UG - US - UY - UZ - VA - VC - VE - VG - VI - VN - VU - WF - WS - XK - YE - YT - ZA - ZM - ZW type: string description: 'Filtering Type: `option`' description: |- The list of countries the business operates in Filtering Type: `list of option` ``` Eligible For: * organization ``` orderUrl: additionalProperties: false type: object properties: displayUrl: minLength: 0 maxLength: 2000 format: uri type: string description: |- The URL that is shown on your listings in place of **`orderUrl.url`**. You can use **`orderUrl.displayUrl`** to display a short, memorable web address that redirects consumers to the URL given in **`orderUrl.url`**. Filtering Type: `text` preferDisplayUrl: type: boolean description: |- If set to true, only the display URL will be sent to those publishers who do not support separate display and tracking URLs for this field. Filtering Type: `boolean` url: minLength: 0 maxLength: 2000 format: uri type: string description: |- A valid URL used to place an order at this entity Filtering Type: `text` description: |- Information about the URL used to place orders that will be fulfilled by the entity Filtering Type: `object` ``` Eligible For: * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` organizerEmail: minLength: 0 format: email type: string description: |- Point of contact for the event organizer (not to be published publicly) Filtering Type: `text` ``` Eligible For: * event ``` organizerName: minLength: 0 type: string description: |- Point of contact for the event organizer (not to be published publicly) Filtering Type: `text` ``` Eligible For: * event ``` organizerPhone: minLength: 0 type: string description: |- Point of contact for the event organizer (not to be published publicly) Filtering Type: `text` ``` Eligible For: * event ``` outdoorPoolCount: multipleOf: 1 minimum: 0 type: number description: |- The number of outdoor pools the entity has. Filtering Type: `integer` ``` Eligible For: * hotel ``` parking: enum: - PARKING_AVAILABLE - PARKING_AVAILABLE_FOR_FREE - NOT_APPLICABLE type: string description: |- Indicates whether the entity offers parking services. Filtering Type: `option` ``` Eligible For: * hotel ``` paymentOptions: uniqueItems: true type: array items: enum: - AFTERPAY - ALIPAY - AMERICANEXPRESS - ANDROIDPAY - APPLEPAY - ATM - ATMQUICK - BACS - BANCONTACT - BANKDEPOSIT - BANKPAY - BGO - BITCOIN - Bar - CARTASI - CASH - CCS - CHECK - CHEQUESVACANCES - CONB - CONTACTLESSPAYME - CVVV - DEBITCARD - DEBITNOTE - DINERSCLUB - DIRECTDEBIT - DISCOVER - ECKARTE - ECOCHEQUE - EKENA - EMV - FINANCING - GIFTCARD - GOPAY - HAYAKAKEN - HEBAG - IBOD - ICCARDS - ICOCA - ID - IDEAL - INCA - INVOICE - JCB - JCoinPay - JKOPAY - KITACA - KLA - KLARNA - LINEPAY - MAESTRO - MANACA - MASTERCARD - MIPAY - MONIZZE - MPAY - Manuelle Lastsch - Merpay - NANACO - NEXI - NIMOCA - OREM - PASMO - PAYBACKPAY - PAYBOX - PAYCONIQ - PAYPAL - PAYPAY - PAYSEC - PIN - POSTEPAY - QRCODE - QUICPAY - RAKUTENEDY - RAKUTENPAY - SAMSUNGPAY - SODEXO - SUGOCA - SUICA - SWISH - TICKETRESTAURANT - TOICA - TRAVELERSCHECK - TSCUBIC - TWINT - UNIONPAY - VEV - VISA - VISAELECTRON - VOB - VOUCHER - VPAY - WAON - WECHATPAY - WIRETRANSFER - Yucho Pay - ZELLE - auPay - dBarai - Überweisung type: string description: 'Filtering Type: `option`' description: |- The payment methods accepted by this entity Valid elements depend on the entity's country. Filtering Type: `list of option` ``` Eligible For: * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` performers: description: |- Performers at the event Array must be ordered. Array may have a maximum of 100 elements. Filtering Type: `list of text` ``` Eligible For: * event ``` uniqueItems: true type: array items: minLength: 0 maxLength: 100 type: string description: 'Filtering Type: `text`' petsAllowed: enum: - PETS_WELCOME - PETS_WELCOME_FOR_FREE - NOT_APPLICABLE - NOT_ALLOWED type: string description: |- Indicates if the entity is pet friendly. Filtering Type: `option` ``` Eligible For: * hotel ``` photoGallery: description: |- **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. Array must be ordered. Array may have a maximum of 500 elements. Array item description: >Supported Aspect Ratios: >* 1 x 1 >* 4 x 3 >* 3 x 2 >* 5 x 3 >* 16 x 9 >* 3 x 1 >* 2 x 3 >* 5 x 7 >* 4 x 5 >* 4 x 1 > >**NOTE**: Maximum image size is 5mb after normalization and padding (if applicable). As well, there is a 6 second download limit from the image host. > Filtering Type: `list of object` ``` Eligible For: * atm * event * financialProfessional * healthcareFacility * healthcareProfessional * hotel * hotelRoomType * location * organization * product * restaurant ``` uniqueItems: false type: array items: required: - image additionalProperties: false type: object description: |- Supported Aspect Ratios: * 1 x 1 * 4 x 3 * 3 x 2 * 5 x 3 * 16 x 9 * 3 x 1 * 2 x 3 * 5 x 7 * 4 x 5 * 4 x 1 **NOTE**: Maximum image size is 5mb after normalization and padding (if applicable). As well, there is a 6 second download limit from the image host. Filtering Type: `object` properties: clickthroughUrl: minLength: 0 format: uri type: string description: 'Filtering Type: `text`' description: minLength: 0 type: string description: 'Filtering Type: `text`' details: minLength: 0 type: string description: 'Filtering Type: `text`' image: required: - url additionalProperties: false type: object description: |- Supported Aspect Ratios: * 1 x 1 * 4 x 3 * 3 x 2 * 5 x 3 * 16 x 9 * 3 x 1 * 2 x 3 * 5 x 7 * 4 x 5 * 4 x 1 **NOTE**: Maximum image size is 5mb after normalization and padding (if applicable). As well, there is a 6 second download limit from the image host. Filtering Type: `object` properties: alternateText: minLength: 0 type: string description: 'Filtering Type: `text`' url: minLength: 0 format: uri type: string description: 'Filtering Type: `text`' pickupCoordinate: additionalProperties: false type: object properties: latitude: minimum: -90 maximum: 90 type: number description: 'Filtering Type: `float`' longitude: minimum: -180 maximum: 180 type: number description: 'Filtering Type: `float`' description: |- Coordinates of where consumers can be picked up at the entity, as provided by you Filtering Type: `object` ``` Eligible For: * atm * event * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` pickupHours: additionalProperties: false type: object properties: friday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the pickup hours are "closed" on Friday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is open for pickup on Friday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' holidayHours: description: |- **NOTE:** The list of Holiday Hours that you send us must be comprehensive. For example, if you send us a list of Holiday Hours that does not include Holiday Hours that you sent in your last update, Yext considers the missing Holiday Hours to be deleted, and we remove them. Array must be ordered. Filtering Type: `list of object` uniqueItems: true type: array items: required: - date additionalProperties: false type: object properties: date: format: date type: string description: |- Date on which the holiday hours will be in effect. Cannot be in the past. Date must be on or after 1970-01-01 Date must be before or on 2038-01-01 Filtering Type: `date` isClosed: type: boolean description: |- Indicates if the pickup hours are "closed" on on the given date. Filtering Type: `boolean` isRegularHours: type: boolean description: |- Indicates whether the holiday hours are the same as the regular business hours for the given date. If set to true, we will update the holiday hours if the regular business hours change for the date's day of the week. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is open for pickup on the specified date. Filtering Type: `list of object` description: 'Filtering Type: `object`' monday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the pickup hours are "closed" on Monday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is open for pickup on Monday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' reopenDate: format: date type: string description: |- Date must be on or after 1970-01-01 Date must be before or on 2038-01-01 Filtering Type: `date` saturday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the pickup hours are "closed" on Saturday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is open for pickup on Saturday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' sunday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the pickup hours are "closed" on Sunday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is open for pickup on Sunday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' thursday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the pickup hours are "closed" on Thursday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is open for pickup on Thursday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' tuesday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the pickup hours are "closed" on Tuesday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is open for pickup on Tuesday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' wednesday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the pickup hours are "closed" on Wednesday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is open for pickup on Wednesday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' description: |- Contains the daily pickup hours, holiday pickup hours, and reopen date for the Entity. Each day is represented by a sub-field of `pickupHours`. (e.g. `monday`, `tuesday`, etc.) Open times can be specified per day through the `openIntervals` field and the `isClosed` flag. Similarly, holiday pickup hours are represented by the `holidayHours` sub-field. Setting the `reopenDate` sub-field indicates that the business is temporarily closed and will reopen on the specified date. SPECIAL CASES: * To indicate that an Entity is open 24 hours on a specific day, set start to 00:00 and end to 23:59 in `openIntervals` for that day. * To indicate that an Entity has split hours on a specific day (e.g., open from 9:00 AM to 12:00 PM and again from 1:00 PM to 5:00 PM), supply two or more `openIntervals` values with non-overlapping sets of hours. * If you are providing `openIntervals`, you may not set `isClosed` to true for that day. Filtering Type: `hours` ``` Eligible For: * healthcareFacility * location * restaurant ``` pinterestUrl: minLength: 0 format: uri type: string description: |- URL for your Pinterest account, format should be https://www.pinterest.com/yourUsername Filtering Type: `text` ``` Eligible For: * contactCard * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * organization * restaurant ``` priceRange: enum: - UNSPECIFIED - ONE - TWO - THREE - FOUR type: string description: |- he typical price of products sold by this location, on a scale of 1 (low) to 4 (high) Filtering Type: `option` ``` Eligible For: * atm * healthcareFacility * healthcareProfessional * location * restaurant ``` primaryConversationContact: minLength: 0 type: string description: |- ID of the user who is the primary Knowledge Assistant contact for the entity Filtering Type: `option` ``` Eligible For: * atm * faq * financialProfessional * healthcareFacility * healthcareProfessional * helpArticle * hotel * job * location * organization * product * restaurant ``` privateBeach: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity has access to a private beach. Filtering Type: `option` ``` Eligible For: * hotel ``` privateCarService: enum: - PRIVATE_CAR_SERVICE - PRIVATE_CAR_SERVICE_FOR_FREE - NOT_APPLICABLE type: string description: |- Indicates whether the entity offers private car services. Filtering Type: `option` ``` Eligible For: * hotel ``` productLists: additionalProperties: false type: object properties: ids: description: |- IDs of the Products & Services Lists associated with this entity Array must be ordered. Array may have a maximum of 40 elements. Filtering Type: `list of text` uniqueItems: true type: array items: minLength: 0 type: string description: 'Filtering Type: `text`' label: minLength: 0 maxLength: 30 type: string description: |- Label to be used for this entity's Products & Services Lists. This label will appear on your entity's listings. Filtering Type: `text` description: |- Information about the Products & Services Content Lists associated with this entity Filtering Type: `object` ``` Eligible For: * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` products: description: |- Products sold by this entity All strings must be non-empty when trimmed of whitespace. Array must be ordered. Array may have a maximum of 100 elements. Array item description: >Cannot Include: >* HTML markup Filtering Type: `list of text` ``` Eligible For: * financialProfessional * location ``` uniqueItems: true type: array items: minLength: 0 maxLength: 100 type: string description: |- Cannot Include: * HTML markup Filtering Type: `text` questionsAndAnswers: type: boolean description: |- Indicates whether Yext Knowledge Assistant question-and-answer conversations are enabled for this entity Filtering Type: `boolean` ``` Eligible For: * atm * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * organization * restaurant ``` rankTrackingCompetitors: description: |- Information about the competitors whose search performance you would like to compare to your own Array must be ordered. Array may have a maximum of 5 elements. Filtering Type: `list of object` ``` Eligible For: * atm * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * organization * restaurant ``` uniqueItems: true type: array items: required: - name - website additionalProperties: false type: object properties: name: minLength: 0 maxLength: 100 type: string description: |- A name of a competitor Cannot Include: * HTML markup Filtering Type: `text` website: minLength: 0 maxLength: 255 format: uri type: string description: |- The business website of a competitor Cannot Include: * common domain names, e.g., google.com, youtube.com, etc. Filtering Type: `text` description: 'Filtering Type: `object`' rankTrackingEnabled: type: boolean description: |- Indicates whether Rank Tracking is enabled Filtering Type: `boolean` ``` Eligible For: * atm * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * organization * restaurant ``` rankTrackingFrequency: enum: - WEEKLY - MONTHLY - QUARTERLY type: string description: |- How often we send search queries to track your search performance Filtering Type: `option` ``` Eligible For: * atm * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * organization * restaurant ``` rankTrackingQueryTemplates: description: |- The ways in which your keywords will be arranged in the search queries we use to track your performance Array must have a minimum of 2 elements. Array may have a maximum of 4 elements. Filtering Type: `list of option` ``` Eligible For: * atm * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * organization * restaurant ``` uniqueItems: true type: array items: enum: - KEYWORD - KEYWORD_ZIP - KEYWORD_CITY - KEYWORD_IN_CITY - KEYWORD_NEAR_ME - KEYWORD_CITY_STATE type: string description: 'Filtering Type: `option`' rankTrackingSites: uniqueItems: true type: array items: enum: - GOOGLE_DESKTOP - GOOGLE_MOBILE - BING_DESKTOP - BING_MOBILE - YAHOO_DESKTOP - YAHOO_MOBILE type: string description: 'Filtering Type: `option`' description: |- The search engines that we will use to track your performance Filtering Type: `list of option` ``` Eligible For: * atm * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * organization * restaurant ``` reservationUrl: additionalProperties: false type: object properties: displayUrl: minLength: 0 maxLength: 2000 format: uri type: string description: |- The URL that is shown on your listings in place of **`reservationUrl.url`**. You can use **`reservationUrl.displayUrl`** to display a short, memorable web address that redirects consumers to the URL given in **`reservationUrl.url`**. Must be a valid URL and be specified along with **`reservationUrl.url`**. Filtering Type: `text` preferDisplayUrl: type: boolean description: |- If set to true, only the display URL will be sent to those publishers who do not support separate display and tracking URLs for this field. Filtering Type: `boolean` url: minLength: 0 maxLength: 2000 format: uri type: string description: |- A valid URL used to make reservations at this entity Filtering Type: `text` description: |- Information about the URL consumers can visit to make reservations at this entity Filtering Type: `object` ``` Eligible For: * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` restaurantCount: multipleOf: 1 minimum: 0 type: number description: |- The number of restaurants the entity has. Filtering Type: `integer` ``` Eligible For: * hotel ``` reviewGenerationUrl: minLength: 0 type: string description: |- The URL given Review Invitation emails where consumers can leave a review about the entity ``` Eligible For: * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` reviewResponseConversationEnabled: type: boolean description: |- Indicates whether Yext Knowledge Assistant review-response conversations are enabled for this entity Filtering Type: `boolean` ``` Eligible For: * atm * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` roomCount: multipleOf: 1 minimum: 0 type: number description: |- The number of rooms the entity has. Filtering Type: `integer` ``` Eligible For: * hotel ``` roomService: enum: - ROOM_SERVICE_AVAILABLE - ROOM_SERVICE_AVAILABLE_24_HOURS - NOT_APPLICABLE type: string description: |- Indicates whether the entity offers room service. Filtering Type: `option` ``` Eligible For: * hotel ``` routableCoordinate: additionalProperties: false type: object properties: latitude: minimum: -90 maximum: 90 type: number description: 'Filtering Type: `float`' longitude: minimum: -180 maximum: 180 type: number description: 'Filtering Type: `float`' description: |- Destination coordinates to use for driving directions to the entity, as provided by you Filtering Type: `object` ``` Eligible For: * atm * event * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` salon: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity has a salon. Filtering Type: `option` ``` Eligible For: * hotel ``` sauna: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity has a sauna. Filtering Type: `option` ``` Eligible For: * hotel ``` scuba: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity offers scuba diving. Filtering Type: `option` ``` Eligible For: * hotel ``` selfParking: enum: - SELF_PARKING_AVAILABLE - SELF_PARKING_AVAILABLE_FOR_FREE - NOT_APPLICABLE type: string description: |- Indicates whether the entity offers self parking services. Filtering Type: `option` ``` Eligible For: * hotel ``` seniorHours: additionalProperties: false type: object properties: friday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the senior hours are "closed" on Friday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for the Entity's senior hours on Friday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' holidayHours: description: |- **NOTE:** The list of Holiday Hours that you send us must be comprehensive. For example, if you send us a list of Holiday Hours that does not include Holiday Hours that you sent in your last update, Yext considers the missing Holiday Hours to be deleted, and we remove them. Array must be ordered. Filtering Type: `list of object` uniqueItems: true type: array items: required: - date additionalProperties: false type: object properties: date: format: date type: string description: |- Date on which the holiday hours will be in effect. Cannot be in the past. Date must be on or after 1970-01-01 Date must be before or on 2038-01-01 Filtering Type: `date` isClosed: type: boolean description: |- Indicates if the senior hours are "closed" on on the given date. Filtering Type: `boolean` isRegularHours: type: boolean description: |- Indicates whether the holiday hours are the same as the regular business hours for the given date. If set to true, we will update the holiday hours if the regular business hours change for the date's day of the week. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for the Entity's senior hours on the specified date. Filtering Type: `list of object` description: 'Filtering Type: `object`' monday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the senior hours are "closed" on Monday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for the Entity's senior hours on Monday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' reopenDate: format: date type: string description: |- Date must be on or after 1970-01-01 Date must be before or on 2038-01-01 Filtering Type: `date` saturday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the senior hours are "closed" on Saturday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for the Entity's senior hours on Saturday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' sunday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the senior hours are "closed" on Sunday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for the Entity's senior hours on Sunday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' thursday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the senior hours are "closed" on Thursday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for the Entity's senior hours on Thursday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' tuesday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the senior hours are "closed" on Tuesday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for the Entity's senior hours on Tuesday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' wednesday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the senior hours are "closed" on Wednesday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for the Entity's senior hours on Wednesday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' description: |- Contains the daily senior hours, holiday senior hours, and reopen date for the Entity. Each day is represented by a sub-field of `seniorHours`. (e.g. `monday`, `tuesday`, etc.) Open times can be specified per day through the `openIntervals` field and the `isClosed` flag. Similarly, holiday senior hours are represented by the `holidayHours` sub-field. Setting the `reopenDate` sub-field indicates that the business is temporarily closed and will reopen on the specified date. SPECIAL CASES: * To indicate that an Entity is open 24 hours on a specific day, set start to 00:00 and end to 23:59 in `openIntervals` for that day. * To indicate that an Entity has split hours on a specific day (e.g., open from 9:00 AM to 12:00 PM and again from 1:00 PM to 5:00 PM), supply two or more `openIntervals` values with non-overlapping sets of hours. * If you are providing `openIntervals`, you may not set `isClosed` to true for that day. Filtering Type: `hours` ``` Eligible For: * location * restaurant ``` serviceArea: additionalProperties: false type: object properties: places: description: |- A list of places served by the entity, where each place is either: - a postal code, or - the name of a city. Array must be ordered. Array may have a maximum of 200 elements. Filtering Type: `list of text` uniqueItems: true type: array items: minLength: 0 maxLength: 100 type: string description: 'Filtering Type: `text`' description: |- Information about the area that is served by this entity. It is specified as a list of cities and/or postal codes. **Only for Google Business Profile and Bing:** Currently, **serviceArea** is only supported by Google Business Profile and Bing and will not affect your listings on other sites. Filtering Type: `object` ``` Eligible For: * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` serviceAreaPlaces: description: |- Information about the area that is served by this entity. It is specified as a list of service area names, their associated types and google place ids. **Only for Google Business Profile and Bing:** Currently, **serviceArea** is only supported by Google Business Profile and Bing and will not affect your listings on other sites. Array may have a maximum of 200 elements. Filtering Type: `list of object` ``` Eligible For: * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` uniqueItems: true type: array items: additionalProperties: false type: object properties: name: minLength: 0 maxLength: 100 type: string description: 'Filtering Type: `text`' googlePlaceId: minLength: 0 type: string description: 'Filtering Type: `text`' type: enum: - POSTAL_CODE - REGION - COUNTY - CITY - SUBLOCALITY type: string description: 'Filtering Type: `option`' description: 'Filtering Type: `object`' services: description: |- Services offered by this entity All strings must be non-empty when trimmed of whitespace. Array must be ordered. Array may have a maximum of 100 elements. Array item description: >Cannot Include: >* HTML markup Filtering Type: `list of text` ``` Eligible For: * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` uniqueItems: true type: array items: minLength: 0 maxLength: 100 type: string description: |- Cannot Include: * HTML markup Filtering Type: `text` smokeFreeProperty: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates if the entity is smoke free. Filtering Type: `option` ``` Eligible For: * hotel ``` snorkeling: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity offers snorkeling. Filtering Type: `option` ``` Eligible For: * hotel ``` socialHour: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity offers a social hour. Filtering Type: `option` ``` Eligible For: * hotel ``` spa: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity has a spa. Filtering Type: `option` ``` Eligible For: * hotel ``` specialities: description: |- Up to 100 of this entity's specialities (e.g., for food and dining: `Chicago style`) All strings must be non-empty when trimmed of whitespace. Array must be ordered. Array may have a maximum of 100 elements. Array item description: >Cannot Include: >* HTML markup Filtering Type: `list of text` ``` Eligible For: * financialProfessional * location * restaurant ``` uniqueItems: true type: array items: minLength: 0 maxLength: 100 type: string description: |- Cannot Include: * HTML markup Filtering Type: `text` tableService: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity has a sit-down restaurant. Filtering Type: `option` ``` Eligible For: * hotel ``` takeoutHours: additionalProperties: false type: object properties: friday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the takeout hours are "closed" on Friday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is open for takeout on Friday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' holidayHours: description: |- **NOTE:** The list of Holiday Hours that you send us must be comprehensive. For example, if you send us a list of Holiday Hours that does not include Holiday Hours that you sent in your last update, Yext considers the missing Holiday Hours to be deleted, and we remove them. Array must be ordered. Filtering Type: `list of object` uniqueItems: true type: array items: required: - date additionalProperties: false type: object properties: date: format: date type: string description: |- Date on which the holiday hours will be in effect. Cannot be in the past. Date must be on or after 1970-01-01 Date must be before or on 2038-01-01 Filtering Type: `date` isClosed: type: boolean description: |- Indicates if the takeout hours are "closed" on on the given date. Filtering Type: `boolean` isRegularHours: type: boolean description: |- Indicates whether the holiday hours are the same as the regular business hours for the given date. If set to true, we will update the holiday hours if the regular business hours change for the date's day of the week. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is open for takeout on the specified date. Filtering Type: `list of object` description: 'Filtering Type: `object`' monday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the takeout hours are "closed" on Monday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is open for takeout on Monday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' reopenDate: format: date type: string description: |- Date must be on or after 1970-01-01 Date must be before or on 2038-01-01 Filtering Type: `date` saturday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the takeout hours are "closed" on Saturday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is open for takeout on Saturday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' sunday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the takeout hours are "closed" on Sunday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is open for takeout on Sunday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' thursday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the takeout hours are "closed" on Thursday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is open for takeout on Thursday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' tuesday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the takeout hours are "closed" on Tuesday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is open for takeout on Tuesday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' wednesday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the takeout hours are "closed" on Wednesday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is open for takeout on Wednesday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' description: |- Contains the daily takeout hours, holiday takeout hours, and reopen date for the Entity. Each day is represented by a sub-field of `takeoutHours`. (e.g. `monday`, `tuesday`, etc.) Open times can be specified per day through the `openIntervals` field and the `isClosed` flag. Similarly, holiday takeout hours are represented by the `holidayHours` sub-field. Setting the `reopenDate` sub-field indicates that the business is temporarily closed and will reopen on the specified date. SPECIAL CASES: * To indicate that an Entity is open 24 hours on a specific day, set start to 00:00 and end to 23:59 in `openIntervals` for that day. * To indicate that an Entity has split hours on a specific day (e.g., open from 9:00 AM to 12:00 PM and again from 1:00 PM to 5:00 PM), supply two or more `openIntervals` values with non-overlapping sets of hours. * If you are providing `openIntervals`, you may not set `isClosed` to true for that day. Filtering Type: `hours` ``` Eligible For: * location * restaurant ``` tennis: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity has tennis courts. Filtering Type: `option` ``` Eligible For: * hotel ``` thermalPool: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity has a thermal pool. Filtering Type: `option` ``` Eligible For: * hotel ``` ticketAvailability: enum: - IN_STOCK - SOLD_OUT - PRE_ORDER - UNSPECIFIED type: string description: |- Information about the availability of tickets for the event Filtering Type: `option` ``` Eligible For: * event ``` ticketPriceRange: additionalProperties: false type: object properties: currencyCode: minLength: 0 type: string description: |- Three letter currency code (ISO standard) Filtering Type: `text` maxValue: pattern: ^\d*\.?\d*$ type: string description: |- Maximum ticket price Filtering Type: `decimal` minValue: pattern: ^\d*\.?\d*$ type: string description: |- Minimum ticket price Filtering Type: `decimal` description: |- Contains the price range for the event Filtering Type: `object` ``` Eligible For: * event ``` ticketSaleDateTime: format: date-time type: string description: |- The date/time tickets are available for sale (local time) Filtering Type: `datetime` ``` Eligible For: * event ``` ticketUrl: minLength: 0 format: uri type: string description: |- URL to purchase tickets for the event (if ticketed) Filtering Type: `text` ``` Eligible For: * event ``` tikTokUrl: minLength: 0 format: uri type: string description: |- URL for your TikTok profile, format should be https://www.tiktok.com/yourUsername Filtering Type: `text` ``` Eligible For: * contactCard * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * organization * restaurant ``` time: additionalProperties: false type: object properties: end: format: date-time type: string description: |- End date/time of the event, in local time (see timezone field) Standard ISO 8601 datetime without timezone Format: `YYYY-MM-DDThh:mm` Filtering Type: `datetime` start: format: date-time type: string description: |- Start date/time of the event, in local time (see timezone field) Standard ISO 8601 datetime without timezone Format: `YYYY-MM-DDThh:mm` Filtering Type: `datetime` description: |- Contains the start/end times for the event Filtering Type: `object` ``` Eligible For: * event ``` timeZoneUtcOffset: minLength: 0 type: string description: |- Represents the time zone offset of the entity from UTC, in `±hh:mm` format. For example, if the entity is 4 hours ahead of UTC time, the offset will be `+04:00`. If the entity is 15.5 hours behind UTC time, the offset will be `-15:30`. If the entity is in UTC time, the offset will be `+00:00`. ``` Eligible For: * atm * event * faq * healthcareFacility * healthcareProfessional * hotel * job * location * restaurant ``` timezone: minLength: 0 type: string description: |- The timezone of the entity, in the standard `IANA time zone database` format (tz database). e.g. `"America/New_York"` Filtering Type: `option` ``` Eligible For: * atm * board * card * contactCard * event * faq * financialProfessional * healthcareFacility * healthcareProfessional * helpArticle * hotel * hotelRoomType * job * location * organization * product * restaurant ``` tollFreePhone: minLength: 0 type: string description: |- Must be a valid phone number. If the phone number's calling code is for a country other than the one given in the entity's **`countryCode`**, the phone number provided must contain the calling code (e.g., `+44` in `+442038083831`). Otherwise, the calling code is optional. Filtering Type: `text` ``` Eligible For: * atm * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` treadmill: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity has a treadmill. Filtering Type: `option` ``` Eligible For: * hotel ``` ttyPhone: minLength: 0 type: string description: |- Must be a valid phone number. If the phone number's calling code is for a country other than the one given in the entity's **`countryCode`**, the phone number provided must contain the calling code (e.g., `+44` in `+442038083831`). Otherwise, the calling code is optional. Filtering Type: `text` ``` Eligible For: * atm * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` turndownService: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity offers turndown service. Filtering Type: `option` ``` Eligible For: * hotel ``` twitterHandle: minLength: 0 maxLength: 15 type: string description: |- Valid Twitter handle for the entity without the leading "@" (e.g., `JohnSmith`) 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. Filtering Type: `text` ``` Eligible For: * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * organization * restaurant ``` uberLink: required: - presentation additionalProperties: false type: object properties: presentation: enum: - BUTTON - LINK type: string description: |- Indicates whether the embedded Uber link for this entity 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 entity set as the trip destination. If the Uber app is not installed, the consumer will be prompted to download it. Filtering Type: `option` text: minLength: 0 maxLength: 100 type: string description: |- The text of the embedded Uber link Default is `Ride there with Uber`. **NOTE:** This field is only available if **`uberLink.presentation`** is `LINK`. Filtering Type: `text` description: |- Information about the Yext-powered link that can be copied and pasted into the markup of Yext Pages where the embedded Uber link should appear Filtering Type: `object` ``` Eligible For: * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` uberTripBranding: required: - text - url - description additionalProperties: false type: object properties: description: minLength: 0 maxLength: 150 type: string description: |- A longer description that will appear near the call-to-action in the Uber app during a trip to your entity. **NOTE:** If a value for **`uberTripBranding.description`** is provided, values must also be provided for **`uberTripBranding.text`** and **`uberTripBranding.url`**. Filtering Type: `text` text: minLength: 0 maxLength: 28 type: string description: |- The text of the call-to-action that will appear in the Uber app during a trip to your entity (e.g., `Check out our menu!`) **NOTE:** If a value for **`uberTripBranding.text`** is provided, values must also be provided for **`uberTripBranding.url`** and **`uberTripBranding.description`**. Filtering Type: `text` url: minLength: 0 format: uri type: string description: |- 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 entity. **NOTE:** If a value for **`uberTripBranding.url`** is provided, values must also be provided for **`uberTripBranding.text`** and **`uberTripBranding.description`**. Filtering Type: `text` description: |- Information about the call-to-action consumers will see in the Uber app during a trip to your entity Filtering Type: `object` ``` Eligible For: * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` valetParking: enum: - VALET_PARKING_AVAILABLE - VALET_PARKING_AVAILABLE_FOR_FREE - NOT_APPLICABLE type: string description: |- Indicates whether the entity offers valet parking services. Filtering Type: `option` ``` Eligible For: * hotel ``` validThrough: format: date-time type: string description: |- The date this entity is valid through. Filtering Type: `datetime` ``` Eligible For: * job ``` vendingMachine: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity has a vending machine. Filtering Type: `option` ``` Eligible For: * hotel ``` venueName: minLength: 0 type: string description: |- Name of the venue where the event is being held Filtering Type: `text` ``` Eligible For: * event ``` videos: description: |- Valid YouTube URLs for embedding a video on some publisher sites **NOTE:** Currently, only the first URL in the Array appears in your listings. Array must be ordered. Filtering Type: `list of object` ``` Eligible For: * financialProfessional * healthcareFacility * healthcareProfessional * hotel * hotelRoomType * location * organization * product * restaurant ``` uniqueItems: true type: array items: required: - video additionalProperties: false type: object properties: description: minLength: 0 maxLength: 140 type: string description: |- Cannot Include: * HTML markup Filtering Type: `text` video: required: - url additionalProperties: false type: object properties: url: minLength: 0 format: uri type: string description: 'Filtering Type: `text`' description: 'Filtering Type: `object`' description: 'Filtering Type: `object`' wadingPool: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity has a wading pool. Filtering Type: `option` ``` Eligible For: * hotel ``` wakeUpCalls: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity offers wake up call services. Filtering Type: `option` ``` Eligible For: * hotel ``` walkableCoordinate: additionalProperties: false type: object properties: latitude: minimum: -90 maximum: 90 type: number description: 'Filtering Type: `float`' longitude: minimum: -180 maximum: 180 type: number description: 'Filtering Type: `float`' description: |- Destination coordinates to use for walking directions to the entity, as provided by you Filtering Type: `object` ``` Eligible For: * atm * event * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` waterPark: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity has a water park. Filtering Type: `option` ``` Eligible For: * hotel ``` waterSkiing: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity offers water skiing. Filtering Type: `option` ``` Eligible For: * hotel ``` watercraft: enum: - WATERCRAFT_RENTALS - WATERCRAFT_RENTALS_FOR_FREE - NOT_APPLICABLE type: string description: |- Indicates whether the entity offers any kind of watercrafts. Filtering Type: `option` ``` Eligible For: * hotel ``` waterslide: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity has a water slide. Filtering Type: `option` ``` Eligible For: * hotel ``` wavePool: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity has a wave pool. Filtering Type: `option` ``` Eligible For: * hotel ``` websiteUrl: additionalProperties: false type: object properties: displayUrl: minLength: 0 maxLength: 2000 format: uri type: string description: |- The URL that is shown on your listings in place of **`websiteUrl.url`**. You can use **`websiteUrl.displayUrl`** to display a short, memorable web address that redirects consumers to the URL given in **`websiteUrl.url`**. Must be a valid URL and be specified along with **`websiteUrl.url`**. Filtering Type: `text` preferDisplayUrl: type: boolean description: |- If set to true, only the display URL will be sent to those publishers who do not support separate display and tracking URLs for this field. Filtering Type: `boolean` url: minLength: 0 maxLength: 2000 format: uri type: string description: |- A valid URL for this entity's website Filtering Type: `text` description: |- Information about the website for this entity Filtering Type: `object` ``` Eligible For: * atm * contactCard * event * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * organization * restaurant ``` weightMachine: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity has a weight machine. Filtering Type: `option` ``` Eligible For: * hotel ``` wheelchairAccessible: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates if the entity is wheelchair accessible. Filtering Type: `option` ``` Eligible For: * hotel ``` wifiAvailable: enum: - WIFI_AVAILABLE - WIFI_AVAILABLE_FOR_FREE - NOT_APPLICABLE type: string description: |- Indicates whether the entity has WiFi available Filtering Type: `option` ``` Eligible For: * hotel ``` workRemote: type: boolean description: |- Indicates whether the job is remote. Filtering Type: `boolean` ``` Eligible For: * job ``` yearEstablished: multipleOf: 1 minimum: 1000 maximum: 2028 type: number description: |- The year the entity was established. Filtering Type: `integer` ``` Eligible For: * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` yearLastRenovated: multipleOf: 1 minimum: 1000 maximum: 2028 type: number description: |- The most recent year the entity was partially or completely renovated. Filtering Type: `integer` ``` Eligible For: * hotel ``` yextDisplayCoordinate: additionalProperties: false type: object properties: latitude: minimum: -90 maximum: 90 type: number description: 'Filtering Type: `float`' longitude: minimum: -180 maximum: 180 type: number description: 'Filtering Type: `float`' description: |- Coordinates where the map pin for the entity should be displayed, as calculated by Yext Filtering Type: `object` ``` Eligible For: * atm * event * financialProfessional * healthcareFacility * healthcareProfessional * hotel * job * location * restaurant ``` yextDropoffCoordinate: additionalProperties: false type: object properties: latitude: minimum: -90 maximum: 90 type: number description: 'Filtering Type: `float`' longitude: minimum: -180 maximum: 180 type: number description: 'Filtering Type: `float`' description: |- Coordinates of where consumers can be dropped off at the entity, as calculated by Yext Filtering Type: `object` ``` Eligible For: * atm * event * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` yextPickupCoordinate: additionalProperties: false type: object properties: latitude: minimum: -90 maximum: 90 type: number description: 'Filtering Type: `float`' longitude: minimum: -180 maximum: 180 type: number description: 'Filtering Type: `float`' description: |- Coordinates of where consumers can be picked up at the entity, as calculated by Yext Filtering Type: `object` ``` Eligible For: * atm * event * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` yextRoutableCoordinate: additionalProperties: false type: object properties: latitude: minimum: -90 maximum: 90 type: number description: 'Filtering Type: `float`' longitude: minimum: -180 maximum: 180 type: number description: 'Filtering Type: `float`' description: |- Destination coordinates to use for driving directions to the entity, as calculated by Yext Filtering Type: `object` ``` Eligible For: * atm * event * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` yextWalkableCoordinate: additionalProperties: false type: object properties: latitude: minimum: -90 maximum: 90 type: number description: 'Filtering Type: `float`' longitude: minimum: -180 maximum: 180 type: number description: 'Filtering Type: `float`' description: |- Destination coordinates to use for walking directions to the entity, as calculated by Yext Filtering Type: `object` ``` Eligible For: * atm * event * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` youTubeChannelUrl: minLength: 0 format: uri type: string description: |- URL for your YouTube channel, format should be https://www.youtube.com/c/yourUsername Filtering Type: `text` ``` Eligible For: * contactCard * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * organization * restaurant ``` headers: {} '400': description: Error Response content: application/json: schema: additionalProperties: false type: object properties: meta: additionalProperties: false type: object properties: errors: uniqueItems: false type: array items: additionalProperties: false type: object properties: code: multipleOf: 1 type: number description: | Code that uniquely identifies the error or warning. message: minLength: 0 type: string description: Message explaining the problem. type: enum: - FATAL_ERROR - NON_FATAL_ERROR - WARNING type: string description: List of errors and warnings. uuid: minLength: 0 type: string description: 'Filtering Type: `object`' headers: {} /accounts/{accountId}/entityprofiles/{entityId}: get: operationId: listLanguageProfiles parameters: - schema: minLength: 0 type: string name: accountId in: path required: true - schema: minLength: 0 type: string description: The external ID of the requested Entity name: entityId in: path required: true - schema: minLength: 0 type: string description: A date in `YYYYMMDD` format. name: v in: query required: true - schema: minLength: 0 type: string description: | Optional parameter to return fields of type **Markdown** as HTML. - `false`: **Markdown** fields will be returned as JSON - `true`: **Markdown** fields will be returned as HTML name: convertMarkdownToHTML in: query required: false - schema: minLength: 0 type: string description: | Optional parameter to return fields of type **Rich Text** as HTML. - `false`: **Rich Text** fields will be returned as JSON - `true`: **Rich Text** fields will be returned as HTML name: convertRichTextToHTML in: query required: false - schema: minLength: 0 type: string description: | Comma-separated list of Entity types to filter on. Example: `"location,event"` Should be from the following types: * `atm` * `event` * `faq` * `financialProfessional` * `healthcareFacility` * `healthcareProfessional` * `hotel` * `hotelRoomType` * `job` * `location` * `organization` * `product` * `restaurant` OR the API name of a custom entity type. name: entityTypes in: query required: false - schema: minLength: 0 type: string description: Comma-separated list of field names. When present, only the fields listed will be returned. You can use dot notation to specify substructures (e.g., `"address.line1"`). Custom fields are specified in the same way, albeit with their `c_*` name. name: fields in: query required: false - schema: minLength: 0 type: string default: markdown description: | Present if and only if at least one field is of type "**Legacy Rich Text**." Valid values: * `markdown` * `html` * `none` name: format in: query required: false - schema: minLength: 0 type: string description: The comma-separated language codes corresponding to the languages of the profile that the user wishes to retrieve name: languageCodes in: query required: false tags: - Live API summary: 'Entity Language Profiles: List' description: | Retrieve Language Profiles for an Entity **NOTE:** * Responses will contain resolved values for embedded fields * If the `fields` parameter is unspecified, responses will contain the full entity profile for the requested language responses: '200': description: Success Response content: application/json: schema: additionalProperties: false type: object properties: meta: additionalProperties: false type: object properties: uuid: minLength: 0 type: string description: Unique ID for this request / response. response: additionalProperties: false type: object properties: profiles: uniqueItems: false type: array items: additionalProperties: false type: object properties: meta: additionalProperties: false type: object properties: accountId: minLength: 0 type: string description: ID of the account associated with this Entity countryCode: minLength: 0 type: string description: |- Country code of this Entity's Language Profile (defaults to the country of the account) Filtering Type: `text` createdTimestamp: minLength: 0 type: string description: The timestamp of when the entity record was created. entityType: minLength: 0 type: string description: |- This Entity's type (e.g., location, event) Filtering Type: `text` folderId: minLength: 0 type: string description: |- The ID of the folder containing this Entity Filtering Type: `text` id: minLength: 0 type: string description: |- ID of this Entity Filtering Type: `text` labels: uniqueItems: false type: array items: minLength: 0 type: string description: 'Filtering Type: `text`' description: |- This Entity's labels. If the **`v`** parameter is before `20211215`, this will be an integer. Filtering Type: `list of text` language: minLength: 0 type: string description: |- Language code of this Entity's Language Profile (defaults to the language code of the account) Filtering Type: `text` timestamp: minLength: 0 type: string description: | The timestamp of the most recent change to this entity record. Will be ignored when the client is saving entity data to Yext. **NOTE:** The timestamp may change even if observable fields stay the same. uid: minLength: 0 type: string description: | The internal ID of the entity. This UID is a static, globally unique ID. Note that this value cannot be used in place of id in API calls to retrieve or edit Entity information. If the v param is before `20221206`, the returned value will be a hashed version of the entity UID (aka internal ID of the entity). description: |- Contains the metadata about the entity. ``` Eligible For: * atm * event * faq * healthcareFacility * healthcareProfessional * hotel * job * location * restaurant ``` name: minLength: 0 maxLength: 5000 type: string description: |- Cannot Include: * HTML markup Filtering Type: `text` ``` Eligible For: * atm * board * brand * card * contactCard * event * faq * financialProfessional * healthcareFacility * healthcareProfessional * helpArticle * hotel * hotelRoomType * job * location * organization * product * restaurant ``` address: additionalProperties: false type: object properties: city: minLength: 0 maxLength: 255 type: string description: |- The city the entity (or the entity's location) is in Cannot Include: * a URL or domain name Filtering Type: `text` countryCode: minLength: 0 pattern: ^[a-zA-Z]{2}$ type: string description: 'Filtering Type: `text`' extraDescription: minLength: 0 maxLength: 255 type: string description: |- Provides additional information to help consumers get to the entity. This string appears along with the entity's address (e.g., `In Menlo Mall, 3rd Floor`). It may also be used in conjunction with a hidden address (i.e., when **`addressHidden`** is `true`) to give consumers information about where the entity can be found (e.g., `Servicing the New York area`). Filtering Type: `text` line1: minLength: 0 maxLength: 255 type: string description: |- Cannot Include: * a URL or domain name Filtering Type: `text` line2: minLength: 0 maxLength: 255 type: string description: |- Cannot Include: * a URL or domain name Filtering Type: `text` postalCode: minLength: 0 maxLength: 10 type: string description: |- The entity's postal code. The postal code must be valid for the entity's country. Cannot include a URL or domain name. Cannot Include: * a URL or domain name Filtering Type: `text` region: minLength: 0 maxLength: 255 type: string description: |- The name of the entity's region or state. Cannot Include: * a URL or domain name Filtering Type: `text` sublocality: minLength: 0 maxLength: 255 type: string description: |- The name of the entity's sublocality Cannot Include: * a URL or domain name Filtering Type: `text` description: |- Contains the address of the entity (or where the entity is located) Must be a valid address Cannot be a P.O. Box If the entity is an `event`, either an **`address`** value or a **`linkedLocation`** value can be provided. Filtering Type: `object` ``` Eligible For: * atm * event * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` acceptingNewPatients: type: boolean description: |- Indicates whether the healthcare provider is accepting new patients. Filtering Type: `boolean` ``` Eligible For: * healthcareFacility * healthcareProfessional ``` acceptsReservations: type: boolean description: |- Indicates whether the entity accepts reservations. Filtering Type: `boolean` ``` Eligible For: * restaurant ``` accessHours: additionalProperties: false type: object properties: friday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the access hours are "closed" on Friday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is open on Friday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' holidayHours: description: |- **NOTE:** The list of Holiday Hours that you send us must be comprehensive. For example, if you send us a list of Holiday Hours that does not include Holiday Hours that you sent in your last update, Yext considers the missing Holiday Hours to be deleted, and we remove them. Array must be ordered. Filtering Type: `list of object` uniqueItems: true type: array items: required: - date additionalProperties: false type: object properties: date: format: date type: string description: |- Date on which the holiday hours will be in effect. Cannot be in the past. Date must be on or after 1970-01-01 Date must be before or on 2038-01-01 Filtering Type: `date` isClosed: type: boolean description: |- Indicates if the access hours are "closed" on on the given date. Filtering Type: `boolean` isRegularHours: type: boolean description: |- Indicates whether the holiday hours are the same as the regular business hours for the given date. If set to true, we will update the holiday hours if the regular business hours change for the date's day of the week. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is open on the specified date. Filtering Type: `list of object` description: 'Filtering Type: `object`' monday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the access hours are "closed" on Monday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is open on Monday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' reopenDate: format: date type: string description: |- Date must be on or after 1970-01-01 Date must be before or on 2038-01-01 Filtering Type: `date` saturday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the access hours are "closed" on Saturday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is open on Saturday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' sunday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the access hours are "closed" on Sunday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is open on Sunday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' thursday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the access hours are "closed" on Thursday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is open on Thursday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' tuesday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the access hours are "closed" on Tuesday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is open on Tuesday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' wednesday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the access hours are "closed" on Wednesday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is open on Wednesday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' description: |- Contains the daily access hours, holiday access hours, and reopen date for the Entity. Each day is represented by a sub-field of `accessHours`. (e.g. `monday`, `tuesday`, etc.) Open times can be specified per day through the `openIntervals` field and the `isClosed` flag. Similarly, holiday access hours are represented by the `holidayHours` sub-field. Setting the `reopenDate` sub-field indicates that the business is temporarily closed and will reopen on the specified date. SPECIAL CASES: * To indicate that an Entity is open 24 hours on a specific day, set start to 00:00 and end to 23:59 in `openIntervals` for that day. * To indicate that an Entity has split hours on a specific day (e.g., open from 9:00 AM to 12:00 PM and again from 1:00 PM to 5:00 PM), supply two or more `openIntervals` values with non-overlapping sets of hours. * If you are providing `openIntervals`, you may not set `isClosed` to true for that day. Filtering Type: `hours` ``` Eligible For: * atm * healthcareFacility * hotel * location * restaurant ``` additionalHoursText: minLength: 0 maxLength: 255 type: string description: |- Additional information about hours that does not fit in **`hours`** (e.g., `"Closed during the winter"`) Filtering Type: `text` ``` Eligible For: * atm * contactCard * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` additionalPromotingLocations: description: |- If other locations are promoting this event, a list of those locations' **`id`**s in the Yext Knowledge Manager Array must be ordered. Filtering Type: `list of entityId` ``` Eligible For: * event ``` uniqueItems: true type: array items: type: string description: 'Filtering Type: `entityId`' addressHidden: type: boolean description: |- If `true`, the entity's street address will not be shown on listings. Defaults to `false`. Filtering Type: `boolean` ``` Eligible For: * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` admittingHospitals: description: |- A list of hospitals where the healthcare professional admits patients Array must be ordered. Array may have a maximum of 100 elements. Array item description: >Cannot Include: >* HTML markup Filtering Type: `list of text` ``` Eligible For: * healthcareProfessional ``` uniqueItems: true type: array items: minLength: 0 maxLength: 100 type: string description: |- Cannot Include: * HTML markup Filtering Type: `text` adultPool: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity has a pool for adults only. Filtering Type: `option` ``` Eligible For: * hotel ``` ageRange: additionalProperties: false type: object properties: maxValue: multipleOf: 1 type: number description: |- Maximum age for the event Filtering Type: `integer` minValue: multipleOf: 1 type: number description: |- Minimum age for the event Filtering Type: `integer` description: |- Contains the age range for the event Filtering Type: `object` ``` Eligible For: * event ``` airportShuttle: enum: - AIRPORT_SHUTTLE_AVAILABLE - AIRPORT_SHUTTLE_AVAILABLE_FOR_FREE - NOT_APPLICABLE type: string description: |- Indicates whether the entity offers a shuttle to/from the airport. Filtering Type: `option` ``` Eligible For: * hotel ``` airportTransfer: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity offers a shuttle service of car service to/from nearby airports or train stations. Filtering Type: `option` ``` Eligible For: * hotel ``` allInclusive: enum: - ALL_INCLUSIVE_RATES_AVAILABLE - ALL_INCLUSIVE_RATES_ONLY - NOT_APPLICABLE type: string description: |- Indicates whether the entity offers all-inclusive rates. Filtering Type: `option` ``` Eligible For: * hotel ``` alternateNames: description: |- Other names for your business that you would like us to use when tracking your search performance Array must be ordered. Array may have a maximum of 3 elements. Array item description: >Cannot Include: >* HTML markup Filtering Type: `list of text` ``` Eligible For: * atm * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * organization * restaurant ``` uniqueItems: true type: array items: minLength: 0 maxLength: 100 type: string description: |- Cannot Include: * HTML markup Filtering Type: `text` alternatePhone: minLength: 0 type: string description: |- Must be a valid phone number. If the phone number's calling code is for a country other than the one given in the entity's **`countryCode`**, the phone number provided must contain the calling code (e.g., `+44` in `+442038083831`). Otherwise, the calling code is optional. Filtering Type: `text` ``` Eligible For: * atm * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` alternateWebsites: description: |- Other websites for your business that we should search for when tracking your search performance Array must be ordered. Array may have a maximum of 3 elements. Array item description: >Cannot Include: >* common domain names, e.g., google.com, youtube.com, etc. Filtering Type: `list of text` ``` Eligible For: * atm * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * organization * restaurant ``` uniqueItems: true type: array items: minLength: 0 maxLength: 255 format: uri type: string description: |- Cannot Include: * common domain names, e.g., google.com, youtube.com, etc. Filtering Type: `text` androidAppUrl: minLength: 0 type: string description: |- The URL where consumers can download the entity's Android app Filtering Type: `text` ``` Eligible For: * brand * financialProfessional * hotel * location * restaurant ``` answer: description: |- The answer to the frequently asked question represented by this entity Character limit: 0 .. 15000 Supported formats include: * BOLD * ITALICS * UNDERLINE * BULLETED_LIST * NUMBERED_LIST * HYPERLINK * IMAGE * CODE_SPAN * HEADINGS ``` Eligible For: * faq ``` type: string format: rich-text appleActionLinks: description: |- Use this field to add action links to your Apple Listings. The call to action category will be displayed on the action link button. The App Store URL should contain a valid link to the landing page of an App in the Apple App Store. The Quick Link URL is where a user is taken when an action link is clicked by a user. The App Name sub-field is not displayed on Apple Listings and is only used to distinguish the call-to-action type when utilizing action links in Apple posts. Array must be ordered. Filtering Type: `list of object` ``` Eligible For: * atm * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` uniqueItems: true type: array items: required: - category - quickLinkUrl - appName additionalProperties: false type: object properties: appName: minLength: 0 maxLength: 18 type: string description: 'Filtering Type: `text`' appStoreUrl: minLength: 0 maxLength: 2000 format: uri type: string description: 'Filtering Type: `text`' category: enum: - BOOK_TRAVEL - CHECK_IN - FEES_POLICIES - FLIGHT_STATUS - TICKETS - TICKETING - AMENITIES - FRONT_DESK - PARKING - GIFT_CARD - WAITLIST - DELIVERY - ORDER - TAKEOUT - PICKUP - RESERVE - MENU - APPOINTMENT - PORTFOLIO - QUOTE - SERVICES - STORE_ORDERS - STORE_SHOP - STORE_SUPPORT - SCHEDULE - SHOWTIMES - AVAILABILITY - PRICING - ACTIVITIES - BOOK - BOOK_(HOTEL) - BOOK_(RIDE) - BOOK_(TOUR) - CAREERS - CHARGE - COUPONS - DELIVERY_(RETAIL) - DONATE - EVENTS - ORDER_(RETAIL) - OTHER_MENU - PICKUP_(RETAIL) - RESERVE_(PARKING) - SHOWS - SPORTS - SUPPORT - TEE_TIME - GIFT_CARD_(RESTAURANT) type: string description: 'Filtering Type: `option`' quickLinkUrl: minLength: 0 maxLength: 2000 format: uri type: string description: 'Filtering Type: `text`' description: 'Filtering Type: `object`' appleBusinessDescription: minLength: 0 maxLength: 500 type: string description: |- The business description to be sent to Apple Filtering Type: `text` ``` Eligible For: * atm * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` appleBusinessId: minLength: 0 pattern: ^\d*\.?\d*$ type: string description: |- The ID associated with an individual Business Folder in your Apple account Filtering Type: `text` ``` Eligible For: * atm * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` appleCompanyId: minLength: 0 pattern: ^\d*\.?\d*$ type: string description: |- The ID associated with your Apple account. Numerical values only Filtering Type: `text` ``` Eligible For: * atm * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` appleCoverPhoto: required: - url additionalProperties: false type: object description: |- The cover photo for the entity''s Apple profile Image must be at least 1600 x 1040 pixels Image may be no more than 4864 x 3163 pixels Supported Aspect Ratios: * 154 x 100 **NOTE**: Maximum image size is 5mb after normalization and padding (if applicable). As well, there is a 6 second download limit from the image host. Filtering Type: `object` ``` Eligible For: * atm * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` properties: alternateText: minLength: 0 type: string description: 'Filtering Type: `text`' url: minLength: 0 format: uri type: string description: 'Filtering Type: `text`' appleDisplayName: minLength: 0 maxLength: 5000 type: string description: |- The name to be displayed on Apple for the entity. NOTE: The names of Brands and their respective Locations within an Apple Business Connect Account must match identically. Cannot Include: HTML markup Cannot Include: * HTML markup Filtering Type: `text` ``` Eligible For: * atm * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` applicationUrl: minLength: 0 format: uri type: string description: |- The application URL Filtering Type: `text` ``` Eligible For: * job ``` associations: description: |- Association memberships relevant to the entity (e.g., `"New York Doctors Association"`) All strings must be non-empty when trimmed of whitespace. Array must be ordered. Array may have a maximum of 100 elements. Array item description: >Cannot Include: >* HTML markup Filtering Type: `list of text` ``` Eligible For: * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` uniqueItems: true type: array items: minLength: 0 maxLength: 100 type: string description: |- Cannot Include: * HTML markup Filtering Type: `text` attendance: required: - attendanceMode additionalProperties: false type: object properties: attendanceMode: enum: - OFFLINE - ONLINE - MIXED type: string description: 'Filtering Type: `option`' virtualLocationUrl: minLength: 0 format: uri type: string description: 'Filtering Type: `text`' description: |- Indicates whether the event is online, offline, or a mix. A `virtualLocationUrl` must be specified for online and mixed events. Filtering Type: `object` ``` Eligible For: * event ``` attire: enum: - UNSPECIFIED - DRESSY - CASUAL - FORMAL type: string description: |- The formality of clothing typically worn at this restaurant Filtering Type: `option` ``` Eligible For: * restaurant ``` babysittingOffered: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity offers babysitting. Filtering Type: `option` ``` Eligible For: * hotel ``` baggageStorage: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity offers baggage storage pre check-in and post check-out. Filtering Type: `option` ``` Eligible For: * hotel ``` bar: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity has an indoor or outdoor bar onsite. Filtering Type: `option` ``` Eligible For: * hotel ``` beachAccess: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity has access to a beach. Filtering Type: `option` ``` Eligible For: * hotel ``` beachFrontProperty: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity is physically located next to a beach. Filtering Type: `option` ``` Eligible For: * hotel ``` bicycles: enum: - BICYCLE_RENTALS - BICYCLE_RENTALS_FOR_FREE - NOT_APPLICABLE type: string description: |- Indicates whether the entity offers bicycles for rent or for free. Filtering Type: `option` ``` Eligible For: * hotel ``` bios: additionalProperties: false type: object properties: ids: description: |- IDs of the Bio Lists associated with this entity Array must be ordered. Array may have a maximum of 40 elements. Filtering Type: `list of text` uniqueItems: true type: array items: minLength: 0 type: string description: 'Filtering Type: `text`' label: minLength: 0 maxLength: 30 type: string description: |- Label to be used for this entity's Bio Lists. This label will appear on your entity's listings. Filtering Type: `text` description: |- Information about the Bio Content Lists associated with this entity Filtering Type: `object` ``` Eligible For: * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * organization * restaurant ``` boutiqueStores: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity has a boutique store. Gift shop or convenience store are not eligible. Filtering Type: `option` ``` Eligible For: * hotel ``` brands: description: |- Brands sold by this entity All strings must be non-empty when trimmed of whitespace. Array must be ordered. Array may have a maximum of 100 elements. Array item description: >Cannot Include: >* HTML markup Filtering Type: `list of text` ``` Eligible For: * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` uniqueItems: true type: array items: minLength: 0 maxLength: 100 type: string description: |- Cannot Include: * HTML markup Filtering Type: `text` breakfast: enum: - BREAKFAST_AVAILABLE - BREAKFAST_AVAILABLE_FOR_FREE - NOT_APPLICABLE type: string description: |- Indicates whether the entity offers breakfast. Filtering Type: `option` ``` Eligible For: * hotel ``` brunchHours: additionalProperties: false type: object properties: friday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the brunch hours are "closed" on Friday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is open for brunch on Friday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' holidayHours: description: |- **NOTE:** The list of Holiday Hours that you send us must be comprehensive. For example, if you send us a list of Holiday Hours that does not include Holiday Hours that you sent in your last update, Yext considers the missing Holiday Hours to be deleted, and we remove them. Array must be ordered. Filtering Type: `list of object` uniqueItems: true type: array items: required: - date additionalProperties: false type: object properties: date: format: date type: string description: |- Date on which the holiday hours will be in effect. Cannot be in the past. Date must be on or after 1970-01-01 Date must be before or on 2038-01-01 Filtering Type: `date` isClosed: type: boolean description: |- Indicates if the brunch hours are "closed" on on the given date. Filtering Type: `boolean` isRegularHours: type: boolean description: |- Indicates whether the holiday hours are the same as the regular business hours for the given date. If set to true, we will update the holiday hours if the regular business hours change for the date's day of the week. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is open on the specified date. Filtering Type: `list of object` description: 'Filtering Type: `object`' monday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the brunch hours are "closed" on Monday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is open for brunch on Monday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' reopenDate: format: date type: string description: |- Date must be on or after 1970-01-01 Date must be before or on 2038-01-01 Filtering Type: `date` saturday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the brunch hours are "closed" on Saturday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is open for brunch on Saturday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' sunday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the brunch hours are "closed" on Sunday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is open for brunch on Sunday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' thursday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the brunch hours are "closed" on Thursday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is open for brunch on Thursday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' tuesday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the brunch hours are "closed" on Tuesday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is open for brunch on Tuesday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' wednesday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the brunch hours are "closed" on Wednesday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is open for brunch on Wednesday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' description: |- Contains the daily brunch hours, holiday brunch hours, and reopen date for the Entity. Each day is represented by a sub-field of `brunchHours`. (e.g. `monday`, `tuesday`, etc.) Open times can be specified per day through the `openIntervals` field and the `isClosed` flag. Similarly, holiday brunch hours are represented by the `holidayHours` sub-field. Setting the `reopenDate` sub-field indicates that the business is temporarily closed and will reopen on the specified date. SPECIAL CASES: * To indicate that an Entity is open 24 hours on a specific day, set start to 00:00 and end to 23:59 in `openIntervals` for that day. * To indicate that an Entity has split hours on a specific day (e.g., open from 9:00 AM to 12:00 PM and again from 1:00 PM to 5:00 PM), supply two or more `openIntervals` values with non-overlapping sets of hours. * If you are providing `openIntervals`, you may not set `isClosed` to true for that day. Filtering Type: `hours` ``` Eligible For: * hotel * location * restaurant ``` businessCenter: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity has a business center. Filtering Type: `option` ``` Eligible For: * hotel ``` calendars: additionalProperties: false type: object properties: ids: description: |- IDs of the Calendars associated with this entity Array must be ordered. Array may have a maximum of 40 elements. Filtering Type: `list of text` uniqueItems: true type: array items: minLength: 0 type: string description: 'Filtering Type: `text`' label: minLength: 0 maxLength: 30 type: string description: |- Label to be used for this entity's Calendars. This label will appear on your entity's listings. Filtering Type: `text` description: |- Information about the events Content Lists (Calendars) associated with this entity Filtering Type: `object` ``` Eligible For: * financialProfessional * healthcareFacility * hotel * location * restaurant ``` carRental: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity offers car rental. Filtering Type: `option` ``` Eligible For: * hotel ``` casino: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity has a casino on premise or nearby. Filtering Type: `option` ``` Eligible For: * hotel ``` categories: additionalProperties: false type: object properties: {} description: |- Yext Categories. (Supported for versions > 20240220) A map of category list external IDs (i.e. "yext") to a list of category IDs. IDs must be valid and selectable (i.e., cannot be parent categories). Partial updates are accepted, meaning sending only the "yext" property will have no effect on any category list except the "yext" category. Filtering Type: `object` ``` Eligible For: * atm * event * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` categoryIds: uniqueItems: false type: array items: minLength: 0 type: string description: 'Filtering Type: `text`' description: |- Yext Category IDs. (Deprecated: For versions > 20240220) 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. Filtering Type: `list of text` ``` Eligible For: * atm * event * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` catsAllowed: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates if the entity is cat friendly. Filtering Type: `option` ``` Eligible For: * hotel ``` certifications: description: |- A list of the certifications held by the healthcare professional **NOTE:** This field is only available to locations whose **`entityType`** is `healthcareProfessional`. Array must be ordered. Array may have a maximum of 100 elements. Array item description: >Cannot Include: >* HTML markup Filtering Type: `list of text` ``` Eligible For: * financialProfessional * healthcareProfessional ``` uniqueItems: true type: array items: minLength: 0 maxLength: 200 type: string description: |- Cannot Include: * HTML markup Filtering Type: `text` checkInTime: format: time type: string description: |- The check-in time Filtering Type: `time` ``` Eligible For: * hotel ``` checkOutTime: format: time type: string description: |- The check-out time Filtering Type: `time` ``` Eligible For: * hotel ``` classificationRating: pattern: ^\d*\.?\d*$ type: string description: |- The 1 to 5 star rating of the entitiy based on its services and facilities. Filtering Type: `decimal` ``` Eligible For: * hotel ``` closed: type: boolean description: |- Indicates whether the entity is closed Filtering Type: `boolean` ``` Eligible For: * atm * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` concierge: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity offers concierge service. Filtering Type: `option` ``` Eligible For: * hotel ``` conditionsTreated: description: |- A list of the conditions treated by the healthcare provider Array must be ordered. Array may have a maximum of 100 elements. Array item description: >Cannot Include: >* HTML markup Filtering Type: `list of text` ``` Eligible For: * healthcareFacility * healthcareProfessional ``` uniqueItems: true type: array items: minLength: 0 maxLength: 100 type: string description: |- Cannot Include: * HTML markup Filtering Type: `text` convenienceStore: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity has a convenience store. Filtering Type: `option` ``` Eligible For: * hotel ``` covidMessaging: minLength: 0 maxLength: 15000 type: string description: |- Information or messaging related to COVID-19. Filtering Type: `text` ``` Eligible For: * healthcareFacility * healthcareProfessional * location ``` covidTestAppointmentUrl: minLength: 0 format: uri type: string description: |- An appointment URL for scheduling a COVID-19 test. Filtering Type: `text` ``` Eligible For: * healthcareFacility * location ``` covidTestingAppointmentRequired: type: boolean description: |- Indicates whether an appointment is required for a COVID-19 test. Filtering Type: `boolean` ``` Eligible For: * healthcareFacility * location ``` covidTestingDriveThroughSite: type: boolean description: |- Indicates whether location is a drive-through site for COVID-19 tests. Filtering Type: `boolean` ``` Eligible For: * healthcareFacility * location ``` covidTestingIsFree: type: boolean description: |- Indicates whether location offers free COVID-19 testing. Filtering Type: `boolean` ``` Eligible For: * healthcareFacility * location ``` covidTestingPatientRestrictions: type: boolean description: |- Indicates whether there are patient restrictions for COVID-19 testing. Filtering Type: `boolean` ``` Eligible For: * healthcareFacility * location ``` covidTestingReferralRequired: type: boolean description: |- Indicates whether a referral is required for COVID-19 testing. Filtering Type: `boolean` ``` Eligible For: * healthcareFacility * location ``` covidTestingSiteInstructions: minLength: 0 maxLength: 15000 type: string description: |- Information or instructions for the COVID-19 testing site. Filtering Type: `text` ``` Eligible For: * healthcareFacility * location ``` covidVaccineAppointmentRequired: type: boolean description: |- Indicates whether an appointment is required for a COVID-19 vaccine. Filtering Type: `boolean` ``` Eligible For: * healthcareFacility * location ``` covidVaccineDriveThroughSite: type: boolean description: |- Indicates whether location is a drive-through site for COVID-19 vaccines. Filtering Type: `boolean` ``` Eligible For: * healthcareFacility * location ``` covidVaccineInformationUrl: minLength: 0 format: uri type: string description: |- An information URL for more information about COVID-19 vaccines. Filtering Type: `text` ``` Eligible For: * healthcareFacility * location ``` covidVaccinePatientRestrictions: type: boolean description: |- Indicates whether there are patient restrictions for a COVID-19 vaccine. Filtering Type: `boolean` ``` Eligible For: * healthcareFacility * location ``` covidVaccineReferralRequired: type: boolean description: |- Indicates whether a referral is required for a COVID-19 vaccine. Filtering Type: `boolean` ``` Eligible For: * healthcareFacility * location ``` covidVaccineSiteInstructions: minLength: 0 maxLength: 15000 type: string description: |- Information or instructions for the COVID-19 vaccination site. Filtering Type: `text` ``` Eligible For: * healthcareFacility * location ``` covidVaccinesOffered: uniqueItems: true type: array items: enum: - PFIZER - MODERNA - JOHNSON_&_JOHNSON type: string description: 'Filtering Type: `option`' description: |- Indicates which COVID-19 vaccines the location offers. Filtering Type: `list of option` ``` Eligible For: * healthcareFacility * location ``` currencyExchange: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity offers currency exchange services. Filtering Type: `option` ``` Eligible For: * hotel ``` customKeywords: description: |- Additional keywords you would like us to use when tracking your search performance Array must be ordered. Array may have a maximum of 5 elements. Filtering Type: `list of text` ``` Eligible For: * atm * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * organization * restaurant ``` uniqueItems: true type: array items: minLength: 0 maxLength: 100 type: string description: 'Filtering Type: `text`' datePosted: format: date type: string description: |- The date this entity was posted Filtering Type: `date` ``` Eligible For: * job ``` degrees: description: |- A list of the degrees earned by the healthcare professional Array must be ordered. Filtering Type: `list of option` ``` Eligible For: * healthcareProfessional ``` uniqueItems: true type: array items: enum: - ANP - APN - APRN - ARNP - AUD - BSW - CCCA - CNM - CNP - CNS - CPNP - CRNA - CRNP - DC - DDS - DMD - DNP - DO - DPM - DPT - DSW - DVM - FNP - GNP - LAC - LCSW - LPN - MBA - MBBS - MD - MPAS - MPH - MSW - ND - NNP - NP - OD - PA - PAC - PHARMD - PHD - PNP - PSYD - RD - RSW - VMD - WHNP type: string description: 'Filtering Type: `option`' deliveryHours: additionalProperties: false type: object properties: friday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the delivery hours are "closed" on Friday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is delivering on Friday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' holidayHours: description: |- **NOTE:** The list of Holiday Hours that you send us must be comprehensive. For example, if you send us a list of Holiday Hours that does not include Holiday Hours that you sent in your last update, Yext considers the missing Holiday Hours to be deleted, and we remove them. Array must be ordered. Filtering Type: `list of object` uniqueItems: true type: array items: required: - date additionalProperties: false type: object properties: date: format: date type: string description: |- Date on which the holiday hours will be in effect. Cannot be in the past. Date must be on or after 1970-01-01 Date must be before or on 2038-01-01 Filtering Type: `date` isClosed: type: boolean description: |- Indicates if the delivery hours are "closed" on on the given date. Filtering Type: `boolean` isRegularHours: type: boolean description: |- Indicates whether the holiday hours are the same as the regular business hours for the given date. If set to true, we will update the holiday hours if the regular business hours change for the date's day of the week. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is delivering on the specified date. Filtering Type: `list of object` description: 'Filtering Type: `object`' monday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the delivery hours are "closed" on Monday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is delivering on Monday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' reopenDate: format: date type: string description: |- Date must be on or after 1970-01-01 Date must be before or on 2038-01-01 Filtering Type: `date` saturday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the delivery hours are "closed" on Saturday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is delivering on Saturday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' sunday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the delivery hours are "closed" on Sunday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is delivering on Sunday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' thursday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the delivery hours are "closed" on Thursday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is delivering on Thursday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' tuesday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the delivery hours are "closed" on Tuesday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is delivering on Tuesday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' wednesday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the delivery hours are "closed" on Wednesday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is delivering on Wednesday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' description: |- Contains the daily delivery hours, holiday delivery hours, and reopen date for the Entity. Each day is represented by a sub-field of `deliveryHours`. (e.g. `monday`, `tuesday`, etc.) Open times can be specified per day through the `openIntervals` field and the `isClosed` flag. Similarly, holiday delivery hours are represented by the `holidayHours` sub-field. Setting the `reopenDate` sub-field indicates that the business is temporarily closed and will reopen on the specified date. SPECIAL CASES: * To indicate that an Entity is open 24 hours on a specific day, set start to 00:00 and end to 23:59 in `openIntervals` for that day. * To indicate that an Entity has split hours on a specific day (e.g., open from 9:00 AM to 12:00 PM and again from 1:00 PM to 5:00 PM), supply two or more `openIntervals` values with non-overlapping sets of hours. * If you are providing `openIntervals`, you may not set `isClosed` to true for that day. Filtering Type: `hours` ``` Eligible For: * location * restaurant ``` description: minLength: 10 maxLength: 15000 type: string description: |- A description of the entity Cannot Include: * HTML markup Filtering Type: `text` ``` Eligible For: * atm * contactCard * event * financialProfessional * healthcareFacility * healthcareProfessional * hotel * job * location * organization * restaurant ``` displayCoordinate: additionalProperties: false type: object properties: latitude: minimum: -90 maximum: 90 type: number description: 'Filtering Type: `float`' longitude: minimum: -180 maximum: 180 type: number description: 'Filtering Type: `float`' description: |- Coordinates where the map pin for the entity should be displayed, as provided by you Filtering Type: `object` ``` Eligible For: * atm * event * financialProfessional * healthcareFacility * healthcareProfessional * hotel * job * location * restaurant ``` doctorOnCall: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity has a doctor on premise or on call. Filtering Type: `option` ``` Eligible For: * hotel ``` dogsAllowed: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates if the entity is dog friendly. Filtering Type: `option` ``` Eligible For: * hotel ``` driveThroughHours: additionalProperties: false type: object properties: friday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the drive-through hours are "closed" on Friday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity's drive-through is open on Friday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' holidayHours: description: |- **NOTE:** The list of Holiday Hours that you send us must be comprehensive. For example, if you send us a list of Holiday Hours that does not include Holiday Hours that you sent in your last update, Yext considers the missing Holiday Hours to be deleted, and we remove them. Array must be ordered. Filtering Type: `list of object` uniqueItems: true type: array items: required: - date additionalProperties: false type: object properties: date: format: date type: string description: |- Date on which the holiday hours will be in effect. Cannot be in the past. Date must be on or after 1970-01-01 Date must be before or on 2038-01-01 Filtering Type: `date` isClosed: type: boolean description: |- Indicates if the drive-through hours are "closed" on on the given date. Filtering Type: `boolean` isRegularHours: type: boolean description: |- Indicates whether the holiday hours are the same as the regular business hours for the given date. If set to true, we will update the holiday hours if the regular business hours change for the date's day of the week. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity's drive-through is open on the specified date. Filtering Type: `list of object` description: 'Filtering Type: `object`' monday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the drive-through hours are "closed" on Monday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity's drive-through is open on Monday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' reopenDate: format: date type: string description: |- Date must be on or after 1970-01-01 Date must be before or on 2038-01-01 Filtering Type: `date` saturday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the drive-through hours are "closed" on Saturday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity's drive-through is open on Saturday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' sunday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the drive-through hours are "closed" on Sunday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity's drive-through is open on Sunday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' thursday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the drive-through hours are "closed" on Thursday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity's drive-through is open on Thursday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' tuesday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the drive-through hours are "closed" on Tuesday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity's drive-through is open on Tuesday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' wednesday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the drive-through hours are "closed" on Wednesday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity's drive-through is open on Wednesday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' description: |- Contains the daily drive-through hours, holiday drive-through hours, and reopen date for the Entity. Each day is represented by a sub-field of `driveThroughHours`. (e.g. `monday`, `tuesday`, etc.) Open times can be specified per day through the `openIntervals` field and the `isClosed` flag. Similarly, holiday drive-through hours are represented by the `holidayHours` sub-field. Setting the `reopenDate` sub-field indicates that the business is temporarily closed and will reopen on the specified date. SPECIAL CASES: * To indicate that an Entity is open 24 hours on a specific day, set start to 00:00 and end to 23:59 in `openIntervals` for that day. * To indicate that an Entity has split hours on a specific day (e.g., open from 9:00 AM to 12:00 PM and again from 1:00 PM to 5:00 PM), supply two or more `openIntervals` values with non-overlapping sets of hours. * If you are providing `openIntervals`, you may not set `isClosed` to true for that day. Filtering Type: `hours` ``` Eligible For: * atm * location * restaurant ``` dropoffCoordinate: additionalProperties: false type: object properties: latitude: minimum: -90 maximum: 90 type: number description: 'Filtering Type: `float`' longitude: minimum: -180 maximum: 180 type: number description: 'Filtering Type: `float`' description: |- Coordinates of the drop-off area for the entity, as provided by you Filtering Type: `object` ``` Eligible For: * atm * event * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` educationList: description: |- Information about the education or training completed by the healthcare professional Array must be ordered. Filtering Type: `list of object` ``` Eligible For: * healthcareProfessional ``` uniqueItems: true type: array items: required: - type - institutionName - yearCompleted additionalProperties: false type: object properties: institutionName: minLength: 0 maxLength: 100 type: string description: 'Filtering Type: `text`' type: enum: - FELLOWSHIP - RESIDENCY - INTERNSHIP - MEDICAL_SCHOOL type: string description: 'Filtering Type: `option`' yearCompleted: multipleOf: 1 minimum: 1900 maximum: 2100 type: number description: 'Filtering Type: `integer`' description: 'Filtering Type: `object`' electricChargingStation: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity has electric car chargine stations on premise. Filtering Type: `option` ``` Eligible For: * hotel ``` elevator: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity has an elevator. Filtering Type: `option` ``` Eligible For: * hotel ``` ellipticalMachine: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity has an elliptical machine. Filtering Type: `option` ``` Eligible For: * hotel ``` emails: description: |- Emails addresses for this entity's point of contact Must be valid email addresses Array must be ordered. Array may have a maximum of 5 elements. Filtering Type: `list of text` ``` Eligible For: * contactCard * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * organization * restaurant ``` uniqueItems: true type: array items: minLength: 0 format: email type: string description: 'Filtering Type: `text`' employmentType: enum: - FULL_TIME - PART_TIME - CONTRACTOR - TEMPORARY - INTERN - VOLUNTEER - PER_DIEM - OTHER type: string description: |- The employment type for the open job. Indicates whether the job is full-time, part-time, temporary, etc. Filtering Type: `option` ``` Eligible For: * job ``` eventStatus: enum: - SCHEDULED - RESCHEDULED - POSTPONED - CANCELED - EVENT_MOVED_ONLINE type: string description: |- Information on whether the event will take place as scheduled Filtering Type: `option` ``` Eligible For: * event ``` facebookAbout: minLength: 0 maxLength: 255 type: string description: |- A description of the entity to be used in the "About You" section on Facebook Filtering Type: `text` ``` Eligible For: * atm * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` facebookCallToAction: required: - type additionalProperties: false type: object properties: type: enum: - NONE - BOOK_NOW - CALL_NOW - CONTACT_US - SEND_MESSAGE - USE_APP - PLAY_GAME - SHOP_NOW - SIGN_UP - WATCH_VIDEO - SEND_EMAIL - LEARN_MORE - PURCHASE_GIFT_CARDS - ORDER_NOW - FOLLOW_PAGE type: string description: |- The action the consumer is being prompted to take by the button's text Filtering Type: `option` value: minLength: 0 type: string description: |- Indicates where consumers will be directed to upon clicking the Call-to-Action button (e.g., a URL). It can be a free-form string or an embedded value, depending on what the user specifies. For example, if the user sets the Facebook Call-to-Action as " 'Sign Up' using 'Website URL' " in the Yext platform, **`type`** will be `SIGN_UP` and **`value`** will be `[[websiteUrl]]`. The Call-to-Action will have the same behavior if the user sets the value to "Custom Value" in the platform and embeds a field. Filtering Type: `text` description: |- Designates the Facebook Call-to-Action button text and value Valid contents of **`value`** depends on the Call-to-Action's **`type`**: * `NONE`: (optional) * `BOOK_NOW`: URL * `CALL_NOW`: Phone number * `CONTACT_US`: URL * `SEND_MESSAGE`: Any string * `USE_APP`: URL * `PLAY_GAME`: URL * `SHOP_NOW`: URL * `SIGN_UP`: URL * `WATCH_VIDEO`: URL * `SEND_EMAIL`: Email address * `LEARN_MORE`: URL * `PURCHASE_GIFT_CARDS`: URL * `ORDER_NOW`: URL * `FOLLOW_PAGE`: Any string Filtering Type: `object` ``` Eligible For: * atm * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` facebookCoverPhoto: required: - url additionalProperties: false type: object description: |- The cover photo for the entity's Facebook profile Displayed as a 851 x 315 pixel image You may need a cover photo in order for your listing to appear on Facebook. Please check your listings tab to learn more. Image must be at least 400 x 150 pixels Image area (width x height) may be no more than 41000000 pixels Image may be no more than 30000 x 30000 pixels Supported Aspect Ratios: * 1 x 1 * 4 x 3 * 3 x 2 * 5 x 3 * 16 x 9 * 3 x 1 * 2 x 3 * 5 x 7 * 4 x 5 * 4 x 1 **NOTE**: Maximum image size is 5mb after normalization and padding (if applicable). As well, there is a 6 second download limit from the image host. Filtering Type: `object` ``` Eligible For: * atm * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` properties: alternateText: minLength: 0 type: string description: 'Filtering Type: `text`' url: minLength: 0 format: uri type: string description: 'Filtering Type: `text`' facebookDescriptor: minLength: 3 maxLength: 75 type: string description: |- Location Descriptors are used for Enterprise businesses that sync Facebook listings using brand page location structure. The Location Descriptor is typically an additional geographic description (e.g. geomodifier) that will appear in parentheses after the name on the Facebook listing. Cannot Include: * HTML markup Filtering Type: `text` ``` Eligible For: * atm * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` facebookName: minLength: 0 type: string description: |- The name for this entity's Facebook profile. A separate name may be specified to send only to Facebook in order to comply with any specific Facebook rules or naming conventions. Filtering Type: `text` ``` Eligible For: * atm * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` facebookOverrideCity: minLength: 0 type: string description: |- The city to be displayed on this entity's Facebook profile Filtering Type: `text` ``` Eligible For: * atm * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` facebookPageUrl: minLength: 0 type: string description: |- URL for the entity's Facebook Page. Valid formats: - facebook.com/profile.php?id=[numId] - facebook.com/group.php?gid=[numId] - facebook.com/groups/[numId] - facebook.com/[Name] - facebook.com/pages/[Name]/[numId] - facebook.com/people/[Name]/[numId] where [Name] is a String and [numId] is an Integer The success response will contain a warning message explaining why the URL wasn't stored in the system. Filtering Type: `text` ``` Eligible For: * atm * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * organization * restaurant ``` facebookParentPageId: minLength: 0 maxLength: 65 type: string description: |- The Facebook Page ID of this entity's brand page if in a brand page location structure Filtering Type: `text` ``` Eligible For: * atm * brand * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` facebookProfilePhoto: required: - url additionalProperties: false type: object description: |- The profile picture for the entity's Facebook profile You must have a profile picture in order for your listing to appear on Facebook. Image must be at least 180 x 180 pixels Image area (width x height) may be no more than 41000000 pixels Image may be no more than 30000 x 30000 pixels Supported Aspect Ratios: * 1 x 1 * 4 x 3 * 3 x 2 * 5 x 3 * 16 x 9 * 3 x 1 * 2 x 3 * 5 x 7 * 4 x 5 * 4 x 1 **NOTE**: Maximum image size is 5mb after normalization and padding (if applicable). As well, there is a 6 second download limit from the image host. Filtering Type: `object` ``` Eligible For: * atm * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` properties: alternateText: minLength: 0 type: string description: 'Filtering Type: `text`' url: minLength: 0 format: uri type: string description: 'Filtering Type: `text`' facebookStoreId: minLength: 0 type: string description: |- The Store ID used for this entity in a brand page location structure Filtering Type: `text` ``` Eligible For: * atm * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` facebookVanityUrl: minLength: 0 maxLength: 50 type: string description: |- The username that appear's in the Facebook listing URL to help customers find and remember a brand’s Facebook page. The username is also be used for tagging the Facebook page in other users’ posts, and searching for the Facebook page. Filtering Type: `text` ``` Eligible For: * atm * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` facebookWebsiteOverride: minLength: 0 format: uri type: string description: |- The URL you would like to submit to Facebook in place of the one given in **`websiteUrl`** (if applicable). Filtering Type: `text` ``` Eligible For: * atm * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` fax: minLength: 0 type: string description: |- Must be a valid fax number. If the fax number's calling code is for a country other than the one given in the entity's **`countryCode`**, the fax number provided must contain the calling code (e.g., `+44` in `+442038083831`). Otherwise, the calling code is optional. Filtering Type: `text` ``` Eligible For: * atm * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` featuredMessage: additionalProperties: false type: object properties: description: minLength: 0 maxLength: 50 type: string description: |- The text of Featured Message. Default: `Call today!` Cannot include: - inappropriate language - HTML markup - a URL or domain name - a phone number - control characters ([\x00-\x1F\x7F]) - insufficient spacing If you submit a Featured Message that contains profanity or more than 50 characters, it will be ignored. The success response will contain a warning message explaining why your Featured Message wasn't stored in the system. Cannot Include: * HTML markup Filtering Type: `text` url: minLength: 0 maxLength: 255 format: uri type: string description: |- Valid URL linked to the Featured Message text Filtering Type: `text` description: |- Information about the entity's Featured Message Filtering Type: `object` ``` Eligible For: * atm * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` firstName: minLength: 0 maxLength: 35 type: string description: |- The first name of the healthcare professional Cannot Include: * a URL or domain name * HTML markup Filtering Type: `text` ``` Eligible For: * healthcareProfessional ``` firstPartyReviewPage: minLength: 0 type: string description: |- Link to the review-collection page, where consumers can leave first-party reviews ``` Eligible For: * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` fitnessCenter: enum: - FITNESS_CENTER_AVAILABLE - FITNESS_CENTER_AVAILABLE_FOR_FREE - NOT_APPLICABLE type: string description: |- Indicates whether the entity has a fitness center. Filtering Type: `option` ``` Eligible For: * hotel ``` floorCount: multipleOf: 1 minimum: 0 type: number description: |- The number of floors the entity has from ground floor to top floor. Filtering Type: `integer` ``` Eligible For: * hotel ``` freeWeights: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity has free weights. Filtering Type: `option` ``` Eligible For: * hotel ``` frequentlyAskedQuestions: description: |- A list of questions that are frequently asked about this entity Array must be ordered. Array may have a maximum of 100 elements. Filtering Type: `list of object` ``` Eligible For: * atm * event * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` uniqueItems: true type: array items: required: - question additionalProperties: false type: object properties: answer: minLength: 1 maxLength: 4096 type: string description: 'Filtering Type: `text`' question: minLength: 1 maxLength: 4096 type: string description: 'Filtering Type: `text`' description: 'Filtering Type: `object`' frontDesk: enum: - FRONT_DESK_AVAILABLE - FRONT_DESK_AVAILABLE_24_HOURS - NOT_APPLICABLE type: string description: |- Indicates whether the entity has a front desk. Filtering Type: `option` ``` Eligible For: * hotel ``` fullyVaccinatedStaff: type: boolean description: |- Indicates whether the staff is vaccinated against COVID-19. Filtering Type: `boolean` ``` Eligible For: * healthcareFacility * hotel * location * restaurant ``` gameRoom: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity has a game room. Filtering Type: `option` ``` Eligible For: * hotel ``` gender: enum: - UNSPECIFIED - FEMALE - MALE - NONBINARY - TRANSGENDER_FEMALE - TRANSGENDER_MALE - OTHER - PREFER_NOT_TO_DISCLOSE type: string description: |- The gender of the healthcare professional Filtering Type: `option` ``` Eligible For: * healthcareProfessional ``` geomodifier: minLength: 0 type: string description: |- Provides additional information on where the entity can be found (e.g., `Times Square`, `Global Center Mall`) Filtering Type: `text` ``` Eligible For: * atm * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` giftShop: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity has a gift shop. Filtering Type: `option` ``` Eligible For: * hotel ``` golf: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity has a golf couse on premise or nearby. The golf course may be independently run. Filtering Type: `option` ``` Eligible For: * hotel ``` googleAttributes: additionalProperties: false type: object properties: {} description: |- The unique IDs of the entity's Google Business Profile keywords, as well as the unique IDs of any values selected for each keyword. Valid keywords (e.g., `has_drive_through`, `has_fitting_room`, `kitchen_in_room`) are determined by the entity's primary category. A full list of keywords can be retrieved with the Google Fields: List endpoint. Keyword values provide more details on how the keyword applies to the entity (e.g., if the keyword is `has_drive_through`, its values may be `true` or `false`). * If the **`v`** parameter is before `20181204`: **`googleAttributes`** is formatted as a map of key-value pairs (e.g., `[{ "id": "has_wheelchair_accessible_entrance", "values": [ "true" ] }]`) * If the **`v`** parameter is on or after `20181204`: the contents are formatted as a list of objects (e.g., `{ "has_wheelchair_accessible_entrance": [ "true" ]}`) **NOTE:** The latest Google Attributes are available via the Google Fields: List endpoint. Google Attributes are managed by Google and are subject to change without notice. To prevent errors, make sure your API implementation is not dependent on the presence of specific attributes. Filtering Type: `object` ``` Eligible For: * atm * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` googleCoverPhoto: required: - url additionalProperties: false type: object description: |- The cover photo for the entity's Google profile Image must be at least 250 x 250 pixels Filtering Type: `object` ``` Eligible For: * atm * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` properties: alternateText: minLength: 0 type: string description: 'Filtering Type: `text`' url: minLength: 0 format: uri type: string description: 'Filtering Type: `text`' googleMessaging: additionalProperties: false type: object properties: smsNumber: minLength: 0 type: string description: |- The SMS phone number of the entity's point of contact for messaging/ chat functionality. Must be a valid phone number. If the phone number's calling code is for a country other than the one given in the entity's countryCode, the phone number provided must contain the calling code (e.g., +44 in +442038083831). Otherwise, the calling code is optional. Filtering Type: `text` whatsappMessagingUrl: minLength: 0 maxLength: 2000 format: uri type: string description: |- A valid URL for this entity's WhatsApp account. Must be a valid URL Filtering Type: `text` description: |- Information about Google Messaging, WhatsApp and SMS, for the entity’s point of contact for messaging/chat functionality. NOTE: Only one, either WhatsApp or SMS is displayed on the Google listing. If both SMS Number and WhatsApp URL are provided only SMS Number will be displayed on the listing. Filtering Type: `object` ``` Eligible For: * atm * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` googleMyBusinessLabels: description: |- Google Business Profile Labels help users organize their locations into groups within GBP. Array must be ordered. Array may have a maximum of 10 elements. Array item description: >Cannot Include: >* HTML markup Filtering Type: `list of text` ``` Eligible For: * atm * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` uniqueItems: true type: array items: minLength: 0 maxLength: 50 type: string description: |- Cannot Include: * HTML markup Filtering Type: `text` googlePlaceId: minLength: 0 type: string description: |- The unique identifier of this entity on Google Maps. Filtering Type: `text` ``` Eligible For: * atm * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` googleProfilePhoto: required: - url additionalProperties: false type: object description: |- The profile photo for the entity's Google profile Image must be at least 250 x 250 pixels Image may be no more than 5000 x 5000 pixels Supported Aspect Ratios: * 1 x 1 **NOTE**: Maximum image size is 5mb after normalization and padding (if applicable). As well, there is a 6 second download limit from the image host. Filtering Type: `object` ``` Eligible For: * atm * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` properties: alternateText: minLength: 0 type: string description: 'Filtering Type: `text`' url: minLength: 0 format: uri type: string description: 'Filtering Type: `text`' googleWebsiteOverride: minLength: 0 format: uri type: string description: |- 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. Filtering Type: `text` ``` Eligible For: * atm * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` happyHours: additionalProperties: false type: object properties: friday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the happy hours are "closed" on Friday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity's happy hours on Friday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' holidayHours: description: |- **NOTE:** The list of Holiday Hours that you send us must be comprehensive. For example, if you send us a list of Holiday Hours that does not include Holiday Hours that you sent in your last update, Yext considers the missing Holiday Hours to be deleted, and we remove them. Array must be ordered. Filtering Type: `list of object` uniqueItems: true type: array items: required: - date additionalProperties: false type: object properties: date: format: date type: string description: |- Date on which the holiday hours will be in effect. Cannot be in the past. Date must be on or after 1970-01-01 Date must be before or on 2038-01-01 Filtering Type: `date` isClosed: type: boolean description: |- Indicates if the happy hours are "closed" on on the given date. Filtering Type: `boolean` isRegularHours: type: boolean description: |- Indicates whether the holiday hours are the same as the regular business hours for the given date. If set to true, we will update the holiday hours if the regular business hours change for the date's day of the week. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for the Entity's happy hours on the specified date. Filtering Type: `list of object` description: 'Filtering Type: `object`' monday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the happy hours are "closed" on Monday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for the Entity's happy hours on Monday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' reopenDate: format: date type: string description: |- Date must be on or after 1970-01-01 Date must be before or on 2038-01-01 Filtering Type: `date` saturday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the happy hours are "closed" on Saturday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for the Entity's happy hours on Saturday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' sunday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the happy hours are "closed" on Sunday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for the Entity's happy hours on Sunday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' thursday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the happy hours are "closed" on Thursday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for the Entity's happy hours on Thursday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' tuesday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the happy hours are "closed" on Tuesday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for the Entity's happy hours on Tuesday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' wednesday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the happy hours are "closed" on Wednesday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for the Entity's happy hours on Wednesday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' description: |- Contains the daily happy hours, holiday happy hours, and reopen date for the Entity. Each day is represented by a sub-field of `happyHours`. (e.g. `monday`, `tuesday`, etc.) Open times can be specified per day through the `openIntervals` field and the `isClosed` flag. Similarly, holiday happy hours are represented by the `holidayHours` sub-field. Setting the `reopenDate` sub-field indicates that the business is temporarily closed and will reopen on the specified date. SPECIAL CASES: * To indicate that an Entity is open 24 hours on a specific day, set start to 00:00 and end to 23:59 in `openIntervals` for that day. * To indicate that an Entity has split hours on a specific day (e.g., open from 9:00 AM to 12:00 PM and again from 1:00 PM to 5:00 PM), supply two or more `openIntervals` values with non-overlapping sets of hours. * If you are providing `openIntervals`, you may not set `isClosed` to true for that day. Filtering Type: `hours` ``` Eligible For: * hotel * location * restaurant ``` headshot: required: - url additionalProperties: false type: object description: |- A portrait of the healthcare professional Filtering Type: `object` ``` Eligible For: * contactCard * financialProfessional * healthcareProfessional ``` properties: alternateText: minLength: 0 type: string description: 'Filtering Type: `text`' url: minLength: 0 format: uri type: string description: 'Filtering Type: `text`' hiringOrganization: minLength: 0 type: string description: |- The organization that is hiring for the open job Filtering Type: `text` ``` Eligible For: * job ``` holidayHoursConversationEnabled: type: boolean description: |- Indicates whether holiday-hour confirmation alerts are enabled for the Yext Knowledge Assistant for this entity Filtering Type: `boolean` ``` Eligible For: * atm * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` horsebackRiding: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity offers horseback riding. Filtering Type: `option` ``` Eligible For: * hotel ``` hotTub: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity has a hot tub. Filtering Type: `option` ``` Eligible For: * hotel ``` hours: additionalProperties: false type: object properties: friday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the hours of operation are "closed" on Friday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is open on Friday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' holidayHours: description: |- **NOTE:** The list of Holiday Hours that you send us must be comprehensive. For example, if you send us a list of Holiday Hours that does not include Holiday Hours that you sent in your last update, Yext considers the missing Holiday Hours to be deleted, and we remove them. Array must be ordered. Filtering Type: `list of object` uniqueItems: true type: array items: required: - date additionalProperties: false type: object properties: date: format: date type: string description: |- Date on which the holiday hours will be in effect. Cannot be in the past. Date must be on or after 1970-01-01 Date must be before or on 2038-01-01 Filtering Type: `date` isClosed: type: boolean description: |- Indicates if the hours of operation are "closed" on on the given date. Filtering Type: `boolean` isRegularHours: type: boolean description: |- Indicates whether the holiday hours are the same as the regular business hours for the given date. If set to true, we will update the holiday hours if the regular business hours change for the date's day of the week. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is open on the specified date. Filtering Type: `list of object` description: 'Filtering Type: `object`' monday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the hours of operation are "closed" on Monday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is open on Monday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' reopenDate: format: date type: string description: |- Date must be on or after 1970-01-01 Date must be before or on 2038-01-01 Filtering Type: `date` saturday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the hours of operation are "closed" on Saturday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is open on Saturday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' sunday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the hours of operation are "closed" on Sunday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is open on Sunday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' thursday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the hours of operation are "closed" on Thursday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is open on Thursday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' tuesday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the hours of operation are "closed" on Tuesday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is open on Tuesday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' wednesday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the hours of operation are "closed" on Wednesday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is open on Wednesday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' description: |- Contains the daily hours, holiday hours, and reopen date for the Entity. Each day is represented by a sub-field of `hours`. (e.g. `monday`, `tuesday`, etc.) Open times can be specified per day through the `openIntervals` field and the `isClosed` flag. Similarly, holiday hours are represented by the `holidayHours` sub-field. Setting the `reopenDate` sub-field indicates that the business is temporarily closed and will reopen on the specified date. SPECIAL CASES: * To indicate that an Entity is open 24 hours on a specific day, set start to 00:00 and end to 23:59 in `openIntervals` for that day. * To indicate that an Entity has split hours on a specific day (e.g., open from 9:00 AM to 12:00 PM and again from 1:00 PM to 5:00 PM), supply two or more `openIntervals` values with non-overlapping sets of hours. * If you are providing `openIntervals`, you may not set `isClosed` to true for that day. Filtering Type: `hours` ``` Eligible For: * atm * contactCard * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` housekeeping: enum: - HOUSEKEEPING_AVAILABLE - HOUSEKEEPING_AVAILABLE_DAILY - NOT_APPLICABLE type: string description: |- Indicates whether the entity offers housekeeping services. Filtering Type: `option` ``` Eligible For: * hotel ``` impressum: minLength: 0 maxLength: 2000 type: string description: |- A statement of the ownership and authorship of a document. Individuals or organizations based in many German-speaking countries are required by law to include an Impressum in published media. Filtering Type: `text` ``` Eligible For: * atm * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` indoorPoolCount: multipleOf: 1 minimum: 0 type: number description: |- A count of the number of indoor pools Filtering Type: `integer` ``` Eligible For: * hotel ``` instagramHandle: minLength: 0 maxLength: 30 type: string description: |- Valid Instagram username for the entity without the leading "@" (e.g., `NewCityAuto`) Filtering Type: `text` ``` Eligible For: * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * organization * restaurant ``` insuranceAccepted: description: |- A list of insurance policies accepted by the healthcare provider Array must be ordered. Array may have a maximum of 100 elements. Array item description: >Cannot Include: >* HTML markup Filtering Type: `list of text` ``` Eligible For: * healthcareFacility * healthcareProfessional ``` uniqueItems: true type: array items: minLength: 0 maxLength: 100 type: string description: |- Cannot Include: * HTML markup Filtering Type: `text` iosAppUrl: minLength: 0 type: string description: |- The URL where consumers can download the entity's app to their iPhone or iPad Filtering Type: `text` ``` Eligible For: * brand * financialProfessional * hotel * location * restaurant ``` isClusterPrimary: type: boolean description: |- Indicates whether the healthcare entity is the primary entity in its group Filtering Type: `boolean` ``` Eligible For: * healthcareProfessional ``` isFreeEvent: type: boolean description: |- Indicates whether or not the event is free Filtering Type: `boolean` ``` Eligible For: * event ``` isoRegionCode: minLength: 0 type: string description: |- The ISO 3166-2 region code for the entity Yext will determine the entity's code and update **`isoRegionCode`** with that value. If Yext is unable to determine the code for the entity, the entity'ss ISO 3166-1 alpha-2 country code will be used. Filtering Type: `text` ``` Eligible For: * atm * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` keywords: description: |- Keywords that describe the entity. All strings must be non-empty when trimmed of whitespace. Array must be ordered. Array may have a maximum of 100 elements. Array item description: >Cannot Include: >* HTML markup Filtering Type: `list of text` ``` Eligible For: * atm * card * event * faq * financialProfessional * healthcareFacility * healthcareProfessional * helpArticle * hotel * job * location * product * restaurant ``` uniqueItems: true type: array items: minLength: 0 maxLength: 100 type: string description: |- Cannot Include: * HTML markup Filtering Type: `text` kidFriendly: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates if the entity is kid friendly. Filtering Type: `option` ``` Eligible For: * hotel ``` kidsClub: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates if the property has a Kids Club. Filtering Type: `option` ``` Eligible For: * hotel ``` kidsStayFree: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity allows kids to stay free. Filtering Type: `option` ``` Eligible For: * hotel ``` kitchenHours: additionalProperties: false type: object properties: friday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the kitchen hours are "closed" on Friday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity's kitchen is open on Friday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' holidayHours: description: |- **NOTE:** The list of Holiday Hours that you send us must be comprehensive. For example, if you send us a list of Holiday Hours that does not include Holiday Hours that you sent in your last update, Yext considers the missing Holiday Hours to be deleted, and we remove them. Array must be ordered. Filtering Type: `list of object` uniqueItems: true type: array items: required: - date additionalProperties: false type: object properties: date: format: date type: string description: |- Date on which the holiday hours will be in effect. Cannot be in the past. Date must be on or after 1970-01-01 Date must be before or on 2038-01-01 Filtering Type: `date` isClosed: type: boolean description: |- Indicates if the kitchen hours are "closed" on on the given date. Filtering Type: `boolean` isRegularHours: type: boolean description: |- Indicates whether the holiday hours are the same as the regular business hours for the given date. If set to true, we will update the holiday hours if the regular business hours change for the date's day of the week. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity's kitchen is open on the specified date. Filtering Type: `list of object` description: 'Filtering Type: `object`' monday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the kitchen hours are "closed" on Monday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity's kitchen is open on Monday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' reopenDate: format: date type: string description: |- Date must be on or after 1970-01-01 Date must be before or on 2038-01-01 Filtering Type: `date` saturday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the kitchen hours are "closed" on Saturday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity's kitchen is open on Saturday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' sunday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the kitchen hours are "closed" on Sunday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity's kitchen is open on Sunday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' thursday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the kitchen hours are "closed" on Thursday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity's kitchen is open on Thursday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' tuesday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the kitchen hours are "closed" on Tuesday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity's kitchen open on Tuesday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' wednesday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the kitchen hours are "closed" on Wednesday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity's kitchen is open on Wednesday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' description: |- Contains the daily kitchen hours, holiday kitchen hours, and reopen date for the Entity. Each day is represented by a sub-field of `kitchenHours`. (e.g. `monday`, `tuesday`, etc.) Open times can be specified per day through the `openIntervals` field and the `isClosed` flag. Similarly, holiday kitchen hours are represented by the `holidayHours` sub-field. Setting the `reopenDate` sub-field indicates that the business is temporarily closed and will reopen on the specified date. SPECIAL CASES: * To indicate that an Entity is open 24 hours on a specific day, set start to 00:00 and end to 23:59 in `openIntervals` for that day. * To indicate that an Entity has split hours on a specific day (e.g., open from 9:00 AM to 12:00 PM and again from 1:00 PM to 5:00 PM), supply two or more `openIntervals` values with non-overlapping sets of hours. * If you are providing `openIntervals`, you may not set `isClosed` to true for that day. Filtering Type: `hours` ``` Eligible For: * hotel * location * restaurant ``` labels: uniqueItems: false type: array items: minLength: 0 type: string description: |- The IDs of the entity labels that have been added to this entity. Entity labels help you identify entities that share a certain characteristic; they do not appear on your entity'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. Filtering Type: `opaque` ``` Eligible For: * atm * board * brand * card * contactCard * event * faq * financialProfessional * healthcareFacility * healthcareProfessional * helpArticle * hotel * hotelRoomType * job * location * organization * product * restaurant ``` landingPageUrl: minLength: 0 format: uri type: string description: |- The URL of this entity's Landing Page that was created with Yext Pages Filtering Type: `text` ``` Eligible For: * atm * card * event * faq * financialProfessional * healthcareFacility * healthcareProfessional * helpArticle * hotel * job * location * product * restaurant ``` languages: description: |- The langauges in which consumers can commicate with this entity or its staff members All strings must be non-empty when trimmed of whitespace. Array must be ordered. Array may have a maximum of 100 elements. Array item description: >Cannot Include: >* HTML markup Filtering Type: `list of text` ``` Eligible For: * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` uniqueItems: true type: array items: minLength: 0 maxLength: 100 type: string description: |- Cannot Include: * HTML markup Filtering Type: `text` lastName: minLength: 0 maxLength: 35 type: string description: |- The last name of the healthcare professional Cannot Include: * a URL or domain name * HTML markup Filtering Type: `text` ``` Eligible For: * healthcareProfessional ``` laundry: enum: - FULL_SERVICE - SELF_SERVICE - NOT_APPLICABLE type: string description: |- Indicates whether the entity offers laundry services. Filtering Type: `option` ``` Eligible For: * hotel ``` lazyRiver: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates if the property has a lazy river Filtering Type: `option` ``` Eligible For: * hotel ``` lifeguard: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates if the property has a lifeguard on duty Filtering Type: `option` ``` Eligible For: * hotel ``` linkedInUrl: minLength: 0 format: uri type: string description: |- URL for your LinkedIn account, format should be https://www.linkedin.com/in/yourUsername Filtering Type: `text` ``` Eligible For: * contactCard * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * organization * restaurant ``` linkedLocation: type: string description: |- location ID of the event location, if the event is held at a location managed in the Yext Knowledge Manager Filtering Type: `entityId` ``` Eligible For: * contactCard * event ``` localPhone: minLength: 0 type: string description: |- Must be a valid, non-toll-free phone number, based on the country specified in **`address.region`**. Phone numbers for US entities must contain 10 digits. Filtering Type: `text` ``` Eligible For: * atm * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` localShuttle: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity offers local shuttle services. Filtering Type: `option` ``` Eligible For: * hotel ``` locatedIn: type: string description: |- For atms, the external ID of the entity that the atm is installed in. The entity must be in the same business account as the atm. Filtering Type: `entityId` ``` Eligible For: * atm ``` location: additionalProperties: false type: object properties: existingLocation: type: string description: |- A location entity referenced by Yext ID or Entity ID where this job opening exists Filtering Type: `entityId` externalLocation: minLength: 0 maxLength: 255 type: string description: |- A location string where this job opening exists Cannot Include: * a URL or domain name * HTML markup Filtering Type: `text` description: |- The location where this job opening exists as either an existing location or an external location Filtering Type: `object` ``` Eligible For: * job ``` locationType: enum: - LOCATION - HEALTHCARE_FACILITY - HEALTHCARE_PROFESSIONAL - ATM - RESTAURANT - HOTEL type: string description: |- Indicates the entity's type, if it is not an event Filtering Type: `option` ``` Eligible For: * atm * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` logo: required: - image additionalProperties: false type: object description: |- An image of the entity's logo Supported Aspect Ratios: * 1 x 1 **NOTE**: Maximum image size is 5mb after normalization and padding (if applicable). As well, there is a 6 second download limit from the image host. Filtering Type: `object` ``` Eligible For: * atm * contactCard * faq * financialProfessional * healthcareFacility * healthcareProfessional * hotel * job * location * organization * restaurant ``` properties: clickthroughUrl: minLength: 0 format: uri type: string description: 'Filtering Type: `text`' description: minLength: 0 type: string description: 'Filtering Type: `text`' details: minLength: 0 type: string description: 'Filtering Type: `text`' image: required: - url additionalProperties: false type: object description: |- Supported Aspect Ratios: * 1 x 1 **NOTE**: Maximum image size is 5mb after normalization and padding (if applicable). As well, there is a 6 second download limit from the image host. Filtering Type: `object` properties: alternateText: minLength: 0 type: string description: 'Filtering Type: `text`' url: minLength: 0 format: uri type: string description: 'Filtering Type: `text`' mainPhone: minLength: 0 type: string description: |- The main phone number of the entity's point of contact Must be a valid phone number. If the phone number's calling code is for a country other than the one given in the entity's **`countryCode`**, the phone number provided must contain the calling code (e.g., `+44` in `+442038083831`). Otherwise, the calling code is optional. Filtering Type: `text` ``` Eligible For: * atm * contactCard * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * organization * restaurant ``` massage: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity offers massage services. Filtering Type: `option` ``` Eligible For: * hotel ``` maxAgeOfKidsStayFree: multipleOf: 1 minimum: 0 type: number description: |- The maximum age specified by the property for children to stay in the room/suite of a parent or adult without an additional fee Filtering Type: `integer` ``` Eligible For: * hotel ``` maxNumberOfKidsStayFree: multipleOf: 1 minimum: 0 type: number description: |- The maximum number of children who can stay in the room/suite of a parent or adult without an additional fee Filtering Type: `integer` ``` Eligible For: * hotel ``` mealsServed: uniqueItems: true type: array items: enum: - BREAKFAST - LUNCH - BRUNCH - DINNER - HAPPY_HOUR - LATE_NIGHT type: string description: 'Filtering Type: `option`' description: |- Types of meals served at this restaurant Filtering Type: `list of option` ``` Eligible For: * restaurant ``` meetingRoomCount: multipleOf: 1 minimum: 0 type: number description: |- The number of meeting rooms the entity has. Filtering Type: `integer` ``` Eligible For: * hotel ``` menuUrl: additionalProperties: false type: object properties: displayUrl: minLength: 0 maxLength: 2000 format: uri type: string description: |- The URL that is shown on your listings in place of **`menuUrl.url`**. You can use **`menuUrl.displayUrl`** to display a short, memorable web address that redirects consumers to the URL given in **`menuUrl.url`**. Filtering Type: `text` preferDisplayUrl: type: boolean description: |- If set to true, only the display URL will be sent to those publishers who do not support separate display and tracking URLs for this field. Filtering Type: `boolean` url: minLength: 0 maxLength: 2000 format: uri type: string description: |- A valid URL where consumers can view the entity's menu Filtering Type: `text` description: |- Information about the URL where consumers can view the entity's menu Filtering Type: `object` ``` Eligible For: * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` menus: additionalProperties: false type: object properties: ids: description: |- IDs of the Menu Lists associated with this entity Array must be ordered. Array may have a maximum of 40 elements. Filtering Type: `list of text` uniqueItems: true type: array items: minLength: 0 type: string description: 'Filtering Type: `text`' label: minLength: 0 maxLength: 30 type: string description: |- Label to be used for this entity's Menu Lists. This label will appear on your entity's listings. Filtering Type: `text` description: |- Information about the Menu Content Lists associated with this entity Filtering Type: `object` ``` Eligible For: * hotel * location * restaurant ``` middleName: minLength: 0 maxLength: 35 type: string description: |- The middle name of the healthcare professional Cannot Include: * a URL or domain name * HTML markup Filtering Type: `text` ``` Eligible For: * healthcareProfessional ``` mobilePhone: minLength: 0 type: string description: |- Must be a valid phone number. If the phone number's calling code is for a country other than the one given in the entity's **`countryCode`**, the phone number provided must contain the calling code (e.g., `+44` in `+442038083831`). Otherwise, the calling code is optional. Filtering Type: `text` ``` Eligible For: * atm * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` mobilityAccessible: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity is mobility/wheelchair accessible Filtering Type: `option` ``` Eligible For: * hotel ``` nightclub: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity has a nightclub. Filtering Type: `option` ``` Eligible For: * hotel ``` npi: minLength: 0 type: string description: |- The National Provider Identifier (NPI) of the healthcare provider Filtering Type: `text` ``` Eligible For: * healthcareFacility * healthcareProfessional ``` nudgeEnabled: type: boolean description: |- Indicates whether Knowledge Nudge is enabled for the Yext Knowledge Assistant for this entity Filtering Type: `boolean` ``` Eligible For: * atm * faq * financialProfessional * healthcareFacility * healthcareProfessional * helpArticle * hotel * job * location * organization * product * restaurant ``` officeName: minLength: 0 type: string description: |- The name of the office where the healthcare professional works, if different from **`name`** Filtering Type: `text` ``` Eligible For: * healthcareProfessional ``` onlineServiceHours: additionalProperties: false type: object properties: friday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the online service hours are "closed" on Friday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for the Entity's online service hours on Friday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' holidayHours: description: |- **NOTE:** The list of Holiday Hours that you send us must be comprehensive. For example, if you send us a list of Holiday Hours that does not include Holiday Hours that you sent in your last update, Yext considers the missing Holiday Hours to be deleted, and we remove them. Array must be ordered. Filtering Type: `list of object` uniqueItems: true type: array items: required: - date additionalProperties: false type: object properties: date: format: date type: string description: |- Date on which the holiday hours will be in effect. Cannot be in the past. Date must be on or after 1970-01-01 Date must be before or on 2038-01-01 Filtering Type: `date` isClosed: type: boolean description: |- Indicates if the online service hours are "closed" on on the given date. Filtering Type: `boolean` isRegularHours: type: boolean description: |- Indicates whether the holiday hours are the same as the regular business hours for the given date. If set to true, we will update the holiday hours if the regular business hours change for the date's day of the week. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for the Entity's online service hours on the specified date. Filtering Type: `list of object` description: 'Filtering Type: `object`' monday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the online service hours are "closed" on Monday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for the Entity's online service hours on Monday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' reopenDate: format: date type: string description: |- Date must be on or after 1970-01-01 Date must be before or on 2038-01-01 Filtering Type: `date` saturday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the online service hours are "closed" on Saturday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for the Entity's online service hours on Saturday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' sunday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the online service hours are "closed" on Sunday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for the Entity's online service hours on Sunday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' thursday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the online service hours are "closed" on Thursday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for the Entity's online service hours on Thursday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' tuesday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the online service hours are "closed" on Tuesday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for the Entity's online service hours on Tuesday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' wednesday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the online service hours are "closed" on Wednesday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for the Entity's online service hours on Wednesday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' description: |- Contains the daily online service hours, holiday online service hours, and reopen date for the Entity. Each day is represented by a sub-field of `onlineServiceHours`. (e.g. `monday`, `tuesday`, etc.) Open times can be specified per day through the `openIntervals` field and the `isClosed` flag. Similarly, holiday online service hours are represented by the `holidayHours` sub-field. Setting the `reopenDate` sub-field indicates that the business is temporarily closed and will reopen on the specified date. SPECIAL CASES: * To indicate that an Entity is open 24 hours on a specific day, set start to 00:00 and end to 23:59 in `openIntervals` for that day. * To indicate that an Entity has split hours on a specific day (e.g., open from 9:00 AM to 12:00 PM and again from 1:00 PM to 5:00 PM), supply two or more `openIntervals` values with non-overlapping sets of hours. * If you are providing `openIntervals`, you may not set `isClosed` to true for that day. Filtering Type: `hours` ``` Eligible For: * financialProfessional * healthcareFacility * healthcareProfessional * location * restaurant ``` openDate: format: date type: string description: |- The date that the entity is set to open for the first time. Must be formatted in YYYY-MM-DD format. Date must be on or after 1970-01-01 Date must be before or on 2038-01-01 Filtering Type: `date` ``` Eligible For: * atm * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` operatingCountries: uniqueItems: true type: array items: enum: - AD - AE - AF - AG - AI - AL - AM - AO - AR - AS - AT - AU - AW - AX - AZ - BA - BB - BD - BE - BF - BG - BH - BI - BJ - BL - BM - BN - BO - BQ - BR - BS - BT - BW - BY - BZ - CA - CD - CF - CG - CH - CI - CK - CL - CM - CN - CO - CR - CU - CV - CW - CY - CZ - DE - DJ - DK - DM - DO - DZ - EC - EE - EG - EH - ER - ES - ET - FI - FJ - FK - FM - FO - FR - GA - GB - GD - GE - GF - GG - GH - GI - GL - GM - GN - GP - GQ - GR - GT - GU - GW - GY - HK - HN - HR - HT - HU - ID - IE - IL - IM - IN - IQ - IR - IS - IT - JE - JM - JO - JP - KE - KG - KH - KI - KM - KN - KR - KW - KY - KZ - LA - LB - LC - LI - LK - LR - LS - LT - LU - LV - LY - MA - MC - MD - ME - MF - MG - MH - MK - ML - MM - MN - MO - MP - MQ - MR - MS - MT - MU - MV - MW - MX - MY - MZ - NA - NC - NE - NG - NI - NL - 'NO' - NP - NR - NZ - OM - PA - PE - PF - PG - PH - PK - PL - PM - PR - PS - PT - PW - PY - QA - RE - RO - RS - RU - RW - SA - SB - SC - SD - SE - SG - SH - SI - SJ - SK - SL - SM - SN - SO - SR - SS - ST - SV - SX - SY - SZ - TC - TD - TG - TH - TJ - TL - TM - TN - TO - TR - TT - TV - TW - TZ - UA - UG - US - UY - UZ - VA - VC - VE - VG - VI - VN - VU - WF - WS - XK - YE - YT - ZA - ZM - ZW type: string description: 'Filtering Type: `option`' description: |- The list of countries the business operates in Filtering Type: `list of option` ``` Eligible For: * organization ``` orderUrl: additionalProperties: false type: object properties: displayUrl: minLength: 0 maxLength: 2000 format: uri type: string description: |- The URL that is shown on your listings in place of **`orderUrl.url`**. You can use **`orderUrl.displayUrl`** to display a short, memorable web address that redirects consumers to the URL given in **`orderUrl.url`**. Filtering Type: `text` preferDisplayUrl: type: boolean description: |- If set to true, only the display URL will be sent to those publishers who do not support separate display and tracking URLs for this field. Filtering Type: `boolean` url: minLength: 0 maxLength: 2000 format: uri type: string description: |- A valid URL used to place an order at this entity Filtering Type: `text` description: |- Information about the URL used to place orders that will be fulfilled by the entity Filtering Type: `object` ``` Eligible For: * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` organizerEmail: minLength: 0 format: email type: string description: |- Point of contact for the event organizer (not to be published publicly) Filtering Type: `text` ``` Eligible For: * event ``` organizerName: minLength: 0 type: string description: |- Point of contact for the event organizer (not to be published publicly) Filtering Type: `text` ``` Eligible For: * event ``` organizerPhone: minLength: 0 type: string description: |- Point of contact for the event organizer (not to be published publicly) Filtering Type: `text` ``` Eligible For: * event ``` outdoorPoolCount: multipleOf: 1 minimum: 0 type: number description: |- The number of outdoor pools the entity has. Filtering Type: `integer` ``` Eligible For: * hotel ``` parking: enum: - PARKING_AVAILABLE - PARKING_AVAILABLE_FOR_FREE - NOT_APPLICABLE type: string description: |- Indicates whether the entity offers parking services. Filtering Type: `option` ``` Eligible For: * hotel ``` paymentOptions: uniqueItems: true type: array items: enum: - AFTERPAY - ALIPAY - AMERICANEXPRESS - ANDROIDPAY - APPLEPAY - ATM - ATMQUICK - BACS - BANCONTACT - BANKDEPOSIT - BANKPAY - BGO - BITCOIN - Bar - CARTASI - CASH - CCS - CHECK - CHEQUESVACANCES - CONB - CONTACTLESSPAYME - CVVV - DEBITCARD - DEBITNOTE - DINERSCLUB - DIRECTDEBIT - DISCOVER - ECKARTE - ECOCHEQUE - EKENA - EMV - FINANCING - GIFTCARD - GOPAY - HAYAKAKEN - HEBAG - IBOD - ICCARDS - ICOCA - ID - IDEAL - INCA - INVOICE - JCB - JCoinPay - JKOPAY - KITACA - KLA - KLARNA - LINEPAY - MAESTRO - MANACA - MASTERCARD - MIPAY - MONIZZE - MPAY - Manuelle Lastsch - Merpay - NANACO - NEXI - NIMOCA - OREM - PASMO - PAYBACKPAY - PAYBOX - PAYCONIQ - PAYPAL - PAYPAY - PAYSEC - PIN - POSTEPAY - QRCODE - QUICPAY - RAKUTENEDY - RAKUTENPAY - SAMSUNGPAY - SODEXO - SUGOCA - SUICA - SWISH - TICKETRESTAURANT - TOICA - TRAVELERSCHECK - TSCUBIC - TWINT - UNIONPAY - VEV - VISA - VISAELECTRON - VOB - VOUCHER - VPAY - WAON - WECHATPAY - WIRETRANSFER - Yucho Pay - ZELLE - auPay - dBarai - Überweisung type: string description: 'Filtering Type: `option`' description: |- The payment methods accepted by this entity Valid elements depend on the entity's country. Filtering Type: `list of option` ``` Eligible For: * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` performers: description: |- Performers at the event Array must be ordered. Array may have a maximum of 100 elements. Filtering Type: `list of text` ``` Eligible For: * event ``` uniqueItems: true type: array items: minLength: 0 maxLength: 100 type: string description: 'Filtering Type: `text`' petsAllowed: enum: - PETS_WELCOME - PETS_WELCOME_FOR_FREE - NOT_APPLICABLE - NOT_ALLOWED type: string description: |- Indicates if the entity is pet friendly. Filtering Type: `option` ``` Eligible For: * hotel ``` photoGallery: description: |- **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. Array must be ordered. Array may have a maximum of 500 elements. Array item description: >Supported Aspect Ratios: >* 1 x 1 >* 4 x 3 >* 3 x 2 >* 5 x 3 >* 16 x 9 >* 3 x 1 >* 2 x 3 >* 5 x 7 >* 4 x 5 >* 4 x 1 > >**NOTE**: Maximum image size is 5mb after normalization and padding (if applicable). As well, there is a 6 second download limit from the image host. > Filtering Type: `list of object` ``` Eligible For: * atm * event * financialProfessional * healthcareFacility * healthcareProfessional * hotel * hotelRoomType * location * organization * product * restaurant ``` uniqueItems: false type: array items: required: - image additionalProperties: false type: object description: |- Supported Aspect Ratios: * 1 x 1 * 4 x 3 * 3 x 2 * 5 x 3 * 16 x 9 * 3 x 1 * 2 x 3 * 5 x 7 * 4 x 5 * 4 x 1 **NOTE**: Maximum image size is 5mb after normalization and padding (if applicable). As well, there is a 6 second download limit from the image host. Filtering Type: `object` properties: clickthroughUrl: minLength: 0 format: uri type: string description: 'Filtering Type: `text`' description: minLength: 0 type: string description: 'Filtering Type: `text`' details: minLength: 0 type: string description: 'Filtering Type: `text`' image: required: - url additionalProperties: false type: object description: |- Supported Aspect Ratios: * 1 x 1 * 4 x 3 * 3 x 2 * 5 x 3 * 16 x 9 * 3 x 1 * 2 x 3 * 5 x 7 * 4 x 5 * 4 x 1 **NOTE**: Maximum image size is 5mb after normalization and padding (if applicable). As well, there is a 6 second download limit from the image host. Filtering Type: `object` properties: alternateText: minLength: 0 type: string description: 'Filtering Type: `text`' url: minLength: 0 format: uri type: string description: 'Filtering Type: `text`' pickupCoordinate: additionalProperties: false type: object properties: latitude: minimum: -90 maximum: 90 type: number description: 'Filtering Type: `float`' longitude: minimum: -180 maximum: 180 type: number description: 'Filtering Type: `float`' description: |- Coordinates of where consumers can be picked up at the entity, as provided by you Filtering Type: `object` ``` Eligible For: * atm * event * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` pickupHours: additionalProperties: false type: object properties: friday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the pickup hours are "closed" on Friday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is open for pickup on Friday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' holidayHours: description: |- **NOTE:** The list of Holiday Hours that you send us must be comprehensive. For example, if you send us a list of Holiday Hours that does not include Holiday Hours that you sent in your last update, Yext considers the missing Holiday Hours to be deleted, and we remove them. Array must be ordered. Filtering Type: `list of object` uniqueItems: true type: array items: required: - date additionalProperties: false type: object properties: date: format: date type: string description: |- Date on which the holiday hours will be in effect. Cannot be in the past. Date must be on or after 1970-01-01 Date must be before or on 2038-01-01 Filtering Type: `date` isClosed: type: boolean description: |- Indicates if the pickup hours are "closed" on on the given date. Filtering Type: `boolean` isRegularHours: type: boolean description: |- Indicates whether the holiday hours are the same as the regular business hours for the given date. If set to true, we will update the holiday hours if the regular business hours change for the date's day of the week. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is open for pickup on the specified date. Filtering Type: `list of object` description: 'Filtering Type: `object`' monday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the pickup hours are "closed" on Monday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is open for pickup on Monday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' reopenDate: format: date type: string description: |- Date must be on or after 1970-01-01 Date must be before or on 2038-01-01 Filtering Type: `date` saturday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the pickup hours are "closed" on Saturday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is open for pickup on Saturday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' sunday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the pickup hours are "closed" on Sunday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is open for pickup on Sunday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' thursday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the pickup hours are "closed" on Thursday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is open for pickup on Thursday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' tuesday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the pickup hours are "closed" on Tuesday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is open for pickup on Tuesday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' wednesday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the pickup hours are "closed" on Wednesday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is open for pickup on Wednesday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' description: |- Contains the daily pickup hours, holiday pickup hours, and reopen date for the Entity. Each day is represented by a sub-field of `pickupHours`. (e.g. `monday`, `tuesday`, etc.) Open times can be specified per day through the `openIntervals` field and the `isClosed` flag. Similarly, holiday pickup hours are represented by the `holidayHours` sub-field. Setting the `reopenDate` sub-field indicates that the business is temporarily closed and will reopen on the specified date. SPECIAL CASES: * To indicate that an Entity is open 24 hours on a specific day, set start to 00:00 and end to 23:59 in `openIntervals` for that day. * To indicate that an Entity has split hours on a specific day (e.g., open from 9:00 AM to 12:00 PM and again from 1:00 PM to 5:00 PM), supply two or more `openIntervals` values with non-overlapping sets of hours. * If you are providing `openIntervals`, you may not set `isClosed` to true for that day. Filtering Type: `hours` ``` Eligible For: * healthcareFacility * location * restaurant ``` pinterestUrl: minLength: 0 format: uri type: string description: |- URL for your Pinterest account, format should be https://www.pinterest.com/yourUsername Filtering Type: `text` ``` Eligible For: * contactCard * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * organization * restaurant ``` priceRange: enum: - UNSPECIFIED - ONE - TWO - THREE - FOUR type: string description: |- he typical price of products sold by this location, on a scale of 1 (low) to 4 (high) Filtering Type: `option` ``` Eligible For: * atm * healthcareFacility * healthcareProfessional * location * restaurant ``` primaryConversationContact: minLength: 0 type: string description: |- ID of the user who is the primary Knowledge Assistant contact for the entity Filtering Type: `option` ``` Eligible For: * atm * faq * financialProfessional * healthcareFacility * healthcareProfessional * helpArticle * hotel * job * location * organization * product * restaurant ``` privateBeach: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity has access to a private beach. Filtering Type: `option` ``` Eligible For: * hotel ``` privateCarService: enum: - PRIVATE_CAR_SERVICE - PRIVATE_CAR_SERVICE_FOR_FREE - NOT_APPLICABLE type: string description: |- Indicates whether the entity offers private car services. Filtering Type: `option` ``` Eligible For: * hotel ``` productLists: additionalProperties: false type: object properties: ids: description: |- IDs of the Products & Services Lists associated with this entity Array must be ordered. Array may have a maximum of 40 elements. Filtering Type: `list of text` uniqueItems: true type: array items: minLength: 0 type: string description: 'Filtering Type: `text`' label: minLength: 0 maxLength: 30 type: string description: |- Label to be used for this entity's Products & Services Lists. This label will appear on your entity's listings. Filtering Type: `text` description: |- Information about the Products & Services Content Lists associated with this entity Filtering Type: `object` ``` Eligible For: * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` products: description: |- Products sold by this entity All strings must be non-empty when trimmed of whitespace. Array must be ordered. Array may have a maximum of 100 elements. Array item description: >Cannot Include: >* HTML markup Filtering Type: `list of text` ``` Eligible For: * financialProfessional * location ``` uniqueItems: true type: array items: minLength: 0 maxLength: 100 type: string description: |- Cannot Include: * HTML markup Filtering Type: `text` questionsAndAnswers: type: boolean description: |- Indicates whether Yext Knowledge Assistant question-and-answer conversations are enabled for this entity Filtering Type: `boolean` ``` Eligible For: * atm * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * organization * restaurant ``` rankTrackingCompetitors: description: |- Information about the competitors whose search performance you would like to compare to your own Array must be ordered. Array may have a maximum of 5 elements. Filtering Type: `list of object` ``` Eligible For: * atm * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * organization * restaurant ``` uniqueItems: true type: array items: required: - name - website additionalProperties: false type: object properties: name: minLength: 0 maxLength: 100 type: string description: |- A name of a competitor Cannot Include: * HTML markup Filtering Type: `text` website: minLength: 0 maxLength: 255 format: uri type: string description: |- The business website of a competitor Cannot Include: * common domain names, e.g., google.com, youtube.com, etc. Filtering Type: `text` description: 'Filtering Type: `object`' rankTrackingEnabled: type: boolean description: |- Indicates whether Rank Tracking is enabled Filtering Type: `boolean` ``` Eligible For: * atm * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * organization * restaurant ``` rankTrackingFrequency: enum: - WEEKLY - MONTHLY - QUARTERLY type: string description: |- How often we send search queries to track your search performance Filtering Type: `option` ``` Eligible For: * atm * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * organization * restaurant ``` rankTrackingQueryTemplates: description: |- The ways in which your keywords will be arranged in the search queries we use to track your performance Array must have a minimum of 2 elements. Array may have a maximum of 4 elements. Filtering Type: `list of option` ``` Eligible For: * atm * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * organization * restaurant ``` uniqueItems: true type: array items: enum: - KEYWORD - KEYWORD_ZIP - KEYWORD_CITY - KEYWORD_IN_CITY - KEYWORD_NEAR_ME - KEYWORD_CITY_STATE type: string description: 'Filtering Type: `option`' rankTrackingSites: uniqueItems: true type: array items: enum: - GOOGLE_DESKTOP - GOOGLE_MOBILE - BING_DESKTOP - BING_MOBILE - YAHOO_DESKTOP - YAHOO_MOBILE type: string description: 'Filtering Type: `option`' description: |- The search engines that we will use to track your performance Filtering Type: `list of option` ``` Eligible For: * atm * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * organization * restaurant ``` reservationUrl: additionalProperties: false type: object properties: displayUrl: minLength: 0 maxLength: 2000 format: uri type: string description: |- The URL that is shown on your listings in place of **`reservationUrl.url`**. You can use **`reservationUrl.displayUrl`** to display a short, memorable web address that redirects consumers to the URL given in **`reservationUrl.url`**. Must be a valid URL and be specified along with **`reservationUrl.url`**. Filtering Type: `text` preferDisplayUrl: type: boolean description: |- If set to true, only the display URL will be sent to those publishers who do not support separate display and tracking URLs for this field. Filtering Type: `boolean` url: minLength: 0 maxLength: 2000 format: uri type: string description: |- A valid URL used to make reservations at this entity Filtering Type: `text` description: |- Information about the URL consumers can visit to make reservations at this entity Filtering Type: `object` ``` Eligible For: * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` restaurantCount: multipleOf: 1 minimum: 0 type: number description: |- The number of restaurants the entity has. Filtering Type: `integer` ``` Eligible For: * hotel ``` reviewGenerationUrl: minLength: 0 type: string description: |- The URL given Review Invitation emails where consumers can leave a review about the entity ``` Eligible For: * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` reviewResponseConversationEnabled: type: boolean description: |- Indicates whether Yext Knowledge Assistant review-response conversations are enabled for this entity Filtering Type: `boolean` ``` Eligible For: * atm * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` roomCount: multipleOf: 1 minimum: 0 type: number description: |- The number of rooms the entity has. Filtering Type: `integer` ``` Eligible For: * hotel ``` roomService: enum: - ROOM_SERVICE_AVAILABLE - ROOM_SERVICE_AVAILABLE_24_HOURS - NOT_APPLICABLE type: string description: |- Indicates whether the entity offers room service. Filtering Type: `option` ``` Eligible For: * hotel ``` routableCoordinate: additionalProperties: false type: object properties: latitude: minimum: -90 maximum: 90 type: number description: 'Filtering Type: `float`' longitude: minimum: -180 maximum: 180 type: number description: 'Filtering Type: `float`' description: |- Destination coordinates to use for driving directions to the entity, as provided by you Filtering Type: `object` ``` Eligible For: * atm * event * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` salon: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity has a salon. Filtering Type: `option` ``` Eligible For: * hotel ``` sauna: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity has a sauna. Filtering Type: `option` ``` Eligible For: * hotel ``` scuba: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity offers scuba diving. Filtering Type: `option` ``` Eligible For: * hotel ``` selfParking: enum: - SELF_PARKING_AVAILABLE - SELF_PARKING_AVAILABLE_FOR_FREE - NOT_APPLICABLE type: string description: |- Indicates whether the entity offers self parking services. Filtering Type: `option` ``` Eligible For: * hotel ``` seniorHours: additionalProperties: false type: object properties: friday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the senior hours are "closed" on Friday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for the Entity's senior hours on Friday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' holidayHours: description: |- **NOTE:** The list of Holiday Hours that you send us must be comprehensive. For example, if you send us a list of Holiday Hours that does not include Holiday Hours that you sent in your last update, Yext considers the missing Holiday Hours to be deleted, and we remove them. Array must be ordered. Filtering Type: `list of object` uniqueItems: true type: array items: required: - date additionalProperties: false type: object properties: date: format: date type: string description: |- Date on which the holiday hours will be in effect. Cannot be in the past. Date must be on or after 1970-01-01 Date must be before or on 2038-01-01 Filtering Type: `date` isClosed: type: boolean description: |- Indicates if the senior hours are "closed" on on the given date. Filtering Type: `boolean` isRegularHours: type: boolean description: |- Indicates whether the holiday hours are the same as the regular business hours for the given date. If set to true, we will update the holiday hours if the regular business hours change for the date's day of the week. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for the Entity's senior hours on the specified date. Filtering Type: `list of object` description: 'Filtering Type: `object`' monday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the senior hours are "closed" on Monday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for the Entity's senior hours on Monday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' reopenDate: format: date type: string description: |- Date must be on or after 1970-01-01 Date must be before or on 2038-01-01 Filtering Type: `date` saturday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the senior hours are "closed" on Saturday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for the Entity's senior hours on Saturday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' sunday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the senior hours are "closed" on Sunday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for the Entity's senior hours on Sunday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' thursday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the senior hours are "closed" on Thursday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for the Entity's senior hours on Thursday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' tuesday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the senior hours are "closed" on Tuesday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for the Entity's senior hours on Tuesday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' wednesday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the senior hours are "closed" on Wednesday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for the Entity's senior hours on Wednesday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' description: |- Contains the daily senior hours, holiday senior hours, and reopen date for the Entity. Each day is represented by a sub-field of `seniorHours`. (e.g. `monday`, `tuesday`, etc.) Open times can be specified per day through the `openIntervals` field and the `isClosed` flag. Similarly, holiday senior hours are represented by the `holidayHours` sub-field. Setting the `reopenDate` sub-field indicates that the business is temporarily closed and will reopen on the specified date. SPECIAL CASES: * To indicate that an Entity is open 24 hours on a specific day, set start to 00:00 and end to 23:59 in `openIntervals` for that day. * To indicate that an Entity has split hours on a specific day (e.g., open from 9:00 AM to 12:00 PM and again from 1:00 PM to 5:00 PM), supply two or more `openIntervals` values with non-overlapping sets of hours. * If you are providing `openIntervals`, you may not set `isClosed` to true for that day. Filtering Type: `hours` ``` Eligible For: * location * restaurant ``` serviceArea: additionalProperties: false type: object properties: places: description: |- A list of places served by the entity, where each place is either: - a postal code, or - the name of a city. Array must be ordered. Array may have a maximum of 200 elements. Filtering Type: `list of text` uniqueItems: true type: array items: minLength: 0 maxLength: 100 type: string description: 'Filtering Type: `text`' description: |- Information about the area that is served by this entity. It is specified as a list of cities and/or postal codes. **Only for Google Business Profile and Bing:** Currently, **serviceArea** is only supported by Google Business Profile and Bing and will not affect your listings on other sites. Filtering Type: `object` ``` Eligible For: * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` serviceAreaPlaces: description: |- Information about the area that is served by this entity. It is specified as a list of service area names, their associated types and google place ids. **Only for Google Business Profile and Bing:** Currently, **serviceArea** is only supported by Google Business Profile and Bing and will not affect your listings on other sites. Array may have a maximum of 200 elements. Filtering Type: `list of object` ``` Eligible For: * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` uniqueItems: true type: array items: additionalProperties: false type: object properties: name: minLength: 0 maxLength: 100 type: string description: 'Filtering Type: `text`' googlePlaceId: minLength: 0 type: string description: 'Filtering Type: `text`' type: enum: - POSTAL_CODE - REGION - COUNTY - CITY - SUBLOCALITY type: string description: 'Filtering Type: `option`' description: 'Filtering Type: `object`' services: description: |- Services offered by this entity All strings must be non-empty when trimmed of whitespace. Array must be ordered. Array may have a maximum of 100 elements. Array item description: >Cannot Include: >* HTML markup Filtering Type: `list of text` ``` Eligible For: * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` uniqueItems: true type: array items: minLength: 0 maxLength: 100 type: string description: |- Cannot Include: * HTML markup Filtering Type: `text` smokeFreeProperty: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates if the entity is smoke free. Filtering Type: `option` ``` Eligible For: * hotel ``` snorkeling: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity offers snorkeling. Filtering Type: `option` ``` Eligible For: * hotel ``` socialHour: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity offers a social hour. Filtering Type: `option` ``` Eligible For: * hotel ``` spa: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity has a spa. Filtering Type: `option` ``` Eligible For: * hotel ``` specialities: description: |- Up to 100 of this entity's specialities (e.g., for food and dining: `Chicago style`) All strings must be non-empty when trimmed of whitespace. Array must be ordered. Array may have a maximum of 100 elements. Array item description: >Cannot Include: >* HTML markup Filtering Type: `list of text` ``` Eligible For: * financialProfessional * location * restaurant ``` uniqueItems: true type: array items: minLength: 0 maxLength: 100 type: string description: |- Cannot Include: * HTML markup Filtering Type: `text` tableService: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity has a sit-down restaurant. Filtering Type: `option` ``` Eligible For: * hotel ``` takeoutHours: additionalProperties: false type: object properties: friday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the takeout hours are "closed" on Friday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is open for takeout on Friday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' holidayHours: description: |- **NOTE:** The list of Holiday Hours that you send us must be comprehensive. For example, if you send us a list of Holiday Hours that does not include Holiday Hours that you sent in your last update, Yext considers the missing Holiday Hours to be deleted, and we remove them. Array must be ordered. Filtering Type: `list of object` uniqueItems: true type: array items: required: - date additionalProperties: false type: object properties: date: format: date type: string description: |- Date on which the holiday hours will be in effect. Cannot be in the past. Date must be on or after 1970-01-01 Date must be before or on 2038-01-01 Filtering Type: `date` isClosed: type: boolean description: |- Indicates if the takeout hours are "closed" on on the given date. Filtering Type: `boolean` isRegularHours: type: boolean description: |- Indicates whether the holiday hours are the same as the regular business hours for the given date. If set to true, we will update the holiday hours if the regular business hours change for the date's day of the week. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is open for takeout on the specified date. Filtering Type: `list of object` description: 'Filtering Type: `object`' monday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the takeout hours are "closed" on Monday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is open for takeout on Monday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' reopenDate: format: date type: string description: |- Date must be on or after 1970-01-01 Date must be before or on 2038-01-01 Filtering Type: `date` saturday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the takeout hours are "closed" on Saturday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is open for takeout on Saturday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' sunday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the takeout hours are "closed" on Sunday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is open for takeout on Sunday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' thursday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the takeout hours are "closed" on Thursday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is open for takeout on Thursday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' tuesday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the takeout hours are "closed" on Tuesday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is open for takeout on Tuesday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' wednesday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the takeout hours are "closed" on Wednesday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is open for takeout on Wednesday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' description: |- Contains the daily takeout hours, holiday takeout hours, and reopen date for the Entity. Each day is represented by a sub-field of `takeoutHours`. (e.g. `monday`, `tuesday`, etc.) Open times can be specified per day through the `openIntervals` field and the `isClosed` flag. Similarly, holiday takeout hours are represented by the `holidayHours` sub-field. Setting the `reopenDate` sub-field indicates that the business is temporarily closed and will reopen on the specified date. SPECIAL CASES: * To indicate that an Entity is open 24 hours on a specific day, set start to 00:00 and end to 23:59 in `openIntervals` for that day. * To indicate that an Entity has split hours on a specific day (e.g., open from 9:00 AM to 12:00 PM and again from 1:00 PM to 5:00 PM), supply two or more `openIntervals` values with non-overlapping sets of hours. * If you are providing `openIntervals`, you may not set `isClosed` to true for that day. Filtering Type: `hours` ``` Eligible For: * location * restaurant ``` tennis: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity has tennis courts. Filtering Type: `option` ``` Eligible For: * hotel ``` thermalPool: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity has a thermal pool. Filtering Type: `option` ``` Eligible For: * hotel ``` ticketAvailability: enum: - IN_STOCK - SOLD_OUT - PRE_ORDER - UNSPECIFIED type: string description: |- Information about the availability of tickets for the event Filtering Type: `option` ``` Eligible For: * event ``` ticketPriceRange: additionalProperties: false type: object properties: currencyCode: minLength: 0 type: string description: |- Three letter currency code (ISO standard) Filtering Type: `text` maxValue: pattern: ^\d*\.?\d*$ type: string description: |- Maximum ticket price Filtering Type: `decimal` minValue: pattern: ^\d*\.?\d*$ type: string description: |- Minimum ticket price Filtering Type: `decimal` description: |- Contains the price range for the event Filtering Type: `object` ``` Eligible For: * event ``` ticketSaleDateTime: format: date-time type: string description: |- The date/time tickets are available for sale (local time) Filtering Type: `datetime` ``` Eligible For: * event ``` ticketUrl: minLength: 0 format: uri type: string description: |- URL to purchase tickets for the event (if ticketed) Filtering Type: `text` ``` Eligible For: * event ``` tikTokUrl: minLength: 0 format: uri type: string description: |- URL for your TikTok profile, format should be https://www.tiktok.com/yourUsername Filtering Type: `text` ``` Eligible For: * contactCard * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * organization * restaurant ``` time: additionalProperties: false type: object properties: end: format: date-time type: string description: |- End date/time of the event, in local time (see timezone field) Standard ISO 8601 datetime without timezone Format: `YYYY-MM-DDThh:mm` Filtering Type: `datetime` start: format: date-time type: string description: |- Start date/time of the event, in local time (see timezone field) Standard ISO 8601 datetime without timezone Format: `YYYY-MM-DDThh:mm` Filtering Type: `datetime` description: |- Contains the start/end times for the event Filtering Type: `object` ``` Eligible For: * event ``` timeZoneUtcOffset: minLength: 0 type: string description: |- Represents the time zone offset of the entity from UTC, in `±hh:mm` format. For example, if the entity is 4 hours ahead of UTC time, the offset will be `+04:00`. If the entity is 15.5 hours behind UTC time, the offset will be `-15:30`. If the entity is in UTC time, the offset will be `+00:00`. ``` Eligible For: * atm * event * faq * healthcareFacility * healthcareProfessional * hotel * job * location * restaurant ``` timezone: minLength: 0 type: string description: |- The timezone of the entity, in the standard `IANA time zone database` format (tz database). e.g. `"America/New_York"` Filtering Type: `option` ``` Eligible For: * atm * board * card * contactCard * event * faq * financialProfessional * healthcareFacility * healthcareProfessional * helpArticle * hotel * hotelRoomType * job * location * organization * product * restaurant ``` tollFreePhone: minLength: 0 type: string description: |- Must be a valid phone number. If the phone number's calling code is for a country other than the one given in the entity's **`countryCode`**, the phone number provided must contain the calling code (e.g., `+44` in `+442038083831`). Otherwise, the calling code is optional. Filtering Type: `text` ``` Eligible For: * atm * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` treadmill: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity has a treadmill. Filtering Type: `option` ``` Eligible For: * hotel ``` ttyPhone: minLength: 0 type: string description: |- Must be a valid phone number. If the phone number's calling code is for a country other than the one given in the entity's **`countryCode`**, the phone number provided must contain the calling code (e.g., `+44` in `+442038083831`). Otherwise, the calling code is optional. Filtering Type: `text` ``` Eligible For: * atm * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` turndownService: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity offers turndown service. Filtering Type: `option` ``` Eligible For: * hotel ``` twitterHandle: minLength: 0 maxLength: 15 type: string description: |- Valid Twitter handle for the entity without the leading "@" (e.g., `JohnSmith`) 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. Filtering Type: `text` ``` Eligible For: * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * organization * restaurant ``` uberLink: required: - presentation additionalProperties: false type: object properties: presentation: enum: - BUTTON - LINK type: string description: |- Indicates whether the embedded Uber link for this entity 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 entity set as the trip destination. If the Uber app is not installed, the consumer will be prompted to download it. Filtering Type: `option` text: minLength: 0 maxLength: 100 type: string description: |- The text of the embedded Uber link Default is `Ride there with Uber`. **NOTE:** This field is only available if **`uberLink.presentation`** is `LINK`. Filtering Type: `text` description: |- Information about the Yext-powered link that can be copied and pasted into the markup of Yext Pages where the embedded Uber link should appear Filtering Type: `object` ``` Eligible For: * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` uberTripBranding: required: - text - url - description additionalProperties: false type: object properties: description: minLength: 0 maxLength: 150 type: string description: |- A longer description that will appear near the call-to-action in the Uber app during a trip to your entity. **NOTE:** If a value for **`uberTripBranding.description`** is provided, values must also be provided for **`uberTripBranding.text`** and **`uberTripBranding.url`**. Filtering Type: `text` text: minLength: 0 maxLength: 28 type: string description: |- The text of the call-to-action that will appear in the Uber app during a trip to your entity (e.g., `Check out our menu!`) **NOTE:** If a value for **`uberTripBranding.text`** is provided, values must also be provided for **`uberTripBranding.url`** and **`uberTripBranding.description`**. Filtering Type: `text` url: minLength: 0 format: uri type: string description: |- 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 entity. **NOTE:** If a value for **`uberTripBranding.url`** is provided, values must also be provided for **`uberTripBranding.text`** and **`uberTripBranding.description`**. Filtering Type: `text` description: |- Information about the call-to-action consumers will see in the Uber app during a trip to your entity Filtering Type: `object` ``` Eligible For: * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` valetParking: enum: - VALET_PARKING_AVAILABLE - VALET_PARKING_AVAILABLE_FOR_FREE - NOT_APPLICABLE type: string description: |- Indicates whether the entity offers valet parking services. Filtering Type: `option` ``` Eligible For: * hotel ``` validThrough: format: date-time type: string description: |- The date this entity is valid through. Filtering Type: `datetime` ``` Eligible For: * job ``` vendingMachine: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity has a vending machine. Filtering Type: `option` ``` Eligible For: * hotel ``` venueName: minLength: 0 type: string description: |- Name of the venue where the event is being held Filtering Type: `text` ``` Eligible For: * event ``` videos: description: |- Valid YouTube URLs for embedding a video on some publisher sites **NOTE:** Currently, only the first URL in the Array appears in your listings. Array must be ordered. Filtering Type: `list of object` ``` Eligible For: * financialProfessional * healthcareFacility * healthcareProfessional * hotel * hotelRoomType * location * organization * product * restaurant ``` uniqueItems: true type: array items: required: - video additionalProperties: false type: object properties: description: minLength: 0 maxLength: 140 type: string description: |- Cannot Include: * HTML markup Filtering Type: `text` video: required: - url additionalProperties: false type: object properties: url: minLength: 0 format: uri type: string description: 'Filtering Type: `text`' description: 'Filtering Type: `object`' description: 'Filtering Type: `object`' wadingPool: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity has a wading pool. Filtering Type: `option` ``` Eligible For: * hotel ``` wakeUpCalls: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity offers wake up call services. Filtering Type: `option` ``` Eligible For: * hotel ``` walkableCoordinate: additionalProperties: false type: object properties: latitude: minimum: -90 maximum: 90 type: number description: 'Filtering Type: `float`' longitude: minimum: -180 maximum: 180 type: number description: 'Filtering Type: `float`' description: |- Destination coordinates to use for walking directions to the entity, as provided by you Filtering Type: `object` ``` Eligible For: * atm * event * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` waterPark: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity has a water park. Filtering Type: `option` ``` Eligible For: * hotel ``` waterSkiing: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity offers water skiing. Filtering Type: `option` ``` Eligible For: * hotel ``` watercraft: enum: - WATERCRAFT_RENTALS - WATERCRAFT_RENTALS_FOR_FREE - NOT_APPLICABLE type: string description: |- Indicates whether the entity offers any kind of watercrafts. Filtering Type: `option` ``` Eligible For: * hotel ``` waterslide: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity has a water slide. Filtering Type: `option` ``` Eligible For: * hotel ``` wavePool: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity has a wave pool. Filtering Type: `option` ``` Eligible For: * hotel ``` websiteUrl: additionalProperties: false type: object properties: displayUrl: minLength: 0 maxLength: 2000 format: uri type: string description: |- The URL that is shown on your listings in place of **`websiteUrl.url`**. You can use **`websiteUrl.displayUrl`** to display a short, memorable web address that redirects consumers to the URL given in **`websiteUrl.url`**. Must be a valid URL and be specified along with **`websiteUrl.url`**. Filtering Type: `text` preferDisplayUrl: type: boolean description: |- If set to true, only the display URL will be sent to those publishers who do not support separate display and tracking URLs for this field. Filtering Type: `boolean` url: minLength: 0 maxLength: 2000 format: uri type: string description: |- A valid URL for this entity's website Filtering Type: `text` description: |- Information about the website for this entity Filtering Type: `object` ``` Eligible For: * atm * contactCard * event * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * organization * restaurant ``` weightMachine: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity has a weight machine. Filtering Type: `option` ``` Eligible For: * hotel ``` wheelchairAccessible: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates if the entity is wheelchair accessible. Filtering Type: `option` ``` Eligible For: * hotel ``` wifiAvailable: enum: - WIFI_AVAILABLE - WIFI_AVAILABLE_FOR_FREE - NOT_APPLICABLE type: string description: |- Indicates whether the entity has WiFi available Filtering Type: `option` ``` Eligible For: * hotel ``` workRemote: type: boolean description: |- Indicates whether the job is remote. Filtering Type: `boolean` ``` Eligible For: * job ``` yearEstablished: multipleOf: 1 minimum: 1000 maximum: 2028 type: number description: |- The year the entity was established. Filtering Type: `integer` ``` Eligible For: * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` yearLastRenovated: multipleOf: 1 minimum: 1000 maximum: 2028 type: number description: |- The most recent year the entity was partially or completely renovated. Filtering Type: `integer` ``` Eligible For: * hotel ``` yextDisplayCoordinate: additionalProperties: false type: object properties: latitude: minimum: -90 maximum: 90 type: number description: 'Filtering Type: `float`' longitude: minimum: -180 maximum: 180 type: number description: 'Filtering Type: `float`' description: |- Coordinates where the map pin for the entity should be displayed, as calculated by Yext Filtering Type: `object` ``` Eligible For: * atm * event * financialProfessional * healthcareFacility * healthcareProfessional * hotel * job * location * restaurant ``` yextDropoffCoordinate: additionalProperties: false type: object properties: latitude: minimum: -90 maximum: 90 type: number description: 'Filtering Type: `float`' longitude: minimum: -180 maximum: 180 type: number description: 'Filtering Type: `float`' description: |- Coordinates of where consumers can be dropped off at the entity, as calculated by Yext Filtering Type: `object` ``` Eligible For: * atm * event * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` yextPickupCoordinate: additionalProperties: false type: object properties: latitude: minimum: -90 maximum: 90 type: number description: 'Filtering Type: `float`' longitude: minimum: -180 maximum: 180 type: number description: 'Filtering Type: `float`' description: |- Coordinates of where consumers can be picked up at the entity, as calculated by Yext Filtering Type: `object` ``` Eligible For: * atm * event * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` yextRoutableCoordinate: additionalProperties: false type: object properties: latitude: minimum: -90 maximum: 90 type: number description: 'Filtering Type: `float`' longitude: minimum: -180 maximum: 180 type: number description: 'Filtering Type: `float`' description: |- Destination coordinates to use for driving directions to the entity, as calculated by Yext Filtering Type: `object` ``` Eligible For: * atm * event * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` yextWalkableCoordinate: additionalProperties: false type: object properties: latitude: minimum: -90 maximum: 90 type: number description: 'Filtering Type: `float`' longitude: minimum: -180 maximum: 180 type: number description: 'Filtering Type: `float`' description: |- Destination coordinates to use for walking directions to the entity, as calculated by Yext Filtering Type: `object` ``` Eligible For: * atm * event * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` youTubeChannelUrl: minLength: 0 format: uri type: string description: |- URL for your YouTube channel, format should be https://www.youtube.com/c/yourUsername Filtering Type: `text` ``` Eligible For: * contactCard * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * organization * restaurant ``` headers: {} '400': description: Error Response content: application/json: schema: additionalProperties: false type: object properties: meta: additionalProperties: false type: object properties: errors: uniqueItems: false type: array items: additionalProperties: false type: object properties: code: multipleOf: 1 type: number description: | Code that uniquely identifies the error or warning. message: minLength: 0 type: string description: Message explaining the problem. type: enum: - FATAL_ERROR - NON_FATAL_ERROR - WARNING type: string description: List of errors and warnings. uuid: minLength: 0 type: string description: 'Filtering Type: `object`' headers: {} /accounts/{accountId}/entityprofiles: get: operationId: listAllLanguageProfiles parameters: - schema: minLength: 0 type: string name: accountId in: path required: true - schema: minLength: 0 type: string description: A date in `YYYYMMDD` format. name: v in: query required: true - schema: minLength: 0 type: string description: | Optional parameter to return fields of type **Markdown** as HTML. - `false`: **Markdown** fields will be returned as JSON - `true`: **Markdown** fields will be returned as HTML name: convertMarkdownToHTML in: query required: false - schema: minLength: 0 type: string description: | Optional parameter to return fields of type **Rich Text** as HTML. - `false`: **Rich Text** fields will be returned as JSON - `true`: **Rich Text** fields will be returned as HTML name: convertRichTextToHTML in: query required: false - schema: minLength: 0 type: string description: | Comma-separated list of Entity types to filter on. Example: `"location,event"` Should be from the following types: * `atm` * `event` * `faq` * `financialProfessional` * `healthcareFacility` * `healthcareProfessional` * `hotel` * `hotelRoomType` * `job` * `location` * `organization` * `product` * `restaurant` OR the API name of a custom entity type. name: entityTypes in: query required: false - schema: minLength: 0 type: string description: Comma-separated list of field names. When present, only the fields listed will be returned. You can use dot notation to specify substructures (e.g., `"address.line1"`). Custom fields are specified in the same way, albeit with their `c_*` name. name: fields in: query required: false - schema: minLength: 0 type: string description: | This parameter represents one or more filtering conditions that are applied to the set of entities that would otherwise be returned. This parameter should be provided as a URL-encoded string containing a JSON object. For example, if the filter JSON is `{"name":{"$eq":"John"}}`, then the filter param after URL-encoding will be: `filter=%7B%22name%22%3A%7B%22%24eq%22%3A%22John%22%7D%7D` **Basic Filter Structure** The filter object at its core consists of a *matcher*, a *field*, and an *argument*. For example, in the following filter JSON: ``` { "name":{ "$eq":"John" } } ``` `$eq` is the *matcher*, or filtering operation (equals, in this example), `name` is the *field* being filtered by, and `John` is *value* to be matched against. **Combining Multiple Filters** Multiple filters can be combined into one object using *combinators*. For example, the following filter JSON combines multiple filters using the combinator `$and`. `$or` is also supported. ``` { "$and":[ { "firstName":{ "$eq":"John" } }, { "countryCode":{ "$in":[ "US", "GB" ] } } ] } ``` **Filter Negation** Certain filter types may be negated. For example: ``` { "$not": { "name": { "$eq": "John" } } } ``` This can also be written more simply with a `!` in the `$eq` parameter. The following filter would have the same effect: ``` { "name":{ "!$eq":"John" } } ``` **Filter Complement** You can also search for the complement of a filter. This filter would match entities that do not contain "hello" in their descriptions, or do not have a description set. This is different from negation which can only match entities who have the negated field set to something. ``` { "$complement":{ "description":{ "$contains":"hello" } } } ``` **Addressing Subfields** Subfields of fields can be addressed using the "dot" notation while filtering. For example, if you have a custom field called **`c_myCustomField`**: ``` { "c_myCustomField":{ "age": 30, "name": "Jim", } } ``` While filtering, subfields may be addressed using the "dot" notation. ``` { "c_myCustomField.name":{ "!$eq":"John" } } ``` Fields that are nested deeper may be addressed using dot notation, as well. For example, if **`name`** in the above example was a compound field with two subfields **`first`** and **`last`**, **`first`** may be addressed as **`c_myCustomField.name.first`**. **Field Support** Entity fields correspond to certain filter types, which support matchers. Going by the example above, the field **`name`** supports the `TEXT` filter type, which supports `$eq` (equals) and `$startsWith` (starts with). **TEXT** The `TEXT` filter type is supported for text fields. (e.g., **`name`**, **`countryCode`**)
Matcher Details
$eq (equals) { "countryCode":{ "$eq":"US" } }, { "countryCode":{ "!$eq":"US" } } Supports negation. Case insensitive.
$startsWith Matches if the field starts with the argument value. e.g., "Amazing" starts with "amaz" { "address.line1":{ "$startsWith": "Jo" } } Supports negation. Case insensitive.
$in Matches if field value is a member of the argument list. { "firstName":{ "$in": ["John", "Jimmy"] } } Does not support negation. Negation can be mimicked by using an "OR" matcher, for example: { "$and":[ { "firstName":{ "!$eq": "John" } }, { "firstName":{ "!$eq": "Jimmy" } } ] }
$contains { "c_myString":{ "$contains":"sample" } } This filter will match if "sample" is contained in any string within **`c_myString`**. Note that this matching is "left-edge n-gram", meaning the argument string must be the beginning of a token. The string "sample" will match strings like "This a sample", "Sample one", and "Sample 2", but not strings like "thisisasamplewithoutspaces". Supports negation.
$containsAny { "c_myString":{ "$containsAny":[ "sample1", "sample2" ] } } This filter will match if either "sample1" or "sample2" is contained in any string within **`c_myString`**. The argument list can contain more than two strings. Note that this matching is "left-edge n-gram", meaning the argument string must be the beginning of a token. The string "sample" will match strings like "This a sample", "Sample one", and "Sample 2", but not strings like "thisisasamplewithoutspaces". Supports negation.
$containsAll { "c_myString":{ "$containsAll":[ "sample1", "sample2" ] } } This filter will match if both "sample1" and "sample2" are contained in any string within **`c_myString`**. The argument list can contain more than two strings. Note that this matching is "left-edge n-gram", meaning the argument string must be the beginning of a token. The string "sample" will match strings like "This a sample", "Sample one", and "Sample 2", but not strings like "thisisasamplewithoutspaces". Supports negation.
**BOOLEAN** The BOOLEAN filter type is supported for boolean fields and Yes / No custom fields.
Matcher Details
$eq { "isFreeEvent": { "$eq": true } } For booleans, the filter takes a boolean value, not a string. Supports negation.
**STRUCT** The STRUCT filter type is supported for compound fields with subfields. *e.g., **`address`**, **`featuredMessage`**, fields of custom types*
Matcher Details
$hasProperty Matches if argument is a key (subfield) of field being filtered by. This filter type is useful for filtering by compound fields or to check if certain fields have a value set. { "address": { "$hasProperty": "line1" } } Note that if a given property of a compound field is not set, the filter will not match. For example, if `line1` of **`address`** is not set for an entity, then the above matcher will not match the entity. Supports negation.
**OPTION** The OPTION filter type is supported for options custom fields and fields that have a predetermined list of valid values. *e.g., **`eventStatus`**, **`gender`**, `SINGLE_OPTION` and `MULTI_OPTION` types of custom fields.*
Matcher Details
$eq Matching is case insensitive and insensitive to consecutive whitespace. e.g., "XYZ 123" matches "xyz 123" { "eventStatus": { "$eq": "SCHEDULED" } } Supports negation. Negating `$eq` on the list will match any field that does not hold any of the provided values.
$in { "eventStatus": { "$in": [ "SCHEDULED", "POSTPONED" ] } } Does not support negation. However, negation can be mimicked by using an `$and` matcher to negate individually over the desired values. For example: { "$and": [ { "eventStatus":{ "!$eq": "SCHEDULED" } }, { "firstName":{ "!$eq": "POSTPONED" } } ] }
**PHONE** The PHONE filter type is supported for phone number fields only. PHONE will support the same matchers as TEXT, except that for `$eq`, the same phone number with or without calling code will match.
Matcher Details
$eq { "mainPhone":{ "$eq":"+18187076189" } }, { "mainPhone":{ "$eq":"8187076189" } }, { "mainPhone":{ "!$eq":"9177076189" } } Supports negation. Case insensitive.
$startsWith Matches if the field starts with the argument value. e.g., "8187076189" starts with "818" { "mainPhone":{ "$startsWith": "818" } } Supports negation. Case insensitive.
$in Matches if field value is a member of the argument list. { "mainPhone":{ "$in": [ "8185551616", "9171112211" ] } } Does not support negation. However, negation can be mimicked by using an `$and` matcher to negate individually over the desired values.
**INTEGER, FLOAT, DATE, DATETIME, and TIME** These filter types are strictly ordered -- therefore, they support the following matchers: - Equals - Less Than / Less Than or Equal To - Greater Than / Greater Than or Equal To
Matcher Details
$eq Equals { "ageRange.maxValue": { "$eq": "80" } } Supports negation.
$lt Less than { "time.start": { "$lt": "2018-08-28T05:56" } }
$gt Greater than { "ageRange.maxValue": { "$gt": "50" } }
$le Less than or equal to { "ageRange.maxValue": { "$le": "40" } }
$ge Greater than or equal to { "time.end": { "$ge": "2018-08-28T05:56" } }
Combinations While we do not support "between" in our filtering syntax, it is possible to combine multiple matchers for a result similar to an "and" operation: { "ageRange.maxValue : { "$gt" : 10, "$lt": 20 } }
**LIST OF TEXT** Any field that has a list of valid values and supports any of the previously mentioned filter types will also support the `$contains` matcher.
Matcher Details
$eq { "c_myStringList": { "$eq": "sample" } } This filter will match if "sample" EXACTLY matches any string within **`c_myStringList`**. Supports negation.
$eqAny { "c_myStringList": { "$eqAny": [ "sample1", "sample2" ] } } This filter will match if any one of "sample1" or "sample2" EXACTLY match a string within **`c_myStringList`** . The argument can have more than two strings. Supports negation.
$eqAll { "c_myStringList": { "$eqAll": [ "sample1", "sample2" ] } } This filter will match if both "sample1" AND "sample2" EXACTLY match a string within **`c_myStringList`**. The argument can have more than two strings. Supports negation.
$contains { "c_myStringList":{ "$contains":"sample" } } This filter will match if "sample" is contained in any string within **`c_myStringList`**. Note that this matching is "left edge n-gram", meaning the argument string must be the beginning of a token. The string "sample" will match strings like "This is a sample", "Sample one", "Sample 2" but not strings like "thisisasamplewithoutspaces". Supports negation.
$containsAny { "c_myStringList": { "$containsAny": [ "sample1", "sample2" ] } } This filter will match if either "sample1" or "sample2" is contained in any string within **`c_myStringList`**. The argument list can have more than two strings. Note that similar to `$contains`, the matching for `$containsAny` is "left edge n-gram", meaning the argument string must be the beginning of a token. The string "sample" will match strings like "This is a sample", "Sample one", "Sample 2" but not strings like "thisisasamplewithoutspaces". Supports negation.
$containsAll { "c_myStringList": { "$containsAll": [ "sample1", "sample2" ] } } This filter will match if BOTH "sample1" and "sample2" are contained in strings within **`c_myStringList`**. The argument list can have more than two strings. Note that similar to `$contains`, the matching for `$containsAll` is "left-edge n-gram", meaning the argument string must be the beginning of a token. The string "sample" will match strings like "This a sample", "Sample one", and "Sample 2", but not strings like "thisisasamplewithoutspaces". Supports negation.
$startsWith { "c_myStringList": { "$startsWith":"sample" } } This filter will match if any string within **`c_myStringList`** starts with "sample". Does not supports negation. Case Insensitive.
**LIST OF BOOLEAN, OPTION, PHONE, INTEGER, FLOAT, DATE, DATETIME, OR TIME**
Matcher Details
$eq { "c_myDateList": { "$eq": "2019-01-01" } } This filter will match if "2019-01-01" EXACTLY matches any date within **`c_myDateList`**. Supports negation.
$eqAny { "c_myIntegerList": { "$eqAny": [1, 2] } } This filter will match if 1 or 2 EXACTLY match any integer within **`c_myIntegerList`**. The argument list can have more than two elements. Supports negation.
$eqAll { "c_myStringList": { "$eqAll": [ "sample1", "sample2" ] } } This filter will match if both "2019-01-01" AND "2019-01-02" EXACTLY match a date within **`c_myDateList`**. The argument list can have more than two elements. Supports negation.
**LIST OF STRUCT** Filtering on lists of struct types is a bit nuanced. Filtering can only be done on lists of structs of the SAME type. For example, if **`c_myStructList`** is a list of compound fields with the subfields **`age`** and **`name`**, then one can address the **`age`** properties of each field in **`c_myStructList`** as a flattened list of integers and filtering upon them. For example, the following filter: ``` { "c_myStructList.age":{ "$eq": 20 } } ``` will match if any field in the list has an **`age`** property equal to 20. Similarly, any filter that can be applied to lists of integers could be applied to **`age`** in this case (`$eq`, `$eqAll`, `$eqAny`). **HOURS** By filtering on an hours field, you can find which entities are open or closed at a specified time or during a certain time range. All of these filters also take an entity’s holiday hours and reopen date into account.
Matcher Details
$openAt { "hours": { "$openAt": "2019-01-06T13:45" } } This filter would match entities open at the specified time.
$closedAt { "hours": { "$closedAt: "2019-01-06T13:45" } }
$openForAllOf { "hours": { "$openForAllOf": { "start": "2019-01-06T13:45", "end": "2019-01-06T15:00" } } } This filter would match only those entities that are open for the entire range between 2019-01-06T13:45 and 2019-01-06T15:00. { "hours": { "$openForAllOf": "2019-05-10" } } This filter would match entities open for the entire 24 hour period on 2019-05-10. You can also supply a year, a month, or an hour to filter for entities open for the entire year, month, or hour, respectively.
$openForAnyOf { "hours": { "$openForAnyOf": { "start": "now", "end": "now+2h" } } } This filter will match any entities that are open for at least a portion of the time range between now and two hours from now.
$closedForAllOf { "hours": { "$closedForAllOf": { "start": "2019-01-06T13:45", "end": "2019-01-06T15:00" } } } This filter will match only those entities that are closed for the entire given time range.
$closedForAnyOf { "hours": { "$closedForAnyOf": { "start": "2019-01-06T13:45", "end": "2019-01-06T15:00" } } } This filter will match any entities that are closed for at least a portion of the given time range.
**Filtering by Dates and Times** **Time zones** The filtering language supports searching both in local time and within a certain time zone. Searching in local time will simply ignore the time zone on the target entities, while providing one will convert the zone of your queried time to the zone of the target entities. To search in local time, simply provide the date or time without any zone: `2019-06-07T15:30` or `2019-06-07`. To conduct a zoned search, provide the name of the time zone in brackets after the time, as it is shown in the tz database: `2019-06-07T15:30[America/New_York]` or `2019-06-06[America/Phoenix]`. **Date and time types** In addition to searching with dates and datetimes, you can also query with years, months, and hours. For example, the filter: ``` { "time.start": { "$eq": "2018" } } ``` would match all start times in the year 2018. The same logic would apply for a month (`2019-05`), a date (`2019-05-01`), or an hour (`2019-05-01T06`). These types also work with ordered searches. For example: ``` { "time.start": { "$lt": "2018" } } ``` would match start times before 2018 (i.e., anything in 2017 or before). On the other hand, the same query with a `$le` matcher would include anything in or before 2018. **"Now" and Date Math** Instead of providing a static date or time, you can also use `now` in place of any date time. When you do so, the system will calculate the time when the query is made and conduct a zoned search. In order to search for a future or past time relative to `now`, you can use date math. For example, you can enter `now+3h` or `now-1d`, which would mean 3 hours from now and 1 day ago, respectively. You can also add and subtract minutes (`m`), months (`M`), and years (`y`). It is also possible to add or subtract time from a static date or datetime. Simply add `||` between the static value and any addition or subtraction. For example, `2019-02-03||+1d` would be the same as `2019-02-04`. You can also convert date and time types to other types. For example, to convert the datetime `2019-05-06T22:15` to a date, use `2019-05-06T22:15||/d`. Doing so would yield the same result as using `2019-05-06`. This method also works with `now`: `now/d` will give you today’s date without the time. **Filtering Across an Entity** It is possible to search for a specific text string across all fields of an entity by using the `$anywhere` matcher.
Matcher Details
$anywhere Matches if the argument text appears anywhere in the entity (including subfields, structs, and lists) { "$anywhere": "hello" } This filter will match all entities that contain the string "hello" or strings that begin with "hello".
**Examples** The following filter will match against entities that: - Are of type `event` (note that entity types can also be filtered by the **`entityTypes`** query parameter) - Have a name that starts with the text "Century" - Have a maximum age between 10 and 20 - Have a minimum age between 5 and 7 - Start after 7 PM (19:00) on August 28, 2018 ``` { "$and":[ { "entityType":{ "$eq":"event" } }, { "name":{ "$startsWith":"Century" } }, { "ageRange.maxValue":{ "$gt":10, "$lt":20 } }, { "ageRange.minValue":{ "$gt":5, "$lt":7 } }, { "time.start":{ "$ge":"2018-08-28T19:00" } } ] } ``` name: filter in: query required: false - schema: minLength: 0 type: string default: markdown description: | Present if and only if at least one field is of type "**Legacy Rich Text**." Valid values: * `markdown` * `html` * `none` name: format in: query required: false - schema: minLength: 0 type: string description: The comma-separated language codes corresponding to the languages of the profile that the user wishes to retrieve name: languageCodes in: query required: false - schema: multipleOf: 1 maximum: 50 type: number default: '10' description: Number of results to return. name: limit in: query required: false - schema: multipleOf: 1 type: number default: '0' description: | Number of results to skip. Used to page through results. Cannot be used together with **`pageToken`**. For Live API requests, the offset cannot be higher than 9,950. For Knowledge API the maximum limit is only enforced if a filter and/or sortBy parameter are given. name: offset in: query required: false - schema: minLength: 0 type: string description: If a response to a previous request contained the **`pageToken`** field, pass that field's value as the **`pageToken`** parameter to retrieve the next page of data. name: pageToken in: query required: false - schema: minLength: 0 type: string description: | A list of fields and sort directions to order results by. Each ordering in the list should be in the format `{"field_name", "sort_direction"}`, where `sort_direction` is either `ASCENDING` or `DESCENDING`. For example, to order by `name` the sort order would be `[{"name":"ASCENDING"}]`. To order by `name` and then `description`, the sort order would be `[{"name":"ASCENDING"},{"description":"ASCENDING"}]`. name: sortBy in: query required: false tags: - Live API summary: 'Entity Language Profiles: List All' description: | Retrieve a list of Language Profiles for Entities within an account **NOTE:** * Responses will contain resolved values for embedded fields * If the `fields` parameter is unspecified, responses will contain the full entity profile for the requested language responses: '200': description: Success Response content: application/json: schema: additionalProperties: false type: object properties: meta: additionalProperties: false type: object properties: uuid: minLength: 0 type: string description: Unique ID for this request / response. response: additionalProperties: false type: object properties: count: multipleOf: 1 type: number description: Total number of Entities that meet the filter criteria (ignores **``limit``** / **``offset``** parameters) pageToken: minLength: 0 type: string description: | Pass this value into the next request as the **`pageToken`** parameter to retrieve the next page of data. If the response of a request contains the last page of data, a **`pageToken`** value will not be returned. A **`pageToken`** will never appear in the response if the request contains the **`sortOrder`**, **`randomization`**, or **`randomizationToken`** parameters. profileLists: uniqueItems: false type: array items: additionalProperties: false type: object properties: profiles: uniqueItems: false type: array items: additionalProperties: false type: object properties: meta: additionalProperties: false type: object properties: accountId: minLength: 0 type: string description: ID of the account associated with this Entity countryCode: minLength: 0 type: string description: |- Country code of this Entity's Language Profile (defaults to the country of the account) Filtering Type: `text` createdTimestamp: minLength: 0 type: string description: The timestamp of when the entity record was created. entityType: minLength: 0 type: string description: |- This Entity's type (e.g., location, event) Filtering Type: `text` folderId: minLength: 0 type: string description: |- The ID of the folder containing this Entity Filtering Type: `text` id: minLength: 0 type: string description: |- ID of this Entity Filtering Type: `text` labels: uniqueItems: false type: array items: minLength: 0 type: string description: 'Filtering Type: `text`' description: |- This Entity's labels. If the **`v`** parameter is before `20211215`, this will be an integer. Filtering Type: `list of text` language: minLength: 0 type: string description: |- Language code of this Entity's Language Profile (defaults to the language code of the account) Filtering Type: `text` timestamp: minLength: 0 type: string description: | The timestamp of the most recent change to this entity record. Will be ignored when the client is saving entity data to Yext. **NOTE:** The timestamp may change even if observable fields stay the same. uid: minLength: 0 type: string description: | The internal ID of the entity. This UID is a static, globally unique ID. Note that this value cannot be used in place of id in API calls to retrieve or edit Entity information. If the v param is before `20221206`, the returned value will be a hashed version of the entity UID (aka internal ID of the entity). description: |- Contains the metadata about the entity. ``` Eligible For: * atm * event * faq * healthcareFacility * healthcareProfessional * hotel * job * location * restaurant ``` name: minLength: 0 maxLength: 5000 type: string description: |- Cannot Include: * HTML markup Filtering Type: `text` ``` Eligible For: * atm * board * brand * card * contactCard * event * faq * financialProfessional * healthcareFacility * healthcareProfessional * helpArticle * hotel * hotelRoomType * job * location * organization * product * restaurant ``` address: additionalProperties: false type: object properties: city: minLength: 0 maxLength: 255 type: string description: |- The city the entity (or the entity's location) is in Cannot Include: * a URL or domain name Filtering Type: `text` countryCode: minLength: 0 pattern: ^[a-zA-Z]{2}$ type: string description: 'Filtering Type: `text`' extraDescription: minLength: 0 maxLength: 255 type: string description: |- Provides additional information to help consumers get to the entity. This string appears along with the entity's address (e.g., `In Menlo Mall, 3rd Floor`). It may also be used in conjunction with a hidden address (i.e., when **`addressHidden`** is `true`) to give consumers information about where the entity can be found (e.g., `Servicing the New York area`). Filtering Type: `text` line1: minLength: 0 maxLength: 255 type: string description: |- Cannot Include: * a URL or domain name Filtering Type: `text` line2: minLength: 0 maxLength: 255 type: string description: |- Cannot Include: * a URL or domain name Filtering Type: `text` postalCode: minLength: 0 maxLength: 10 type: string description: |- The entity's postal code. The postal code must be valid for the entity's country. Cannot include a URL or domain name. Cannot Include: * a URL or domain name Filtering Type: `text` region: minLength: 0 maxLength: 255 type: string description: |- The name of the entity's region or state. Cannot Include: * a URL or domain name Filtering Type: `text` sublocality: minLength: 0 maxLength: 255 type: string description: |- The name of the entity's sublocality Cannot Include: * a URL or domain name Filtering Type: `text` description: |- Contains the address of the entity (or where the entity is located) Must be a valid address Cannot be a P.O. Box If the entity is an `event`, either an **`address`** value or a **`linkedLocation`** value can be provided. Filtering Type: `object` ``` Eligible For: * atm * event * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` acceptingNewPatients: type: boolean description: |- Indicates whether the healthcare provider is accepting new patients. Filtering Type: `boolean` ``` Eligible For: * healthcareFacility * healthcareProfessional ``` acceptsReservations: type: boolean description: |- Indicates whether the entity accepts reservations. Filtering Type: `boolean` ``` Eligible For: * restaurant ``` accessHours: additionalProperties: false type: object properties: friday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the access hours are "closed" on Friday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is open on Friday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' holidayHours: description: |- **NOTE:** The list of Holiday Hours that you send us must be comprehensive. For example, if you send us a list of Holiday Hours that does not include Holiday Hours that you sent in your last update, Yext considers the missing Holiday Hours to be deleted, and we remove them. Array must be ordered. Filtering Type: `list of object` uniqueItems: true type: array items: required: - date additionalProperties: false type: object properties: date: format: date type: string description: |- Date on which the holiday hours will be in effect. Cannot be in the past. Date must be on or after 1970-01-01 Date must be before or on 2038-01-01 Filtering Type: `date` isClosed: type: boolean description: |- Indicates if the access hours are "closed" on on the given date. Filtering Type: `boolean` isRegularHours: type: boolean description: |- Indicates whether the holiday hours are the same as the regular business hours for the given date. If set to true, we will update the holiday hours if the regular business hours change for the date's day of the week. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is open on the specified date. Filtering Type: `list of object` description: 'Filtering Type: `object`' monday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the access hours are "closed" on Monday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is open on Monday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' reopenDate: format: date type: string description: |- Date must be on or after 1970-01-01 Date must be before or on 2038-01-01 Filtering Type: `date` saturday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the access hours are "closed" on Saturday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is open on Saturday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' sunday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the access hours are "closed" on Sunday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is open on Sunday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' thursday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the access hours are "closed" on Thursday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is open on Thursday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' tuesday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the access hours are "closed" on Tuesday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is open on Tuesday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' wednesday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the access hours are "closed" on Wednesday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is open on Wednesday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' description: |- Contains the daily access hours, holiday access hours, and reopen date for the Entity. Each day is represented by a sub-field of `accessHours`. (e.g. `monday`, `tuesday`, etc.) Open times can be specified per day through the `openIntervals` field and the `isClosed` flag. Similarly, holiday access hours are represented by the `holidayHours` sub-field. Setting the `reopenDate` sub-field indicates that the business is temporarily closed and will reopen on the specified date. SPECIAL CASES: * To indicate that an Entity is open 24 hours on a specific day, set start to 00:00 and end to 23:59 in `openIntervals` for that day. * To indicate that an Entity has split hours on a specific day (e.g., open from 9:00 AM to 12:00 PM and again from 1:00 PM to 5:00 PM), supply two or more `openIntervals` values with non-overlapping sets of hours. * If you are providing `openIntervals`, you may not set `isClosed` to true for that day. Filtering Type: `hours` ``` Eligible For: * atm * healthcareFacility * hotel * location * restaurant ``` additionalHoursText: minLength: 0 maxLength: 255 type: string description: |- Additional information about hours that does not fit in **`hours`** (e.g., `"Closed during the winter"`) Filtering Type: `text` ``` Eligible For: * atm * contactCard * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` additionalPromotingLocations: description: |- If other locations are promoting this event, a list of those locations' **`id`**s in the Yext Knowledge Manager Array must be ordered. Filtering Type: `list of entityId` ``` Eligible For: * event ``` uniqueItems: true type: array items: type: string description: 'Filtering Type: `entityId`' addressHidden: type: boolean description: |- If `true`, the entity's street address will not be shown on listings. Defaults to `false`. Filtering Type: `boolean` ``` Eligible For: * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` admittingHospitals: description: |- A list of hospitals where the healthcare professional admits patients Array must be ordered. Array may have a maximum of 100 elements. Array item description: >Cannot Include: >* HTML markup Filtering Type: `list of text` ``` Eligible For: * healthcareProfessional ``` uniqueItems: true type: array items: minLength: 0 maxLength: 100 type: string description: |- Cannot Include: * HTML markup Filtering Type: `text` adultPool: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity has a pool for adults only. Filtering Type: `option` ``` Eligible For: * hotel ``` ageRange: additionalProperties: false type: object properties: maxValue: multipleOf: 1 type: number description: |- Maximum age for the event Filtering Type: `integer` minValue: multipleOf: 1 type: number description: |- Minimum age for the event Filtering Type: `integer` description: |- Contains the age range for the event Filtering Type: `object` ``` Eligible For: * event ``` airportShuttle: enum: - AIRPORT_SHUTTLE_AVAILABLE - AIRPORT_SHUTTLE_AVAILABLE_FOR_FREE - NOT_APPLICABLE type: string description: |- Indicates whether the entity offers a shuttle to/from the airport. Filtering Type: `option` ``` Eligible For: * hotel ``` airportTransfer: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity offers a shuttle service of car service to/from nearby airports or train stations. Filtering Type: `option` ``` Eligible For: * hotel ``` allInclusive: enum: - ALL_INCLUSIVE_RATES_AVAILABLE - ALL_INCLUSIVE_RATES_ONLY - NOT_APPLICABLE type: string description: |- Indicates whether the entity offers all-inclusive rates. Filtering Type: `option` ``` Eligible For: * hotel ``` alternateNames: description: |- Other names for your business that you would like us to use when tracking your search performance Array must be ordered. Array may have a maximum of 3 elements. Array item description: >Cannot Include: >* HTML markup Filtering Type: `list of text` ``` Eligible For: * atm * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * organization * restaurant ``` uniqueItems: true type: array items: minLength: 0 maxLength: 100 type: string description: |- Cannot Include: * HTML markup Filtering Type: `text` alternatePhone: minLength: 0 type: string description: |- Must be a valid phone number. If the phone number's calling code is for a country other than the one given in the entity's **`countryCode`**, the phone number provided must contain the calling code (e.g., `+44` in `+442038083831`). Otherwise, the calling code is optional. Filtering Type: `text` ``` Eligible For: * atm * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` alternateWebsites: description: |- Other websites for your business that we should search for when tracking your search performance Array must be ordered. Array may have a maximum of 3 elements. Array item description: >Cannot Include: >* common domain names, e.g., google.com, youtube.com, etc. Filtering Type: `list of text` ``` Eligible For: * atm * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * organization * restaurant ``` uniqueItems: true type: array items: minLength: 0 maxLength: 255 format: uri type: string description: |- Cannot Include: * common domain names, e.g., google.com, youtube.com, etc. Filtering Type: `text` androidAppUrl: minLength: 0 type: string description: |- The URL where consumers can download the entity's Android app Filtering Type: `text` ``` Eligible For: * brand * financialProfessional * hotel * location * restaurant ``` answer: description: |- The answer to the frequently asked question represented by this entity Character limit: 0 .. 15000 Supported formats include: * BOLD * ITALICS * UNDERLINE * BULLETED_LIST * NUMBERED_LIST * HYPERLINK * IMAGE * CODE_SPAN * HEADINGS ``` Eligible For: * faq ``` type: string format: rich-text appleActionLinks: description: |- Use this field to add action links to your Apple Listings. The call to action category will be displayed on the action link button. The App Store URL should contain a valid link to the landing page of an App in the Apple App Store. The Quick Link URL is where a user is taken when an action link is clicked by a user. The App Name sub-field is not displayed on Apple Listings and is only used to distinguish the call-to-action type when utilizing action links in Apple posts. Array must be ordered. Filtering Type: `list of object` ``` Eligible For: * atm * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` uniqueItems: true type: array items: required: - category - quickLinkUrl - appName additionalProperties: false type: object properties: appName: minLength: 0 maxLength: 18 type: string description: 'Filtering Type: `text`' appStoreUrl: minLength: 0 maxLength: 2000 format: uri type: string description: 'Filtering Type: `text`' category: enum: - BOOK_TRAVEL - CHECK_IN - FEES_POLICIES - FLIGHT_STATUS - TICKETS - TICKETING - AMENITIES - FRONT_DESK - PARKING - GIFT_CARD - WAITLIST - DELIVERY - ORDER - TAKEOUT - PICKUP - RESERVE - MENU - APPOINTMENT - PORTFOLIO - QUOTE - SERVICES - STORE_ORDERS - STORE_SHOP - STORE_SUPPORT - SCHEDULE - SHOWTIMES - AVAILABILITY - PRICING - ACTIVITIES - BOOK - BOOK_(HOTEL) - BOOK_(RIDE) - BOOK_(TOUR) - CAREERS - CHARGE - COUPONS - DELIVERY_(RETAIL) - DONATE - EVENTS - ORDER_(RETAIL) - OTHER_MENU - PICKUP_(RETAIL) - RESERVE_(PARKING) - SHOWS - SPORTS - SUPPORT - TEE_TIME - GIFT_CARD_(RESTAURANT) type: string description: 'Filtering Type: `option`' quickLinkUrl: minLength: 0 maxLength: 2000 format: uri type: string description: 'Filtering Type: `text`' description: 'Filtering Type: `object`' appleBusinessDescription: minLength: 0 maxLength: 500 type: string description: |- The business description to be sent to Apple Filtering Type: `text` ``` Eligible For: * atm * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` appleBusinessId: minLength: 0 pattern: ^\d*\.?\d*$ type: string description: |- The ID associated with an individual Business Folder in your Apple account Filtering Type: `text` ``` Eligible For: * atm * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` appleCompanyId: minLength: 0 pattern: ^\d*\.?\d*$ type: string description: |- The ID associated with your Apple account. Numerical values only Filtering Type: `text` ``` Eligible For: * atm * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` appleCoverPhoto: required: - url additionalProperties: false type: object description: |- The cover photo for the entity''s Apple profile Image must be at least 1600 x 1040 pixels Image may be no more than 4864 x 3163 pixels Supported Aspect Ratios: * 154 x 100 **NOTE**: Maximum image size is 5mb after normalization and padding (if applicable). As well, there is a 6 second download limit from the image host. Filtering Type: `object` ``` Eligible For: * atm * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` properties: alternateText: minLength: 0 type: string description: 'Filtering Type: `text`' url: minLength: 0 format: uri type: string description: 'Filtering Type: `text`' appleDisplayName: minLength: 0 maxLength: 5000 type: string description: |- The name to be displayed on Apple for the entity. NOTE: The names of Brands and their respective Locations within an Apple Business Connect Account must match identically. Cannot Include: HTML markup Cannot Include: * HTML markup Filtering Type: `text` ``` Eligible For: * atm * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` applicationUrl: minLength: 0 format: uri type: string description: |- The application URL Filtering Type: `text` ``` Eligible For: * job ``` associations: description: |- Association memberships relevant to the entity (e.g., `"New York Doctors Association"`) All strings must be non-empty when trimmed of whitespace. Array must be ordered. Array may have a maximum of 100 elements. Array item description: >Cannot Include: >* HTML markup Filtering Type: `list of text` ``` Eligible For: * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` uniqueItems: true type: array items: minLength: 0 maxLength: 100 type: string description: |- Cannot Include: * HTML markup Filtering Type: `text` attendance: required: - attendanceMode additionalProperties: false type: object properties: attendanceMode: enum: - OFFLINE - ONLINE - MIXED type: string description: 'Filtering Type: `option`' virtualLocationUrl: minLength: 0 format: uri type: string description: 'Filtering Type: `text`' description: |- Indicates whether the event is online, offline, or a mix. A `virtualLocationUrl` must be specified for online and mixed events. Filtering Type: `object` ``` Eligible For: * event ``` attire: enum: - UNSPECIFIED - DRESSY - CASUAL - FORMAL type: string description: |- The formality of clothing typically worn at this restaurant Filtering Type: `option` ``` Eligible For: * restaurant ``` babysittingOffered: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity offers babysitting. Filtering Type: `option` ``` Eligible For: * hotel ``` baggageStorage: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity offers baggage storage pre check-in and post check-out. Filtering Type: `option` ``` Eligible For: * hotel ``` bar: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity has an indoor or outdoor bar onsite. Filtering Type: `option` ``` Eligible For: * hotel ``` beachAccess: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity has access to a beach. Filtering Type: `option` ``` Eligible For: * hotel ``` beachFrontProperty: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity is physically located next to a beach. Filtering Type: `option` ``` Eligible For: * hotel ``` bicycles: enum: - BICYCLE_RENTALS - BICYCLE_RENTALS_FOR_FREE - NOT_APPLICABLE type: string description: |- Indicates whether the entity offers bicycles for rent or for free. Filtering Type: `option` ``` Eligible For: * hotel ``` bios: additionalProperties: false type: object properties: ids: description: |- IDs of the Bio Lists associated with this entity Array must be ordered. Array may have a maximum of 40 elements. Filtering Type: `list of text` uniqueItems: true type: array items: minLength: 0 type: string description: 'Filtering Type: `text`' label: minLength: 0 maxLength: 30 type: string description: |- Label to be used for this entity's Bio Lists. This label will appear on your entity's listings. Filtering Type: `text` description: |- Information about the Bio Content Lists associated with this entity Filtering Type: `object` ``` Eligible For: * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * organization * restaurant ``` boutiqueStores: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity has a boutique store. Gift shop or convenience store are not eligible. Filtering Type: `option` ``` Eligible For: * hotel ``` brands: description: |- Brands sold by this entity All strings must be non-empty when trimmed of whitespace. Array must be ordered. Array may have a maximum of 100 elements. Array item description: >Cannot Include: >* HTML markup Filtering Type: `list of text` ``` Eligible For: * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` uniqueItems: true type: array items: minLength: 0 maxLength: 100 type: string description: |- Cannot Include: * HTML markup Filtering Type: `text` breakfast: enum: - BREAKFAST_AVAILABLE - BREAKFAST_AVAILABLE_FOR_FREE - NOT_APPLICABLE type: string description: |- Indicates whether the entity offers breakfast. Filtering Type: `option` ``` Eligible For: * hotel ``` brunchHours: additionalProperties: false type: object properties: friday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the brunch hours are "closed" on Friday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is open for brunch on Friday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' holidayHours: description: |- **NOTE:** The list of Holiday Hours that you send us must be comprehensive. For example, if you send us a list of Holiday Hours that does not include Holiday Hours that you sent in your last update, Yext considers the missing Holiday Hours to be deleted, and we remove them. Array must be ordered. Filtering Type: `list of object` uniqueItems: true type: array items: required: - date additionalProperties: false type: object properties: date: format: date type: string description: |- Date on which the holiday hours will be in effect. Cannot be in the past. Date must be on or after 1970-01-01 Date must be before or on 2038-01-01 Filtering Type: `date` isClosed: type: boolean description: |- Indicates if the brunch hours are "closed" on on the given date. Filtering Type: `boolean` isRegularHours: type: boolean description: |- Indicates whether the holiday hours are the same as the regular business hours for the given date. If set to true, we will update the holiday hours if the regular business hours change for the date's day of the week. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is open on the specified date. Filtering Type: `list of object` description: 'Filtering Type: `object`' monday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the brunch hours are "closed" on Monday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is open for brunch on Monday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' reopenDate: format: date type: string description: |- Date must be on or after 1970-01-01 Date must be before or on 2038-01-01 Filtering Type: `date` saturday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the brunch hours are "closed" on Saturday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is open for brunch on Saturday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' sunday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the brunch hours are "closed" on Sunday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is open for brunch on Sunday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' thursday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the brunch hours are "closed" on Thursday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is open for brunch on Thursday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' tuesday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the brunch hours are "closed" on Tuesday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is open for brunch on Tuesday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' wednesday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the brunch hours are "closed" on Wednesday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is open for brunch on Wednesday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' description: |- Contains the daily brunch hours, holiday brunch hours, and reopen date for the Entity. Each day is represented by a sub-field of `brunchHours`. (e.g. `monday`, `tuesday`, etc.) Open times can be specified per day through the `openIntervals` field and the `isClosed` flag. Similarly, holiday brunch hours are represented by the `holidayHours` sub-field. Setting the `reopenDate` sub-field indicates that the business is temporarily closed and will reopen on the specified date. SPECIAL CASES: * To indicate that an Entity is open 24 hours on a specific day, set start to 00:00 and end to 23:59 in `openIntervals` for that day. * To indicate that an Entity has split hours on a specific day (e.g., open from 9:00 AM to 12:00 PM and again from 1:00 PM to 5:00 PM), supply two or more `openIntervals` values with non-overlapping sets of hours. * If you are providing `openIntervals`, you may not set `isClosed` to true for that day. Filtering Type: `hours` ``` Eligible For: * hotel * location * restaurant ``` businessCenter: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity has a business center. Filtering Type: `option` ``` Eligible For: * hotel ``` calendars: additionalProperties: false type: object properties: ids: description: |- IDs of the Calendars associated with this entity Array must be ordered. Array may have a maximum of 40 elements. Filtering Type: `list of text` uniqueItems: true type: array items: minLength: 0 type: string description: 'Filtering Type: `text`' label: minLength: 0 maxLength: 30 type: string description: |- Label to be used for this entity's Calendars. This label will appear on your entity's listings. Filtering Type: `text` description: |- Information about the events Content Lists (Calendars) associated with this entity Filtering Type: `object` ``` Eligible For: * financialProfessional * healthcareFacility * hotel * location * restaurant ``` carRental: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity offers car rental. Filtering Type: `option` ``` Eligible For: * hotel ``` casino: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity has a casino on premise or nearby. Filtering Type: `option` ``` Eligible For: * hotel ``` categories: additionalProperties: false type: object properties: {} description: |- Yext Categories. (Supported for versions > 20240220) A map of category list external IDs (i.e. "yext") to a list of category IDs. IDs must be valid and selectable (i.e., cannot be parent categories). Partial updates are accepted, meaning sending only the "yext" property will have no effect on any category list except the "yext" category. Filtering Type: `object` ``` Eligible For: * atm * event * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` categoryIds: uniqueItems: false type: array items: minLength: 0 type: string description: 'Filtering Type: `text`' description: |- Yext Category IDs. (Deprecated: For versions > 20240220) 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. Filtering Type: `list of text` ``` Eligible For: * atm * event * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` catsAllowed: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates if the entity is cat friendly. Filtering Type: `option` ``` Eligible For: * hotel ``` certifications: description: |- A list of the certifications held by the healthcare professional **NOTE:** This field is only available to locations whose **`entityType`** is `healthcareProfessional`. Array must be ordered. Array may have a maximum of 100 elements. Array item description: >Cannot Include: >* HTML markup Filtering Type: `list of text` ``` Eligible For: * financialProfessional * healthcareProfessional ``` uniqueItems: true type: array items: minLength: 0 maxLength: 200 type: string description: |- Cannot Include: * HTML markup Filtering Type: `text` checkInTime: format: time type: string description: |- The check-in time Filtering Type: `time` ``` Eligible For: * hotel ``` checkOutTime: format: time type: string description: |- The check-out time Filtering Type: `time` ``` Eligible For: * hotel ``` classificationRating: pattern: ^\d*\.?\d*$ type: string description: |- The 1 to 5 star rating of the entitiy based on its services and facilities. Filtering Type: `decimal` ``` Eligible For: * hotel ``` closed: type: boolean description: |- Indicates whether the entity is closed Filtering Type: `boolean` ``` Eligible For: * atm * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` concierge: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity offers concierge service. Filtering Type: `option` ``` Eligible For: * hotel ``` conditionsTreated: description: |- A list of the conditions treated by the healthcare provider Array must be ordered. Array may have a maximum of 100 elements. Array item description: >Cannot Include: >* HTML markup Filtering Type: `list of text` ``` Eligible For: * healthcareFacility * healthcareProfessional ``` uniqueItems: true type: array items: minLength: 0 maxLength: 100 type: string description: |- Cannot Include: * HTML markup Filtering Type: `text` convenienceStore: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity has a convenience store. Filtering Type: `option` ``` Eligible For: * hotel ``` covidMessaging: minLength: 0 maxLength: 15000 type: string description: |- Information or messaging related to COVID-19. Filtering Type: `text` ``` Eligible For: * healthcareFacility * healthcareProfessional * location ``` covidTestAppointmentUrl: minLength: 0 format: uri type: string description: |- An appointment URL for scheduling a COVID-19 test. Filtering Type: `text` ``` Eligible For: * healthcareFacility * location ``` covidTestingAppointmentRequired: type: boolean description: |- Indicates whether an appointment is required for a COVID-19 test. Filtering Type: `boolean` ``` Eligible For: * healthcareFacility * location ``` covidTestingDriveThroughSite: type: boolean description: |- Indicates whether location is a drive-through site for COVID-19 tests. Filtering Type: `boolean` ``` Eligible For: * healthcareFacility * location ``` covidTestingIsFree: type: boolean description: |- Indicates whether location offers free COVID-19 testing. Filtering Type: `boolean` ``` Eligible For: * healthcareFacility * location ``` covidTestingPatientRestrictions: type: boolean description: |- Indicates whether there are patient restrictions for COVID-19 testing. Filtering Type: `boolean` ``` Eligible For: * healthcareFacility * location ``` covidTestingReferralRequired: type: boolean description: |- Indicates whether a referral is required for COVID-19 testing. Filtering Type: `boolean` ``` Eligible For: * healthcareFacility * location ``` covidTestingSiteInstructions: minLength: 0 maxLength: 15000 type: string description: |- Information or instructions for the COVID-19 testing site. Filtering Type: `text` ``` Eligible For: * healthcareFacility * location ``` covidVaccineAppointmentRequired: type: boolean description: |- Indicates whether an appointment is required for a COVID-19 vaccine. Filtering Type: `boolean` ``` Eligible For: * healthcareFacility * location ``` covidVaccineDriveThroughSite: type: boolean description: |- Indicates whether location is a drive-through site for COVID-19 vaccines. Filtering Type: `boolean` ``` Eligible For: * healthcareFacility * location ``` covidVaccineInformationUrl: minLength: 0 format: uri type: string description: |- An information URL for more information about COVID-19 vaccines. Filtering Type: `text` ``` Eligible For: * healthcareFacility * location ``` covidVaccinePatientRestrictions: type: boolean description: |- Indicates whether there are patient restrictions for a COVID-19 vaccine. Filtering Type: `boolean` ``` Eligible For: * healthcareFacility * location ``` covidVaccineReferralRequired: type: boolean description: |- Indicates whether a referral is required for a COVID-19 vaccine. Filtering Type: `boolean` ``` Eligible For: * healthcareFacility * location ``` covidVaccineSiteInstructions: minLength: 0 maxLength: 15000 type: string description: |- Information or instructions for the COVID-19 vaccination site. Filtering Type: `text` ``` Eligible For: * healthcareFacility * location ``` covidVaccinesOffered: uniqueItems: true type: array items: enum: - PFIZER - MODERNA - JOHNSON_&_JOHNSON type: string description: 'Filtering Type: `option`' description: |- Indicates which COVID-19 vaccines the location offers. Filtering Type: `list of option` ``` Eligible For: * healthcareFacility * location ``` currencyExchange: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity offers currency exchange services. Filtering Type: `option` ``` Eligible For: * hotel ``` customKeywords: description: |- Additional keywords you would like us to use when tracking your search performance Array must be ordered. Array may have a maximum of 5 elements. Filtering Type: `list of text` ``` Eligible For: * atm * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * organization * restaurant ``` uniqueItems: true type: array items: minLength: 0 maxLength: 100 type: string description: 'Filtering Type: `text`' datePosted: format: date type: string description: |- The date this entity was posted Filtering Type: `date` ``` Eligible For: * job ``` degrees: description: |- A list of the degrees earned by the healthcare professional Array must be ordered. Filtering Type: `list of option` ``` Eligible For: * healthcareProfessional ``` uniqueItems: true type: array items: enum: - ANP - APN - APRN - ARNP - AUD - BSW - CCCA - CNM - CNP - CNS - CPNP - CRNA - CRNP - DC - DDS - DMD - DNP - DO - DPM - DPT - DSW - DVM - FNP - GNP - LAC - LCSW - LPN - MBA - MBBS - MD - MPAS - MPH - MSW - ND - NNP - NP - OD - PA - PAC - PHARMD - PHD - PNP - PSYD - RD - RSW - VMD - WHNP type: string description: 'Filtering Type: `option`' deliveryHours: additionalProperties: false type: object properties: friday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the delivery hours are "closed" on Friday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is delivering on Friday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' holidayHours: description: |- **NOTE:** The list of Holiday Hours that you send us must be comprehensive. For example, if you send us a list of Holiday Hours that does not include Holiday Hours that you sent in your last update, Yext considers the missing Holiday Hours to be deleted, and we remove them. Array must be ordered. Filtering Type: `list of object` uniqueItems: true type: array items: required: - date additionalProperties: false type: object properties: date: format: date type: string description: |- Date on which the holiday hours will be in effect. Cannot be in the past. Date must be on or after 1970-01-01 Date must be before or on 2038-01-01 Filtering Type: `date` isClosed: type: boolean description: |- Indicates if the delivery hours are "closed" on on the given date. Filtering Type: `boolean` isRegularHours: type: boolean description: |- Indicates whether the holiday hours are the same as the regular business hours for the given date. If set to true, we will update the holiday hours if the regular business hours change for the date's day of the week. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is delivering on the specified date. Filtering Type: `list of object` description: 'Filtering Type: `object`' monday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the delivery hours are "closed" on Monday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is delivering on Monday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' reopenDate: format: date type: string description: |- Date must be on or after 1970-01-01 Date must be before or on 2038-01-01 Filtering Type: `date` saturday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the delivery hours are "closed" on Saturday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is delivering on Saturday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' sunday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the delivery hours are "closed" on Sunday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is delivering on Sunday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' thursday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the delivery hours are "closed" on Thursday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is delivering on Thursday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' tuesday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the delivery hours are "closed" on Tuesday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is delivering on Tuesday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' wednesday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the delivery hours are "closed" on Wednesday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is delivering on Wednesday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' description: |- Contains the daily delivery hours, holiday delivery hours, and reopen date for the Entity. Each day is represented by a sub-field of `deliveryHours`. (e.g. `monday`, `tuesday`, etc.) Open times can be specified per day through the `openIntervals` field and the `isClosed` flag. Similarly, holiday delivery hours are represented by the `holidayHours` sub-field. Setting the `reopenDate` sub-field indicates that the business is temporarily closed and will reopen on the specified date. SPECIAL CASES: * To indicate that an Entity is open 24 hours on a specific day, set start to 00:00 and end to 23:59 in `openIntervals` for that day. * To indicate that an Entity has split hours on a specific day (e.g., open from 9:00 AM to 12:00 PM and again from 1:00 PM to 5:00 PM), supply two or more `openIntervals` values with non-overlapping sets of hours. * If you are providing `openIntervals`, you may not set `isClosed` to true for that day. Filtering Type: `hours` ``` Eligible For: * location * restaurant ``` description: minLength: 10 maxLength: 15000 type: string description: |- A description of the entity Cannot Include: * HTML markup Filtering Type: `text` ``` Eligible For: * atm * contactCard * event * financialProfessional * healthcareFacility * healthcareProfessional * hotel * job * location * organization * restaurant ``` displayCoordinate: additionalProperties: false type: object properties: latitude: minimum: -90 maximum: 90 type: number description: 'Filtering Type: `float`' longitude: minimum: -180 maximum: 180 type: number description: 'Filtering Type: `float`' description: |- Coordinates where the map pin for the entity should be displayed, as provided by you Filtering Type: `object` ``` Eligible For: * atm * event * financialProfessional * healthcareFacility * healthcareProfessional * hotel * job * location * restaurant ``` doctorOnCall: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity has a doctor on premise or on call. Filtering Type: `option` ``` Eligible For: * hotel ``` dogsAllowed: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates if the entity is dog friendly. Filtering Type: `option` ``` Eligible For: * hotel ``` driveThroughHours: additionalProperties: false type: object properties: friday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the drive-through hours are "closed" on Friday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity's drive-through is open on Friday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' holidayHours: description: |- **NOTE:** The list of Holiday Hours that you send us must be comprehensive. For example, if you send us a list of Holiday Hours that does not include Holiday Hours that you sent in your last update, Yext considers the missing Holiday Hours to be deleted, and we remove them. Array must be ordered. Filtering Type: `list of object` uniqueItems: true type: array items: required: - date additionalProperties: false type: object properties: date: format: date type: string description: |- Date on which the holiday hours will be in effect. Cannot be in the past. Date must be on or after 1970-01-01 Date must be before or on 2038-01-01 Filtering Type: `date` isClosed: type: boolean description: |- Indicates if the drive-through hours are "closed" on on the given date. Filtering Type: `boolean` isRegularHours: type: boolean description: |- Indicates whether the holiday hours are the same as the regular business hours for the given date. If set to true, we will update the holiday hours if the regular business hours change for the date's day of the week. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity's drive-through is open on the specified date. Filtering Type: `list of object` description: 'Filtering Type: `object`' monday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the drive-through hours are "closed" on Monday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity's drive-through is open on Monday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' reopenDate: format: date type: string description: |- Date must be on or after 1970-01-01 Date must be before or on 2038-01-01 Filtering Type: `date` saturday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the drive-through hours are "closed" on Saturday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity's drive-through is open on Saturday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' sunday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the drive-through hours are "closed" on Sunday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity's drive-through is open on Sunday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' thursday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the drive-through hours are "closed" on Thursday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity's drive-through is open on Thursday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' tuesday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the drive-through hours are "closed" on Tuesday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity's drive-through is open on Tuesday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' wednesday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the drive-through hours are "closed" on Wednesday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity's drive-through is open on Wednesday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' description: |- Contains the daily drive-through hours, holiday drive-through hours, and reopen date for the Entity. Each day is represented by a sub-field of `driveThroughHours`. (e.g. `monday`, `tuesday`, etc.) Open times can be specified per day through the `openIntervals` field and the `isClosed` flag. Similarly, holiday drive-through hours are represented by the `holidayHours` sub-field. Setting the `reopenDate` sub-field indicates that the business is temporarily closed and will reopen on the specified date. SPECIAL CASES: * To indicate that an Entity is open 24 hours on a specific day, set start to 00:00 and end to 23:59 in `openIntervals` for that day. * To indicate that an Entity has split hours on a specific day (e.g., open from 9:00 AM to 12:00 PM and again from 1:00 PM to 5:00 PM), supply two or more `openIntervals` values with non-overlapping sets of hours. * If you are providing `openIntervals`, you may not set `isClosed` to true for that day. Filtering Type: `hours` ``` Eligible For: * atm * location * restaurant ``` dropoffCoordinate: additionalProperties: false type: object properties: latitude: minimum: -90 maximum: 90 type: number description: 'Filtering Type: `float`' longitude: minimum: -180 maximum: 180 type: number description: 'Filtering Type: `float`' description: |- Coordinates of the drop-off area for the entity, as provided by you Filtering Type: `object` ``` Eligible For: * atm * event * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` educationList: description: |- Information about the education or training completed by the healthcare professional Array must be ordered. Filtering Type: `list of object` ``` Eligible For: * healthcareProfessional ``` uniqueItems: true type: array items: required: - type - institutionName - yearCompleted additionalProperties: false type: object properties: institutionName: minLength: 0 maxLength: 100 type: string description: 'Filtering Type: `text`' type: enum: - FELLOWSHIP - RESIDENCY - INTERNSHIP - MEDICAL_SCHOOL type: string description: 'Filtering Type: `option`' yearCompleted: multipleOf: 1 minimum: 1900 maximum: 2100 type: number description: 'Filtering Type: `integer`' description: 'Filtering Type: `object`' electricChargingStation: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity has electric car chargine stations on premise. Filtering Type: `option` ``` Eligible For: * hotel ``` elevator: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity has an elevator. Filtering Type: `option` ``` Eligible For: * hotel ``` ellipticalMachine: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity has an elliptical machine. Filtering Type: `option` ``` Eligible For: * hotel ``` emails: description: |- Emails addresses for this entity's point of contact Must be valid email addresses Array must be ordered. Array may have a maximum of 5 elements. Filtering Type: `list of text` ``` Eligible For: * contactCard * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * organization * restaurant ``` uniqueItems: true type: array items: minLength: 0 format: email type: string description: 'Filtering Type: `text`' employmentType: enum: - FULL_TIME - PART_TIME - CONTRACTOR - TEMPORARY - INTERN - VOLUNTEER - PER_DIEM - OTHER type: string description: |- The employment type for the open job. Indicates whether the job is full-time, part-time, temporary, etc. Filtering Type: `option` ``` Eligible For: * job ``` eventStatus: enum: - SCHEDULED - RESCHEDULED - POSTPONED - CANCELED - EVENT_MOVED_ONLINE type: string description: |- Information on whether the event will take place as scheduled Filtering Type: `option` ``` Eligible For: * event ``` facebookAbout: minLength: 0 maxLength: 255 type: string description: |- A description of the entity to be used in the "About You" section on Facebook Filtering Type: `text` ``` Eligible For: * atm * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` facebookCallToAction: required: - type additionalProperties: false type: object properties: type: enum: - NONE - BOOK_NOW - CALL_NOW - CONTACT_US - SEND_MESSAGE - USE_APP - PLAY_GAME - SHOP_NOW - SIGN_UP - WATCH_VIDEO - SEND_EMAIL - LEARN_MORE - PURCHASE_GIFT_CARDS - ORDER_NOW - FOLLOW_PAGE type: string description: |- The action the consumer is being prompted to take by the button's text Filtering Type: `option` value: minLength: 0 type: string description: |- Indicates where consumers will be directed to upon clicking the Call-to-Action button (e.g., a URL). It can be a free-form string or an embedded value, depending on what the user specifies. For example, if the user sets the Facebook Call-to-Action as " 'Sign Up' using 'Website URL' " in the Yext platform, **`type`** will be `SIGN_UP` and **`value`** will be `[[websiteUrl]]`. The Call-to-Action will have the same behavior if the user sets the value to "Custom Value" in the platform and embeds a field. Filtering Type: `text` description: |- Designates the Facebook Call-to-Action button text and value Valid contents of **`value`** depends on the Call-to-Action's **`type`**: * `NONE`: (optional) * `BOOK_NOW`: URL * `CALL_NOW`: Phone number * `CONTACT_US`: URL * `SEND_MESSAGE`: Any string * `USE_APP`: URL * `PLAY_GAME`: URL * `SHOP_NOW`: URL * `SIGN_UP`: URL * `WATCH_VIDEO`: URL * `SEND_EMAIL`: Email address * `LEARN_MORE`: URL * `PURCHASE_GIFT_CARDS`: URL * `ORDER_NOW`: URL * `FOLLOW_PAGE`: Any string Filtering Type: `object` ``` Eligible For: * atm * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` facebookCoverPhoto: required: - url additionalProperties: false type: object description: |- The cover photo for the entity's Facebook profile Displayed as a 851 x 315 pixel image You may need a cover photo in order for your listing to appear on Facebook. Please check your listings tab to learn more. Image must be at least 400 x 150 pixels Image area (width x height) may be no more than 41000000 pixels Image may be no more than 30000 x 30000 pixels Supported Aspect Ratios: * 1 x 1 * 4 x 3 * 3 x 2 * 5 x 3 * 16 x 9 * 3 x 1 * 2 x 3 * 5 x 7 * 4 x 5 * 4 x 1 **NOTE**: Maximum image size is 5mb after normalization and padding (if applicable). As well, there is a 6 second download limit from the image host. Filtering Type: `object` ``` Eligible For: * atm * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` properties: alternateText: minLength: 0 type: string description: 'Filtering Type: `text`' url: minLength: 0 format: uri type: string description: 'Filtering Type: `text`' facebookDescriptor: minLength: 3 maxLength: 75 type: string description: |- Location Descriptors are used for Enterprise businesses that sync Facebook listings using brand page location structure. The Location Descriptor is typically an additional geographic description (e.g. geomodifier) that will appear in parentheses after the name on the Facebook listing. Cannot Include: * HTML markup Filtering Type: `text` ``` Eligible For: * atm * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` facebookName: minLength: 0 type: string description: |- The name for this entity's Facebook profile. A separate name may be specified to send only to Facebook in order to comply with any specific Facebook rules or naming conventions. Filtering Type: `text` ``` Eligible For: * atm * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` facebookOverrideCity: minLength: 0 type: string description: |- The city to be displayed on this entity's Facebook profile Filtering Type: `text` ``` Eligible For: * atm * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` facebookPageUrl: minLength: 0 type: string description: |- URL for the entity's Facebook Page. Valid formats: - facebook.com/profile.php?id=[numId] - facebook.com/group.php?gid=[numId] - facebook.com/groups/[numId] - facebook.com/[Name] - facebook.com/pages/[Name]/[numId] - facebook.com/people/[Name]/[numId] where [Name] is a String and [numId] is an Integer The success response will contain a warning message explaining why the URL wasn't stored in the system. Filtering Type: `text` ``` Eligible For: * atm * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * organization * restaurant ``` facebookParentPageId: minLength: 0 maxLength: 65 type: string description: |- The Facebook Page ID of this entity's brand page if in a brand page location structure Filtering Type: `text` ``` Eligible For: * atm * brand * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` facebookProfilePhoto: required: - url additionalProperties: false type: object description: |- The profile picture for the entity's Facebook profile You must have a profile picture in order for your listing to appear on Facebook. Image must be at least 180 x 180 pixels Image area (width x height) may be no more than 41000000 pixels Image may be no more than 30000 x 30000 pixels Supported Aspect Ratios: * 1 x 1 * 4 x 3 * 3 x 2 * 5 x 3 * 16 x 9 * 3 x 1 * 2 x 3 * 5 x 7 * 4 x 5 * 4 x 1 **NOTE**: Maximum image size is 5mb after normalization and padding (if applicable). As well, there is a 6 second download limit from the image host. Filtering Type: `object` ``` Eligible For: * atm * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` properties: alternateText: minLength: 0 type: string description: 'Filtering Type: `text`' url: minLength: 0 format: uri type: string description: 'Filtering Type: `text`' facebookStoreId: minLength: 0 type: string description: |- The Store ID used for this entity in a brand page location structure Filtering Type: `text` ``` Eligible For: * atm * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` facebookVanityUrl: minLength: 0 maxLength: 50 type: string description: |- The username that appear's in the Facebook listing URL to help customers find and remember a brand’s Facebook page. The username is also be used for tagging the Facebook page in other users’ posts, and searching for the Facebook page. Filtering Type: `text` ``` Eligible For: * atm * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` facebookWebsiteOverride: minLength: 0 format: uri type: string description: |- The URL you would like to submit to Facebook in place of the one given in **`websiteUrl`** (if applicable). Filtering Type: `text` ``` Eligible For: * atm * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` fax: minLength: 0 type: string description: |- Must be a valid fax number. If the fax number's calling code is for a country other than the one given in the entity's **`countryCode`**, the fax number provided must contain the calling code (e.g., `+44` in `+442038083831`). Otherwise, the calling code is optional. Filtering Type: `text` ``` Eligible For: * atm * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` featuredMessage: additionalProperties: false type: object properties: description: minLength: 0 maxLength: 50 type: string description: |- The text of Featured Message. Default: `Call today!` Cannot include: - inappropriate language - HTML markup - a URL or domain name - a phone number - control characters ([\x00-\x1F\x7F]) - insufficient spacing If you submit a Featured Message that contains profanity or more than 50 characters, it will be ignored. The success response will contain a warning message explaining why your Featured Message wasn't stored in the system. Cannot Include: * HTML markup Filtering Type: `text` url: minLength: 0 maxLength: 255 format: uri type: string description: |- Valid URL linked to the Featured Message text Filtering Type: `text` description: |- Information about the entity's Featured Message Filtering Type: `object` ``` Eligible For: * atm * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` firstName: minLength: 0 maxLength: 35 type: string description: |- The first name of the healthcare professional Cannot Include: * a URL or domain name * HTML markup Filtering Type: `text` ``` Eligible For: * healthcareProfessional ``` firstPartyReviewPage: minLength: 0 type: string description: |- Link to the review-collection page, where consumers can leave first-party reviews ``` Eligible For: * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` fitnessCenter: enum: - FITNESS_CENTER_AVAILABLE - FITNESS_CENTER_AVAILABLE_FOR_FREE - NOT_APPLICABLE type: string description: |- Indicates whether the entity has a fitness center. Filtering Type: `option` ``` Eligible For: * hotel ``` floorCount: multipleOf: 1 minimum: 0 type: number description: |- The number of floors the entity has from ground floor to top floor. Filtering Type: `integer` ``` Eligible For: * hotel ``` freeWeights: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity has free weights. Filtering Type: `option` ``` Eligible For: * hotel ``` frequentlyAskedQuestions: description: |- A list of questions that are frequently asked about this entity Array must be ordered. Array may have a maximum of 100 elements. Filtering Type: `list of object` ``` Eligible For: * atm * event * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` uniqueItems: true type: array items: required: - question additionalProperties: false type: object properties: answer: minLength: 1 maxLength: 4096 type: string description: 'Filtering Type: `text`' question: minLength: 1 maxLength: 4096 type: string description: 'Filtering Type: `text`' description: 'Filtering Type: `object`' frontDesk: enum: - FRONT_DESK_AVAILABLE - FRONT_DESK_AVAILABLE_24_HOURS - NOT_APPLICABLE type: string description: |- Indicates whether the entity has a front desk. Filtering Type: `option` ``` Eligible For: * hotel ``` fullyVaccinatedStaff: type: boolean description: |- Indicates whether the staff is vaccinated against COVID-19. Filtering Type: `boolean` ``` Eligible For: * healthcareFacility * hotel * location * restaurant ``` gameRoom: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity has a game room. Filtering Type: `option` ``` Eligible For: * hotel ``` gender: enum: - UNSPECIFIED - FEMALE - MALE - NONBINARY - TRANSGENDER_FEMALE - TRANSGENDER_MALE - OTHER - PREFER_NOT_TO_DISCLOSE type: string description: |- The gender of the healthcare professional Filtering Type: `option` ``` Eligible For: * healthcareProfessional ``` geomodifier: minLength: 0 type: string description: |- Provides additional information on where the entity can be found (e.g., `Times Square`, `Global Center Mall`) Filtering Type: `text` ``` Eligible For: * atm * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` giftShop: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity has a gift shop. Filtering Type: `option` ``` Eligible For: * hotel ``` golf: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity has a golf couse on premise or nearby. The golf course may be independently run. Filtering Type: `option` ``` Eligible For: * hotel ``` googleAttributes: additionalProperties: false type: object properties: {} description: |- The unique IDs of the entity's Google Business Profile keywords, as well as the unique IDs of any values selected for each keyword. Valid keywords (e.g., `has_drive_through`, `has_fitting_room`, `kitchen_in_room`) are determined by the entity's primary category. A full list of keywords can be retrieved with the Google Fields: List endpoint. Keyword values provide more details on how the keyword applies to the entity (e.g., if the keyword is `has_drive_through`, its values may be `true` or `false`). * If the **`v`** parameter is before `20181204`: **`googleAttributes`** is formatted as a map of key-value pairs (e.g., `[{ "id": "has_wheelchair_accessible_entrance", "values": [ "true" ] }]`) * If the **`v`** parameter is on or after `20181204`: the contents are formatted as a list of objects (e.g., `{ "has_wheelchair_accessible_entrance": [ "true" ]}`) **NOTE:** The latest Google Attributes are available via the Google Fields: List endpoint. Google Attributes are managed by Google and are subject to change without notice. To prevent errors, make sure your API implementation is not dependent on the presence of specific attributes. Filtering Type: `object` ``` Eligible For: * atm * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` googleCoverPhoto: required: - url additionalProperties: false type: object description: |- The cover photo for the entity's Google profile Image must be at least 250 x 250 pixels Filtering Type: `object` ``` Eligible For: * atm * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` properties: alternateText: minLength: 0 type: string description: 'Filtering Type: `text`' url: minLength: 0 format: uri type: string description: 'Filtering Type: `text`' googleMessaging: additionalProperties: false type: object properties: smsNumber: minLength: 0 type: string description: |- The SMS phone number of the entity's point of contact for messaging/ chat functionality. Must be a valid phone number. If the phone number's calling code is for a country other than the one given in the entity's countryCode, the phone number provided must contain the calling code (e.g., +44 in +442038083831). Otherwise, the calling code is optional. Filtering Type: `text` whatsappMessagingUrl: minLength: 0 maxLength: 2000 format: uri type: string description: |- A valid URL for this entity's WhatsApp account. Must be a valid URL Filtering Type: `text` description: |- Information about Google Messaging, WhatsApp and SMS, for the entity’s point of contact for messaging/chat functionality. NOTE: Only one, either WhatsApp or SMS is displayed on the Google listing. If both SMS Number and WhatsApp URL are provided only SMS Number will be displayed on the listing. Filtering Type: `object` ``` Eligible For: * atm * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` googleMyBusinessLabels: description: |- Google Business Profile Labels help users organize their locations into groups within GBP. Array must be ordered. Array may have a maximum of 10 elements. Array item description: >Cannot Include: >* HTML markup Filtering Type: `list of text` ``` Eligible For: * atm * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` uniqueItems: true type: array items: minLength: 0 maxLength: 50 type: string description: |- Cannot Include: * HTML markup Filtering Type: `text` googlePlaceId: minLength: 0 type: string description: |- The unique identifier of this entity on Google Maps. Filtering Type: `text` ``` Eligible For: * atm * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` googleProfilePhoto: required: - url additionalProperties: false type: object description: |- The profile photo for the entity's Google profile Image must be at least 250 x 250 pixels Image may be no more than 5000 x 5000 pixels Supported Aspect Ratios: * 1 x 1 **NOTE**: Maximum image size is 5mb after normalization and padding (if applicable). As well, there is a 6 second download limit from the image host. Filtering Type: `object` ``` Eligible For: * atm * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` properties: alternateText: minLength: 0 type: string description: 'Filtering Type: `text`' url: minLength: 0 format: uri type: string description: 'Filtering Type: `text`' googleWebsiteOverride: minLength: 0 format: uri type: string description: |- 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. Filtering Type: `text` ``` Eligible For: * atm * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` happyHours: additionalProperties: false type: object properties: friday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the happy hours are "closed" on Friday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity's happy hours on Friday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' holidayHours: description: |- **NOTE:** The list of Holiday Hours that you send us must be comprehensive. For example, if you send us a list of Holiday Hours that does not include Holiday Hours that you sent in your last update, Yext considers the missing Holiday Hours to be deleted, and we remove them. Array must be ordered. Filtering Type: `list of object` uniqueItems: true type: array items: required: - date additionalProperties: false type: object properties: date: format: date type: string description: |- Date on which the holiday hours will be in effect. Cannot be in the past. Date must be on or after 1970-01-01 Date must be before or on 2038-01-01 Filtering Type: `date` isClosed: type: boolean description: |- Indicates if the happy hours are "closed" on on the given date. Filtering Type: `boolean` isRegularHours: type: boolean description: |- Indicates whether the holiday hours are the same as the regular business hours for the given date. If set to true, we will update the holiday hours if the regular business hours change for the date's day of the week. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for the Entity's happy hours on the specified date. Filtering Type: `list of object` description: 'Filtering Type: `object`' monday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the happy hours are "closed" on Monday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for the Entity's happy hours on Monday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' reopenDate: format: date type: string description: |- Date must be on or after 1970-01-01 Date must be before or on 2038-01-01 Filtering Type: `date` saturday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the happy hours are "closed" on Saturday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for the Entity's happy hours on Saturday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' sunday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the happy hours are "closed" on Sunday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for the Entity's happy hours on Sunday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' thursday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the happy hours are "closed" on Thursday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for the Entity's happy hours on Thursday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' tuesday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the happy hours are "closed" on Tuesday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for the Entity's happy hours on Tuesday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' wednesday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the happy hours are "closed" on Wednesday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for the Entity's happy hours on Wednesday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' description: |- Contains the daily happy hours, holiday happy hours, and reopen date for the Entity. Each day is represented by a sub-field of `happyHours`. (e.g. `monday`, `tuesday`, etc.) Open times can be specified per day through the `openIntervals` field and the `isClosed` flag. Similarly, holiday happy hours are represented by the `holidayHours` sub-field. Setting the `reopenDate` sub-field indicates that the business is temporarily closed and will reopen on the specified date. SPECIAL CASES: * To indicate that an Entity is open 24 hours on a specific day, set start to 00:00 and end to 23:59 in `openIntervals` for that day. * To indicate that an Entity has split hours on a specific day (e.g., open from 9:00 AM to 12:00 PM and again from 1:00 PM to 5:00 PM), supply two or more `openIntervals` values with non-overlapping sets of hours. * If you are providing `openIntervals`, you may not set `isClosed` to true for that day. Filtering Type: `hours` ``` Eligible For: * hotel * location * restaurant ``` headshot: required: - url additionalProperties: false type: object description: |- A portrait of the healthcare professional Filtering Type: `object` ``` Eligible For: * contactCard * financialProfessional * healthcareProfessional ``` properties: alternateText: minLength: 0 type: string description: 'Filtering Type: `text`' url: minLength: 0 format: uri type: string description: 'Filtering Type: `text`' hiringOrganization: minLength: 0 type: string description: |- The organization that is hiring for the open job Filtering Type: `text` ``` Eligible For: * job ``` holidayHoursConversationEnabled: type: boolean description: |- Indicates whether holiday-hour confirmation alerts are enabled for the Yext Knowledge Assistant for this entity Filtering Type: `boolean` ``` Eligible For: * atm * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` horsebackRiding: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity offers horseback riding. Filtering Type: `option` ``` Eligible For: * hotel ``` hotTub: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity has a hot tub. Filtering Type: `option` ``` Eligible For: * hotel ``` hours: additionalProperties: false type: object properties: friday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the hours of operation are "closed" on Friday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is open on Friday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' holidayHours: description: |- **NOTE:** The list of Holiday Hours that you send us must be comprehensive. For example, if you send us a list of Holiday Hours that does not include Holiday Hours that you sent in your last update, Yext considers the missing Holiday Hours to be deleted, and we remove them. Array must be ordered. Filtering Type: `list of object` uniqueItems: true type: array items: required: - date additionalProperties: false type: object properties: date: format: date type: string description: |- Date on which the holiday hours will be in effect. Cannot be in the past. Date must be on or after 1970-01-01 Date must be before or on 2038-01-01 Filtering Type: `date` isClosed: type: boolean description: |- Indicates if the hours of operation are "closed" on on the given date. Filtering Type: `boolean` isRegularHours: type: boolean description: |- Indicates whether the holiday hours are the same as the regular business hours for the given date. If set to true, we will update the holiday hours if the regular business hours change for the date's day of the week. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is open on the specified date. Filtering Type: `list of object` description: 'Filtering Type: `object`' monday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the hours of operation are "closed" on Monday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is open on Monday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' reopenDate: format: date type: string description: |- Date must be on or after 1970-01-01 Date must be before or on 2038-01-01 Filtering Type: `date` saturday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the hours of operation are "closed" on Saturday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is open on Saturday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' sunday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the hours of operation are "closed" on Sunday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is open on Sunday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' thursday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the hours of operation are "closed" on Thursday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is open on Thursday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' tuesday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the hours of operation are "closed" on Tuesday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is open on Tuesday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' wednesday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the hours of operation are "closed" on Wednesday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is open on Wednesday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' description: |- Contains the daily hours, holiday hours, and reopen date for the Entity. Each day is represented by a sub-field of `hours`. (e.g. `monday`, `tuesday`, etc.) Open times can be specified per day through the `openIntervals` field and the `isClosed` flag. Similarly, holiday hours are represented by the `holidayHours` sub-field. Setting the `reopenDate` sub-field indicates that the business is temporarily closed and will reopen on the specified date. SPECIAL CASES: * To indicate that an Entity is open 24 hours on a specific day, set start to 00:00 and end to 23:59 in `openIntervals` for that day. * To indicate that an Entity has split hours on a specific day (e.g., open from 9:00 AM to 12:00 PM and again from 1:00 PM to 5:00 PM), supply two or more `openIntervals` values with non-overlapping sets of hours. * If you are providing `openIntervals`, you may not set `isClosed` to true for that day. Filtering Type: `hours` ``` Eligible For: * atm * contactCard * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` housekeeping: enum: - HOUSEKEEPING_AVAILABLE - HOUSEKEEPING_AVAILABLE_DAILY - NOT_APPLICABLE type: string description: |- Indicates whether the entity offers housekeeping services. Filtering Type: `option` ``` Eligible For: * hotel ``` impressum: minLength: 0 maxLength: 2000 type: string description: |- A statement of the ownership and authorship of a document. Individuals or organizations based in many German-speaking countries are required by law to include an Impressum in published media. Filtering Type: `text` ``` Eligible For: * atm * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` indoorPoolCount: multipleOf: 1 minimum: 0 type: number description: |- A count of the number of indoor pools Filtering Type: `integer` ``` Eligible For: * hotel ``` instagramHandle: minLength: 0 maxLength: 30 type: string description: |- Valid Instagram username for the entity without the leading "@" (e.g., `NewCityAuto`) Filtering Type: `text` ``` Eligible For: * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * organization * restaurant ``` insuranceAccepted: description: |- A list of insurance policies accepted by the healthcare provider Array must be ordered. Array may have a maximum of 100 elements. Array item description: >Cannot Include: >* HTML markup Filtering Type: `list of text` ``` Eligible For: * healthcareFacility * healthcareProfessional ``` uniqueItems: true type: array items: minLength: 0 maxLength: 100 type: string description: |- Cannot Include: * HTML markup Filtering Type: `text` iosAppUrl: minLength: 0 type: string description: |- The URL where consumers can download the entity's app to their iPhone or iPad Filtering Type: `text` ``` Eligible For: * brand * financialProfessional * hotel * location * restaurant ``` isClusterPrimary: type: boolean description: |- Indicates whether the healthcare entity is the primary entity in its group Filtering Type: `boolean` ``` Eligible For: * healthcareProfessional ``` isFreeEvent: type: boolean description: |- Indicates whether or not the event is free Filtering Type: `boolean` ``` Eligible For: * event ``` isoRegionCode: minLength: 0 type: string description: |- The ISO 3166-2 region code for the entity Yext will determine the entity's code and update **`isoRegionCode`** with that value. If Yext is unable to determine the code for the entity, the entity'ss ISO 3166-1 alpha-2 country code will be used. Filtering Type: `text` ``` Eligible For: * atm * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` keywords: description: |- Keywords that describe the entity. All strings must be non-empty when trimmed of whitespace. Array must be ordered. Array may have a maximum of 100 elements. Array item description: >Cannot Include: >* HTML markup Filtering Type: `list of text` ``` Eligible For: * atm * card * event * faq * financialProfessional * healthcareFacility * healthcareProfessional * helpArticle * hotel * job * location * product * restaurant ``` uniqueItems: true type: array items: minLength: 0 maxLength: 100 type: string description: |- Cannot Include: * HTML markup Filtering Type: `text` kidFriendly: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates if the entity is kid friendly. Filtering Type: `option` ``` Eligible For: * hotel ``` kidsClub: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates if the property has a Kids Club. Filtering Type: `option` ``` Eligible For: * hotel ``` kidsStayFree: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity allows kids to stay free. Filtering Type: `option` ``` Eligible For: * hotel ``` kitchenHours: additionalProperties: false type: object properties: friday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the kitchen hours are "closed" on Friday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity's kitchen is open on Friday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' holidayHours: description: |- **NOTE:** The list of Holiday Hours that you send us must be comprehensive. For example, if you send us a list of Holiday Hours that does not include Holiday Hours that you sent in your last update, Yext considers the missing Holiday Hours to be deleted, and we remove them. Array must be ordered. Filtering Type: `list of object` uniqueItems: true type: array items: required: - date additionalProperties: false type: object properties: date: format: date type: string description: |- Date on which the holiday hours will be in effect. Cannot be in the past. Date must be on or after 1970-01-01 Date must be before or on 2038-01-01 Filtering Type: `date` isClosed: type: boolean description: |- Indicates if the kitchen hours are "closed" on on the given date. Filtering Type: `boolean` isRegularHours: type: boolean description: |- Indicates whether the holiday hours are the same as the regular business hours for the given date. If set to true, we will update the holiday hours if the regular business hours change for the date's day of the week. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity's kitchen is open on the specified date. Filtering Type: `list of object` description: 'Filtering Type: `object`' monday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the kitchen hours are "closed" on Monday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity's kitchen is open on Monday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' reopenDate: format: date type: string description: |- Date must be on or after 1970-01-01 Date must be before or on 2038-01-01 Filtering Type: `date` saturday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the kitchen hours are "closed" on Saturday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity's kitchen is open on Saturday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' sunday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the kitchen hours are "closed" on Sunday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity's kitchen is open on Sunday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' thursday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the kitchen hours are "closed" on Thursday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity's kitchen is open on Thursday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' tuesday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the kitchen hours are "closed" on Tuesday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity's kitchen open on Tuesday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' wednesday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the kitchen hours are "closed" on Wednesday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity's kitchen is open on Wednesday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' description: |- Contains the daily kitchen hours, holiday kitchen hours, and reopen date for the Entity. Each day is represented by a sub-field of `kitchenHours`. (e.g. `monday`, `tuesday`, etc.) Open times can be specified per day through the `openIntervals` field and the `isClosed` flag. Similarly, holiday kitchen hours are represented by the `holidayHours` sub-field. Setting the `reopenDate` sub-field indicates that the business is temporarily closed and will reopen on the specified date. SPECIAL CASES: * To indicate that an Entity is open 24 hours on a specific day, set start to 00:00 and end to 23:59 in `openIntervals` for that day. * To indicate that an Entity has split hours on a specific day (e.g., open from 9:00 AM to 12:00 PM and again from 1:00 PM to 5:00 PM), supply two or more `openIntervals` values with non-overlapping sets of hours. * If you are providing `openIntervals`, you may not set `isClosed` to true for that day. Filtering Type: `hours` ``` Eligible For: * hotel * location * restaurant ``` labels: uniqueItems: false type: array items: minLength: 0 type: string description: |- The IDs of the entity labels that have been added to this entity. Entity labels help you identify entities that share a certain characteristic; they do not appear on your entity'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. Filtering Type: `opaque` ``` Eligible For: * atm * board * brand * card * contactCard * event * faq * financialProfessional * healthcareFacility * healthcareProfessional * helpArticle * hotel * hotelRoomType * job * location * organization * product * restaurant ``` landingPageUrl: minLength: 0 format: uri type: string description: |- The URL of this entity's Landing Page that was created with Yext Pages Filtering Type: `text` ``` Eligible For: * atm * card * event * faq * financialProfessional * healthcareFacility * healthcareProfessional * helpArticle * hotel * job * location * product * restaurant ``` languages: description: |- The langauges in which consumers can commicate with this entity or its staff members All strings must be non-empty when trimmed of whitespace. Array must be ordered. Array may have a maximum of 100 elements. Array item description: >Cannot Include: >* HTML markup Filtering Type: `list of text` ``` Eligible For: * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` uniqueItems: true type: array items: minLength: 0 maxLength: 100 type: string description: |- Cannot Include: * HTML markup Filtering Type: `text` lastName: minLength: 0 maxLength: 35 type: string description: |- The last name of the healthcare professional Cannot Include: * a URL or domain name * HTML markup Filtering Type: `text` ``` Eligible For: * healthcareProfessional ``` laundry: enum: - FULL_SERVICE - SELF_SERVICE - NOT_APPLICABLE type: string description: |- Indicates whether the entity offers laundry services. Filtering Type: `option` ``` Eligible For: * hotel ``` lazyRiver: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates if the property has a lazy river Filtering Type: `option` ``` Eligible For: * hotel ``` lifeguard: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates if the property has a lifeguard on duty Filtering Type: `option` ``` Eligible For: * hotel ``` linkedInUrl: minLength: 0 format: uri type: string description: |- URL for your LinkedIn account, format should be https://www.linkedin.com/in/yourUsername Filtering Type: `text` ``` Eligible For: * contactCard * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * organization * restaurant ``` linkedLocation: type: string description: |- location ID of the event location, if the event is held at a location managed in the Yext Knowledge Manager Filtering Type: `entityId` ``` Eligible For: * contactCard * event ``` localPhone: minLength: 0 type: string description: |- Must be a valid, non-toll-free phone number, based on the country specified in **`address.region`**. Phone numbers for US entities must contain 10 digits. Filtering Type: `text` ``` Eligible For: * atm * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` localShuttle: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity offers local shuttle services. Filtering Type: `option` ``` Eligible For: * hotel ``` locatedIn: type: string description: |- For atms, the external ID of the entity that the atm is installed in. The entity must be in the same business account as the atm. Filtering Type: `entityId` ``` Eligible For: * atm ``` location: additionalProperties: false type: object properties: existingLocation: type: string description: |- A location entity referenced by Yext ID or Entity ID where this job opening exists Filtering Type: `entityId` externalLocation: minLength: 0 maxLength: 255 type: string description: |- A location string where this job opening exists Cannot Include: * a URL or domain name * HTML markup Filtering Type: `text` description: |- The location where this job opening exists as either an existing location or an external location Filtering Type: `object` ``` Eligible For: * job ``` locationType: enum: - LOCATION - HEALTHCARE_FACILITY - HEALTHCARE_PROFESSIONAL - ATM - RESTAURANT - HOTEL type: string description: |- Indicates the entity's type, if it is not an event Filtering Type: `option` ``` Eligible For: * atm * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` logo: required: - image additionalProperties: false type: object description: |- An image of the entity's logo Supported Aspect Ratios: * 1 x 1 **NOTE**: Maximum image size is 5mb after normalization and padding (if applicable). As well, there is a 6 second download limit from the image host. Filtering Type: `object` ``` Eligible For: * atm * contactCard * faq * financialProfessional * healthcareFacility * healthcareProfessional * hotel * job * location * organization * restaurant ``` properties: clickthroughUrl: minLength: 0 format: uri type: string description: 'Filtering Type: `text`' description: minLength: 0 type: string description: 'Filtering Type: `text`' details: minLength: 0 type: string description: 'Filtering Type: `text`' image: required: - url additionalProperties: false type: object description: |- Supported Aspect Ratios: * 1 x 1 **NOTE**: Maximum image size is 5mb after normalization and padding (if applicable). As well, there is a 6 second download limit from the image host. Filtering Type: `object` properties: alternateText: minLength: 0 type: string description: 'Filtering Type: `text`' url: minLength: 0 format: uri type: string description: 'Filtering Type: `text`' mainPhone: minLength: 0 type: string description: |- The main phone number of the entity's point of contact Must be a valid phone number. If the phone number's calling code is for a country other than the one given in the entity's **`countryCode`**, the phone number provided must contain the calling code (e.g., `+44` in `+442038083831`). Otherwise, the calling code is optional. Filtering Type: `text` ``` Eligible For: * atm * contactCard * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * organization * restaurant ``` massage: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity offers massage services. Filtering Type: `option` ``` Eligible For: * hotel ``` maxAgeOfKidsStayFree: multipleOf: 1 minimum: 0 type: number description: |- The maximum age specified by the property for children to stay in the room/suite of a parent or adult without an additional fee Filtering Type: `integer` ``` Eligible For: * hotel ``` maxNumberOfKidsStayFree: multipleOf: 1 minimum: 0 type: number description: |- The maximum number of children who can stay in the room/suite of a parent or adult without an additional fee Filtering Type: `integer` ``` Eligible For: * hotel ``` mealsServed: uniqueItems: true type: array items: enum: - BREAKFAST - LUNCH - BRUNCH - DINNER - HAPPY_HOUR - LATE_NIGHT type: string description: 'Filtering Type: `option`' description: |- Types of meals served at this restaurant Filtering Type: `list of option` ``` Eligible For: * restaurant ``` meetingRoomCount: multipleOf: 1 minimum: 0 type: number description: |- The number of meeting rooms the entity has. Filtering Type: `integer` ``` Eligible For: * hotel ``` menuUrl: additionalProperties: false type: object properties: displayUrl: minLength: 0 maxLength: 2000 format: uri type: string description: |- The URL that is shown on your listings in place of **`menuUrl.url`**. You can use **`menuUrl.displayUrl`** to display a short, memorable web address that redirects consumers to the URL given in **`menuUrl.url`**. Filtering Type: `text` preferDisplayUrl: type: boolean description: |- If set to true, only the display URL will be sent to those publishers who do not support separate display and tracking URLs for this field. Filtering Type: `boolean` url: minLength: 0 maxLength: 2000 format: uri type: string description: |- A valid URL where consumers can view the entity's menu Filtering Type: `text` description: |- Information about the URL where consumers can view the entity's menu Filtering Type: `object` ``` Eligible For: * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` menus: additionalProperties: false type: object properties: ids: description: |- IDs of the Menu Lists associated with this entity Array must be ordered. Array may have a maximum of 40 elements. Filtering Type: `list of text` uniqueItems: true type: array items: minLength: 0 type: string description: 'Filtering Type: `text`' label: minLength: 0 maxLength: 30 type: string description: |- Label to be used for this entity's Menu Lists. This label will appear on your entity's listings. Filtering Type: `text` description: |- Information about the Menu Content Lists associated with this entity Filtering Type: `object` ``` Eligible For: * hotel * location * restaurant ``` middleName: minLength: 0 maxLength: 35 type: string description: |- The middle name of the healthcare professional Cannot Include: * a URL or domain name * HTML markup Filtering Type: `text` ``` Eligible For: * healthcareProfessional ``` mobilePhone: minLength: 0 type: string description: |- Must be a valid phone number. If the phone number's calling code is for a country other than the one given in the entity's **`countryCode`**, the phone number provided must contain the calling code (e.g., `+44` in `+442038083831`). Otherwise, the calling code is optional. Filtering Type: `text` ``` Eligible For: * atm * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` mobilityAccessible: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity is mobility/wheelchair accessible Filtering Type: `option` ``` Eligible For: * hotel ``` nightclub: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity has a nightclub. Filtering Type: `option` ``` Eligible For: * hotel ``` npi: minLength: 0 type: string description: |- The National Provider Identifier (NPI) of the healthcare provider Filtering Type: `text` ``` Eligible For: * healthcareFacility * healthcareProfessional ``` nudgeEnabled: type: boolean description: |- Indicates whether Knowledge Nudge is enabled for the Yext Knowledge Assistant for this entity Filtering Type: `boolean` ``` Eligible For: * atm * faq * financialProfessional * healthcareFacility * healthcareProfessional * helpArticle * hotel * job * location * organization * product * restaurant ``` officeName: minLength: 0 type: string description: |- The name of the office where the healthcare professional works, if different from **`name`** Filtering Type: `text` ``` Eligible For: * healthcareProfessional ``` onlineServiceHours: additionalProperties: false type: object properties: friday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the online service hours are "closed" on Friday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for the Entity's online service hours on Friday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' holidayHours: description: |- **NOTE:** The list of Holiday Hours that you send us must be comprehensive. For example, if you send us a list of Holiday Hours that does not include Holiday Hours that you sent in your last update, Yext considers the missing Holiday Hours to be deleted, and we remove them. Array must be ordered. Filtering Type: `list of object` uniqueItems: true type: array items: required: - date additionalProperties: false type: object properties: date: format: date type: string description: |- Date on which the holiday hours will be in effect. Cannot be in the past. Date must be on or after 1970-01-01 Date must be before or on 2038-01-01 Filtering Type: `date` isClosed: type: boolean description: |- Indicates if the online service hours are "closed" on on the given date. Filtering Type: `boolean` isRegularHours: type: boolean description: |- Indicates whether the holiday hours are the same as the regular business hours for the given date. If set to true, we will update the holiday hours if the regular business hours change for the date's day of the week. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for the Entity's online service hours on the specified date. Filtering Type: `list of object` description: 'Filtering Type: `object`' monday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the online service hours are "closed" on Monday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for the Entity's online service hours on Monday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' reopenDate: format: date type: string description: |- Date must be on or after 1970-01-01 Date must be before or on 2038-01-01 Filtering Type: `date` saturday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the online service hours are "closed" on Saturday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for the Entity's online service hours on Saturday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' sunday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the online service hours are "closed" on Sunday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for the Entity's online service hours on Sunday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' thursday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the online service hours are "closed" on Thursday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for the Entity's online service hours on Thursday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' tuesday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the online service hours are "closed" on Tuesday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for the Entity's online service hours on Tuesday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' wednesday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the online service hours are "closed" on Wednesday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for the Entity's online service hours on Wednesday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' description: |- Contains the daily online service hours, holiday online service hours, and reopen date for the Entity. Each day is represented by a sub-field of `onlineServiceHours`. (e.g. `monday`, `tuesday`, etc.) Open times can be specified per day through the `openIntervals` field and the `isClosed` flag. Similarly, holiday online service hours are represented by the `holidayHours` sub-field. Setting the `reopenDate` sub-field indicates that the business is temporarily closed and will reopen on the specified date. SPECIAL CASES: * To indicate that an Entity is open 24 hours on a specific day, set start to 00:00 and end to 23:59 in `openIntervals` for that day. * To indicate that an Entity has split hours on a specific day (e.g., open from 9:00 AM to 12:00 PM and again from 1:00 PM to 5:00 PM), supply two or more `openIntervals` values with non-overlapping sets of hours. * If you are providing `openIntervals`, you may not set `isClosed` to true for that day. Filtering Type: `hours` ``` Eligible For: * financialProfessional * healthcareFacility * healthcareProfessional * location * restaurant ``` openDate: format: date type: string description: |- The date that the entity is set to open for the first time. Must be formatted in YYYY-MM-DD format. Date must be on or after 1970-01-01 Date must be before or on 2038-01-01 Filtering Type: `date` ``` Eligible For: * atm * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` operatingCountries: uniqueItems: true type: array items: enum: - AD - AE - AF - AG - AI - AL - AM - AO - AR - AS - AT - AU - AW - AX - AZ - BA - BB - BD - BE - BF - BG - BH - BI - BJ - BL - BM - BN - BO - BQ - BR - BS - BT - BW - BY - BZ - CA - CD - CF - CG - CH - CI - CK - CL - CM - CN - CO - CR - CU - CV - CW - CY - CZ - DE - DJ - DK - DM - DO - DZ - EC - EE - EG - EH - ER - ES - ET - FI - FJ - FK - FM - FO - FR - GA - GB - GD - GE - GF - GG - GH - GI - GL - GM - GN - GP - GQ - GR - GT - GU - GW - GY - HK - HN - HR - HT - HU - ID - IE - IL - IM - IN - IQ - IR - IS - IT - JE - JM - JO - JP - KE - KG - KH - KI - KM - KN - KR - KW - KY - KZ - LA - LB - LC - LI - LK - LR - LS - LT - LU - LV - LY - MA - MC - MD - ME - MF - MG - MH - MK - ML - MM - MN - MO - MP - MQ - MR - MS - MT - MU - MV - MW - MX - MY - MZ - NA - NC - NE - NG - NI - NL - 'NO' - NP - NR - NZ - OM - PA - PE - PF - PG - PH - PK - PL - PM - PR - PS - PT - PW - PY - QA - RE - RO - RS - RU - RW - SA - SB - SC - SD - SE - SG - SH - SI - SJ - SK - SL - SM - SN - SO - SR - SS - ST - SV - SX - SY - SZ - TC - TD - TG - TH - TJ - TL - TM - TN - TO - TR - TT - TV - TW - TZ - UA - UG - US - UY - UZ - VA - VC - VE - VG - VI - VN - VU - WF - WS - XK - YE - YT - ZA - ZM - ZW type: string description: 'Filtering Type: `option`' description: |- The list of countries the business operates in Filtering Type: `list of option` ``` Eligible For: * organization ``` orderUrl: additionalProperties: false type: object properties: displayUrl: minLength: 0 maxLength: 2000 format: uri type: string description: |- The URL that is shown on your listings in place of **`orderUrl.url`**. You can use **`orderUrl.displayUrl`** to display a short, memorable web address that redirects consumers to the URL given in **`orderUrl.url`**. Filtering Type: `text` preferDisplayUrl: type: boolean description: |- If set to true, only the display URL will be sent to those publishers who do not support separate display and tracking URLs for this field. Filtering Type: `boolean` url: minLength: 0 maxLength: 2000 format: uri type: string description: |- A valid URL used to place an order at this entity Filtering Type: `text` description: |- Information about the URL used to place orders that will be fulfilled by the entity Filtering Type: `object` ``` Eligible For: * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` organizerEmail: minLength: 0 format: email type: string description: |- Point of contact for the event organizer (not to be published publicly) Filtering Type: `text` ``` Eligible For: * event ``` organizerName: minLength: 0 type: string description: |- Point of contact for the event organizer (not to be published publicly) Filtering Type: `text` ``` Eligible For: * event ``` organizerPhone: minLength: 0 type: string description: |- Point of contact for the event organizer (not to be published publicly) Filtering Type: `text` ``` Eligible For: * event ``` outdoorPoolCount: multipleOf: 1 minimum: 0 type: number description: |- The number of outdoor pools the entity has. Filtering Type: `integer` ``` Eligible For: * hotel ``` parking: enum: - PARKING_AVAILABLE - PARKING_AVAILABLE_FOR_FREE - NOT_APPLICABLE type: string description: |- Indicates whether the entity offers parking services. Filtering Type: `option` ``` Eligible For: * hotel ``` paymentOptions: uniqueItems: true type: array items: enum: - AFTERPAY - ALIPAY - AMERICANEXPRESS - ANDROIDPAY - APPLEPAY - ATM - ATMQUICK - BACS - BANCONTACT - BANKDEPOSIT - BANKPAY - BGO - BITCOIN - Bar - CARTASI - CASH - CCS - CHECK - CHEQUESVACANCES - CONB - CONTACTLESSPAYME - CVVV - DEBITCARD - DEBITNOTE - DINERSCLUB - DIRECTDEBIT - DISCOVER - ECKARTE - ECOCHEQUE - EKENA - EMV - FINANCING - GIFTCARD - GOPAY - HAYAKAKEN - HEBAG - IBOD - ICCARDS - ICOCA - ID - IDEAL - INCA - INVOICE - JCB - JCoinPay - JKOPAY - KITACA - KLA - KLARNA - LINEPAY - MAESTRO - MANACA - MASTERCARD - MIPAY - MONIZZE - MPAY - Manuelle Lastsch - Merpay - NANACO - NEXI - NIMOCA - OREM - PASMO - PAYBACKPAY - PAYBOX - PAYCONIQ - PAYPAL - PAYPAY - PAYSEC - PIN - POSTEPAY - QRCODE - QUICPAY - RAKUTENEDY - RAKUTENPAY - SAMSUNGPAY - SODEXO - SUGOCA - SUICA - SWISH - TICKETRESTAURANT - TOICA - TRAVELERSCHECK - TSCUBIC - TWINT - UNIONPAY - VEV - VISA - VISAELECTRON - VOB - VOUCHER - VPAY - WAON - WECHATPAY - WIRETRANSFER - Yucho Pay - ZELLE - auPay - dBarai - Überweisung type: string description: 'Filtering Type: `option`' description: |- The payment methods accepted by this entity Valid elements depend on the entity's country. Filtering Type: `list of option` ``` Eligible For: * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` performers: description: |- Performers at the event Array must be ordered. Array may have a maximum of 100 elements. Filtering Type: `list of text` ``` Eligible For: * event ``` uniqueItems: true type: array items: minLength: 0 maxLength: 100 type: string description: 'Filtering Type: `text`' petsAllowed: enum: - PETS_WELCOME - PETS_WELCOME_FOR_FREE - NOT_APPLICABLE - NOT_ALLOWED type: string description: |- Indicates if the entity is pet friendly. Filtering Type: `option` ``` Eligible For: * hotel ``` photoGallery: description: |- **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. Array must be ordered. Array may have a maximum of 500 elements. Array item description: >Supported Aspect Ratios: >* 1 x 1 >* 4 x 3 >* 3 x 2 >* 5 x 3 >* 16 x 9 >* 3 x 1 >* 2 x 3 >* 5 x 7 >* 4 x 5 >* 4 x 1 > >**NOTE**: Maximum image size is 5mb after normalization and padding (if applicable). As well, there is a 6 second download limit from the image host. > Filtering Type: `list of object` ``` Eligible For: * atm * event * financialProfessional * healthcareFacility * healthcareProfessional * hotel * hotelRoomType * location * organization * product * restaurant ``` uniqueItems: false type: array items: required: - image additionalProperties: false type: object description: |- Supported Aspect Ratios: * 1 x 1 * 4 x 3 * 3 x 2 * 5 x 3 * 16 x 9 * 3 x 1 * 2 x 3 * 5 x 7 * 4 x 5 * 4 x 1 **NOTE**: Maximum image size is 5mb after normalization and padding (if applicable). As well, there is a 6 second download limit from the image host. Filtering Type: `object` properties: clickthroughUrl: minLength: 0 format: uri type: string description: 'Filtering Type: `text`' description: minLength: 0 type: string description: 'Filtering Type: `text`' details: minLength: 0 type: string description: 'Filtering Type: `text`' image: required: - url additionalProperties: false type: object description: |- Supported Aspect Ratios: * 1 x 1 * 4 x 3 * 3 x 2 * 5 x 3 * 16 x 9 * 3 x 1 * 2 x 3 * 5 x 7 * 4 x 5 * 4 x 1 **NOTE**: Maximum image size is 5mb after normalization and padding (if applicable). As well, there is a 6 second download limit from the image host. Filtering Type: `object` properties: alternateText: minLength: 0 type: string description: 'Filtering Type: `text`' url: minLength: 0 format: uri type: string description: 'Filtering Type: `text`' pickupCoordinate: additionalProperties: false type: object properties: latitude: minimum: -90 maximum: 90 type: number description: 'Filtering Type: `float`' longitude: minimum: -180 maximum: 180 type: number description: 'Filtering Type: `float`' description: |- Coordinates of where consumers can be picked up at the entity, as provided by you Filtering Type: `object` ``` Eligible For: * atm * event * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` pickupHours: additionalProperties: false type: object properties: friday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the pickup hours are "closed" on Friday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is open for pickup on Friday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' holidayHours: description: |- **NOTE:** The list of Holiday Hours that you send us must be comprehensive. For example, if you send us a list of Holiday Hours that does not include Holiday Hours that you sent in your last update, Yext considers the missing Holiday Hours to be deleted, and we remove them. Array must be ordered. Filtering Type: `list of object` uniqueItems: true type: array items: required: - date additionalProperties: false type: object properties: date: format: date type: string description: |- Date on which the holiday hours will be in effect. Cannot be in the past. Date must be on or after 1970-01-01 Date must be before or on 2038-01-01 Filtering Type: `date` isClosed: type: boolean description: |- Indicates if the pickup hours are "closed" on on the given date. Filtering Type: `boolean` isRegularHours: type: boolean description: |- Indicates whether the holiday hours are the same as the regular business hours for the given date. If set to true, we will update the holiday hours if the regular business hours change for the date's day of the week. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is open for pickup on the specified date. Filtering Type: `list of object` description: 'Filtering Type: `object`' monday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the pickup hours are "closed" on Monday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is open for pickup on Monday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' reopenDate: format: date type: string description: |- Date must be on or after 1970-01-01 Date must be before or on 2038-01-01 Filtering Type: `date` saturday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the pickup hours are "closed" on Saturday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is open for pickup on Saturday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' sunday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the pickup hours are "closed" on Sunday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is open for pickup on Sunday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' thursday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the pickup hours are "closed" on Thursday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is open for pickup on Thursday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' tuesday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the pickup hours are "closed" on Tuesday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is open for pickup on Tuesday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' wednesday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the pickup hours are "closed" on Wednesday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is open for pickup on Wednesday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' description: |- Contains the daily pickup hours, holiday pickup hours, and reopen date for the Entity. Each day is represented by a sub-field of `pickupHours`. (e.g. `monday`, `tuesday`, etc.) Open times can be specified per day through the `openIntervals` field and the `isClosed` flag. Similarly, holiday pickup hours are represented by the `holidayHours` sub-field. Setting the `reopenDate` sub-field indicates that the business is temporarily closed and will reopen on the specified date. SPECIAL CASES: * To indicate that an Entity is open 24 hours on a specific day, set start to 00:00 and end to 23:59 in `openIntervals` for that day. * To indicate that an Entity has split hours on a specific day (e.g., open from 9:00 AM to 12:00 PM and again from 1:00 PM to 5:00 PM), supply two or more `openIntervals` values with non-overlapping sets of hours. * If you are providing `openIntervals`, you may not set `isClosed` to true for that day. Filtering Type: `hours` ``` Eligible For: * healthcareFacility * location * restaurant ``` pinterestUrl: minLength: 0 format: uri type: string description: |- URL for your Pinterest account, format should be https://www.pinterest.com/yourUsername Filtering Type: `text` ``` Eligible For: * contactCard * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * organization * restaurant ``` priceRange: enum: - UNSPECIFIED - ONE - TWO - THREE - FOUR type: string description: |- he typical price of products sold by this location, on a scale of 1 (low) to 4 (high) Filtering Type: `option` ``` Eligible For: * atm * healthcareFacility * healthcareProfessional * location * restaurant ``` primaryConversationContact: minLength: 0 type: string description: |- ID of the user who is the primary Knowledge Assistant contact for the entity Filtering Type: `option` ``` Eligible For: * atm * faq * financialProfessional * healthcareFacility * healthcareProfessional * helpArticle * hotel * job * location * organization * product * restaurant ``` privateBeach: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity has access to a private beach. Filtering Type: `option` ``` Eligible For: * hotel ``` privateCarService: enum: - PRIVATE_CAR_SERVICE - PRIVATE_CAR_SERVICE_FOR_FREE - NOT_APPLICABLE type: string description: |- Indicates whether the entity offers private car services. Filtering Type: `option` ``` Eligible For: * hotel ``` productLists: additionalProperties: false type: object properties: ids: description: |- IDs of the Products & Services Lists associated with this entity Array must be ordered. Array may have a maximum of 40 elements. Filtering Type: `list of text` uniqueItems: true type: array items: minLength: 0 type: string description: 'Filtering Type: `text`' label: minLength: 0 maxLength: 30 type: string description: |- Label to be used for this entity's Products & Services Lists. This label will appear on your entity's listings. Filtering Type: `text` description: |- Information about the Products & Services Content Lists associated with this entity Filtering Type: `object` ``` Eligible For: * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` products: description: |- Products sold by this entity All strings must be non-empty when trimmed of whitespace. Array must be ordered. Array may have a maximum of 100 elements. Array item description: >Cannot Include: >* HTML markup Filtering Type: `list of text` ``` Eligible For: * financialProfessional * location ``` uniqueItems: true type: array items: minLength: 0 maxLength: 100 type: string description: |- Cannot Include: * HTML markup Filtering Type: `text` questionsAndAnswers: type: boolean description: |- Indicates whether Yext Knowledge Assistant question-and-answer conversations are enabled for this entity Filtering Type: `boolean` ``` Eligible For: * atm * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * organization * restaurant ``` rankTrackingCompetitors: description: |- Information about the competitors whose search performance you would like to compare to your own Array must be ordered. Array may have a maximum of 5 elements. Filtering Type: `list of object` ``` Eligible For: * atm * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * organization * restaurant ``` uniqueItems: true type: array items: required: - name - website additionalProperties: false type: object properties: name: minLength: 0 maxLength: 100 type: string description: |- A name of a competitor Cannot Include: * HTML markup Filtering Type: `text` website: minLength: 0 maxLength: 255 format: uri type: string description: |- The business website of a competitor Cannot Include: * common domain names, e.g., google.com, youtube.com, etc. Filtering Type: `text` description: 'Filtering Type: `object`' rankTrackingEnabled: type: boolean description: |- Indicates whether Rank Tracking is enabled Filtering Type: `boolean` ``` Eligible For: * atm * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * organization * restaurant ``` rankTrackingFrequency: enum: - WEEKLY - MONTHLY - QUARTERLY type: string description: |- How often we send search queries to track your search performance Filtering Type: `option` ``` Eligible For: * atm * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * organization * restaurant ``` rankTrackingQueryTemplates: description: |- The ways in which your keywords will be arranged in the search queries we use to track your performance Array must have a minimum of 2 elements. Array may have a maximum of 4 elements. Filtering Type: `list of option` ``` Eligible For: * atm * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * organization * restaurant ``` uniqueItems: true type: array items: enum: - KEYWORD - KEYWORD_ZIP - KEYWORD_CITY - KEYWORD_IN_CITY - KEYWORD_NEAR_ME - KEYWORD_CITY_STATE type: string description: 'Filtering Type: `option`' rankTrackingSites: uniqueItems: true type: array items: enum: - GOOGLE_DESKTOP - GOOGLE_MOBILE - BING_DESKTOP - BING_MOBILE - YAHOO_DESKTOP - YAHOO_MOBILE type: string description: 'Filtering Type: `option`' description: |- The search engines that we will use to track your performance Filtering Type: `list of option` ``` Eligible For: * atm * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * organization * restaurant ``` reservationUrl: additionalProperties: false type: object properties: displayUrl: minLength: 0 maxLength: 2000 format: uri type: string description: |- The URL that is shown on your listings in place of **`reservationUrl.url`**. You can use **`reservationUrl.displayUrl`** to display a short, memorable web address that redirects consumers to the URL given in **`reservationUrl.url`**. Must be a valid URL and be specified along with **`reservationUrl.url`**. Filtering Type: `text` preferDisplayUrl: type: boolean description: |- If set to true, only the display URL will be sent to those publishers who do not support separate display and tracking URLs for this field. Filtering Type: `boolean` url: minLength: 0 maxLength: 2000 format: uri type: string description: |- A valid URL used to make reservations at this entity Filtering Type: `text` description: |- Information about the URL consumers can visit to make reservations at this entity Filtering Type: `object` ``` Eligible For: * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` restaurantCount: multipleOf: 1 minimum: 0 type: number description: |- The number of restaurants the entity has. Filtering Type: `integer` ``` Eligible For: * hotel ``` reviewGenerationUrl: minLength: 0 type: string description: |- The URL given Review Invitation emails where consumers can leave a review about the entity ``` Eligible For: * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` reviewResponseConversationEnabled: type: boolean description: |- Indicates whether Yext Knowledge Assistant review-response conversations are enabled for this entity Filtering Type: `boolean` ``` Eligible For: * atm * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` roomCount: multipleOf: 1 minimum: 0 type: number description: |- The number of rooms the entity has. Filtering Type: `integer` ``` Eligible For: * hotel ``` roomService: enum: - ROOM_SERVICE_AVAILABLE - ROOM_SERVICE_AVAILABLE_24_HOURS - NOT_APPLICABLE type: string description: |- Indicates whether the entity offers room service. Filtering Type: `option` ``` Eligible For: * hotel ``` routableCoordinate: additionalProperties: false type: object properties: latitude: minimum: -90 maximum: 90 type: number description: 'Filtering Type: `float`' longitude: minimum: -180 maximum: 180 type: number description: 'Filtering Type: `float`' description: |- Destination coordinates to use for driving directions to the entity, as provided by you Filtering Type: `object` ``` Eligible For: * atm * event * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` salon: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity has a salon. Filtering Type: `option` ``` Eligible For: * hotel ``` sauna: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity has a sauna. Filtering Type: `option` ``` Eligible For: * hotel ``` scuba: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity offers scuba diving. Filtering Type: `option` ``` Eligible For: * hotel ``` selfParking: enum: - SELF_PARKING_AVAILABLE - SELF_PARKING_AVAILABLE_FOR_FREE - NOT_APPLICABLE type: string description: |- Indicates whether the entity offers self parking services. Filtering Type: `option` ``` Eligible For: * hotel ``` seniorHours: additionalProperties: false type: object properties: friday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the senior hours are "closed" on Friday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for the Entity's senior hours on Friday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' holidayHours: description: |- **NOTE:** The list of Holiday Hours that you send us must be comprehensive. For example, if you send us a list of Holiday Hours that does not include Holiday Hours that you sent in your last update, Yext considers the missing Holiday Hours to be deleted, and we remove them. Array must be ordered. Filtering Type: `list of object` uniqueItems: true type: array items: required: - date additionalProperties: false type: object properties: date: format: date type: string description: |- Date on which the holiday hours will be in effect. Cannot be in the past. Date must be on or after 1970-01-01 Date must be before or on 2038-01-01 Filtering Type: `date` isClosed: type: boolean description: |- Indicates if the senior hours are "closed" on on the given date. Filtering Type: `boolean` isRegularHours: type: boolean description: |- Indicates whether the holiday hours are the same as the regular business hours for the given date. If set to true, we will update the holiday hours if the regular business hours change for the date's day of the week. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for the Entity's senior hours on the specified date. Filtering Type: `list of object` description: 'Filtering Type: `object`' monday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the senior hours are "closed" on Monday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for the Entity's senior hours on Monday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' reopenDate: format: date type: string description: |- Date must be on or after 1970-01-01 Date must be before or on 2038-01-01 Filtering Type: `date` saturday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the senior hours are "closed" on Saturday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for the Entity's senior hours on Saturday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' sunday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the senior hours are "closed" on Sunday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for the Entity's senior hours on Sunday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' thursday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the senior hours are "closed" on Thursday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for the Entity's senior hours on Thursday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' tuesday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the senior hours are "closed" on Tuesday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for the Entity's senior hours on Tuesday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' wednesday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the senior hours are "closed" on Wednesday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for the Entity's senior hours on Wednesday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' description: |- Contains the daily senior hours, holiday senior hours, and reopen date for the Entity. Each day is represented by a sub-field of `seniorHours`. (e.g. `monday`, `tuesday`, etc.) Open times can be specified per day through the `openIntervals` field and the `isClosed` flag. Similarly, holiday senior hours are represented by the `holidayHours` sub-field. Setting the `reopenDate` sub-field indicates that the business is temporarily closed and will reopen on the specified date. SPECIAL CASES: * To indicate that an Entity is open 24 hours on a specific day, set start to 00:00 and end to 23:59 in `openIntervals` for that day. * To indicate that an Entity has split hours on a specific day (e.g., open from 9:00 AM to 12:00 PM and again from 1:00 PM to 5:00 PM), supply two or more `openIntervals` values with non-overlapping sets of hours. * If you are providing `openIntervals`, you may not set `isClosed` to true for that day. Filtering Type: `hours` ``` Eligible For: * location * restaurant ``` serviceArea: additionalProperties: false type: object properties: places: description: |- A list of places served by the entity, where each place is either: - a postal code, or - the name of a city. Array must be ordered. Array may have a maximum of 200 elements. Filtering Type: `list of text` uniqueItems: true type: array items: minLength: 0 maxLength: 100 type: string description: 'Filtering Type: `text`' description: |- Information about the area that is served by this entity. It is specified as a list of cities and/or postal codes. **Only for Google Business Profile and Bing:** Currently, **serviceArea** is only supported by Google Business Profile and Bing and will not affect your listings on other sites. Filtering Type: `object` ``` Eligible For: * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` serviceAreaPlaces: description: |- Information about the area that is served by this entity. It is specified as a list of service area names, their associated types and google place ids. **Only for Google Business Profile and Bing:** Currently, **serviceArea** is only supported by Google Business Profile and Bing and will not affect your listings on other sites. Array may have a maximum of 200 elements. Filtering Type: `list of object` ``` Eligible For: * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` uniqueItems: true type: array items: additionalProperties: false type: object properties: name: minLength: 0 maxLength: 100 type: string description: 'Filtering Type: `text`' googlePlaceId: minLength: 0 type: string description: 'Filtering Type: `text`' type: enum: - POSTAL_CODE - REGION - COUNTY - CITY - SUBLOCALITY type: string description: 'Filtering Type: `option`' description: 'Filtering Type: `object`' services: description: |- Services offered by this entity All strings must be non-empty when trimmed of whitespace. Array must be ordered. Array may have a maximum of 100 elements. Array item description: >Cannot Include: >* HTML markup Filtering Type: `list of text` ``` Eligible For: * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` uniqueItems: true type: array items: minLength: 0 maxLength: 100 type: string description: |- Cannot Include: * HTML markup Filtering Type: `text` smokeFreeProperty: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates if the entity is smoke free. Filtering Type: `option` ``` Eligible For: * hotel ``` snorkeling: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity offers snorkeling. Filtering Type: `option` ``` Eligible For: * hotel ``` socialHour: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity offers a social hour. Filtering Type: `option` ``` Eligible For: * hotel ``` spa: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity has a spa. Filtering Type: `option` ``` Eligible For: * hotel ``` specialities: description: |- Up to 100 of this entity's specialities (e.g., for food and dining: `Chicago style`) All strings must be non-empty when trimmed of whitespace. Array must be ordered. Array may have a maximum of 100 elements. Array item description: >Cannot Include: >* HTML markup Filtering Type: `list of text` ``` Eligible For: * financialProfessional * location * restaurant ``` uniqueItems: true type: array items: minLength: 0 maxLength: 100 type: string description: |- Cannot Include: * HTML markup Filtering Type: `text` tableService: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity has a sit-down restaurant. Filtering Type: `option` ``` Eligible For: * hotel ``` takeoutHours: additionalProperties: false type: object properties: friday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the takeout hours are "closed" on Friday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is open for takeout on Friday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' holidayHours: description: |- **NOTE:** The list of Holiday Hours that you send us must be comprehensive. For example, if you send us a list of Holiday Hours that does not include Holiday Hours that you sent in your last update, Yext considers the missing Holiday Hours to be deleted, and we remove them. Array must be ordered. Filtering Type: `list of object` uniqueItems: true type: array items: required: - date additionalProperties: false type: object properties: date: format: date type: string description: |- Date on which the holiday hours will be in effect. Cannot be in the past. Date must be on or after 1970-01-01 Date must be before or on 2038-01-01 Filtering Type: `date` isClosed: type: boolean description: |- Indicates if the takeout hours are "closed" on on the given date. Filtering Type: `boolean` isRegularHours: type: boolean description: |- Indicates whether the holiday hours are the same as the regular business hours for the given date. If set to true, we will update the holiday hours if the regular business hours change for the date's day of the week. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is open for takeout on the specified date. Filtering Type: `list of object` description: 'Filtering Type: `object`' monday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the takeout hours are "closed" on Monday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is open for takeout on Monday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' reopenDate: format: date type: string description: |- Date must be on or after 1970-01-01 Date must be before or on 2038-01-01 Filtering Type: `date` saturday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the takeout hours are "closed" on Saturday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is open for takeout on Saturday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' sunday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the takeout hours are "closed" on Sunday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is open for takeout on Sunday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' thursday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the takeout hours are "closed" on Thursday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is open for takeout on Thursday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' tuesday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the takeout hours are "closed" on Tuesday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is open for takeout on Tuesday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' wednesday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the takeout hours are "closed" on Wednesday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is open for takeout on Wednesday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' description: |- Contains the daily takeout hours, holiday takeout hours, and reopen date for the Entity. Each day is represented by a sub-field of `takeoutHours`. (e.g. `monday`, `tuesday`, etc.) Open times can be specified per day through the `openIntervals` field and the `isClosed` flag. Similarly, holiday takeout hours are represented by the `holidayHours` sub-field. Setting the `reopenDate` sub-field indicates that the business is temporarily closed and will reopen on the specified date. SPECIAL CASES: * To indicate that an Entity is open 24 hours on a specific day, set start to 00:00 and end to 23:59 in `openIntervals` for that day. * To indicate that an Entity has split hours on a specific day (e.g., open from 9:00 AM to 12:00 PM and again from 1:00 PM to 5:00 PM), supply two or more `openIntervals` values with non-overlapping sets of hours. * If you are providing `openIntervals`, you may not set `isClosed` to true for that day. Filtering Type: `hours` ``` Eligible For: * location * restaurant ``` tennis: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity has tennis courts. Filtering Type: `option` ``` Eligible For: * hotel ``` thermalPool: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity has a thermal pool. Filtering Type: `option` ``` Eligible For: * hotel ``` ticketAvailability: enum: - IN_STOCK - SOLD_OUT - PRE_ORDER - UNSPECIFIED type: string description: |- Information about the availability of tickets for the event Filtering Type: `option` ``` Eligible For: * event ``` ticketPriceRange: additionalProperties: false type: object properties: currencyCode: minLength: 0 type: string description: |- Three letter currency code (ISO standard) Filtering Type: `text` maxValue: pattern: ^\d*\.?\d*$ type: string description: |- Maximum ticket price Filtering Type: `decimal` minValue: pattern: ^\d*\.?\d*$ type: string description: |- Minimum ticket price Filtering Type: `decimal` description: |- Contains the price range for the event Filtering Type: `object` ``` Eligible For: * event ``` ticketSaleDateTime: format: date-time type: string description: |- The date/time tickets are available for sale (local time) Filtering Type: `datetime` ``` Eligible For: * event ``` ticketUrl: minLength: 0 format: uri type: string description: |- URL to purchase tickets for the event (if ticketed) Filtering Type: `text` ``` Eligible For: * event ``` tikTokUrl: minLength: 0 format: uri type: string description: |- URL for your TikTok profile, format should be https://www.tiktok.com/yourUsername Filtering Type: `text` ``` Eligible For: * contactCard * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * organization * restaurant ``` time: additionalProperties: false type: object properties: end: format: date-time type: string description: |- End date/time of the event, in local time (see timezone field) Standard ISO 8601 datetime without timezone Format: `YYYY-MM-DDThh:mm` Filtering Type: `datetime` start: format: date-time type: string description: |- Start date/time of the event, in local time (see timezone field) Standard ISO 8601 datetime without timezone Format: `YYYY-MM-DDThh:mm` Filtering Type: `datetime` description: |- Contains the start/end times for the event Filtering Type: `object` ``` Eligible For: * event ``` timeZoneUtcOffset: minLength: 0 type: string description: |- Represents the time zone offset of the entity from UTC, in `±hh:mm` format. For example, if the entity is 4 hours ahead of UTC time, the offset will be `+04:00`. If the entity is 15.5 hours behind UTC time, the offset will be `-15:30`. If the entity is in UTC time, the offset will be `+00:00`. ``` Eligible For: * atm * event * faq * healthcareFacility * healthcareProfessional * hotel * job * location * restaurant ``` timezone: minLength: 0 type: string description: |- The timezone of the entity, in the standard `IANA time zone database` format (tz database). e.g. `"America/New_York"` Filtering Type: `option` ``` Eligible For: * atm * board * card * contactCard * event * faq * financialProfessional * healthcareFacility * healthcareProfessional * helpArticle * hotel * hotelRoomType * job * location * organization * product * restaurant ``` tollFreePhone: minLength: 0 type: string description: |- Must be a valid phone number. If the phone number's calling code is for a country other than the one given in the entity's **`countryCode`**, the phone number provided must contain the calling code (e.g., `+44` in `+442038083831`). Otherwise, the calling code is optional. Filtering Type: `text` ``` Eligible For: * atm * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` treadmill: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity has a treadmill. Filtering Type: `option` ``` Eligible For: * hotel ``` ttyPhone: minLength: 0 type: string description: |- Must be a valid phone number. If the phone number's calling code is for a country other than the one given in the entity's **`countryCode`**, the phone number provided must contain the calling code (e.g., `+44` in `+442038083831`). Otherwise, the calling code is optional. Filtering Type: `text` ``` Eligible For: * atm * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` turndownService: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity offers turndown service. Filtering Type: `option` ``` Eligible For: * hotel ``` twitterHandle: minLength: 0 maxLength: 15 type: string description: |- Valid Twitter handle for the entity without the leading "@" (e.g., `JohnSmith`) 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. Filtering Type: `text` ``` Eligible For: * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * organization * restaurant ``` uberLink: required: - presentation additionalProperties: false type: object properties: presentation: enum: - BUTTON - LINK type: string description: |- Indicates whether the embedded Uber link for this entity 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 entity set as the trip destination. If the Uber app is not installed, the consumer will be prompted to download it. Filtering Type: `option` text: minLength: 0 maxLength: 100 type: string description: |- The text of the embedded Uber link Default is `Ride there with Uber`. **NOTE:** This field is only available if **`uberLink.presentation`** is `LINK`. Filtering Type: `text` description: |- Information about the Yext-powered link that can be copied and pasted into the markup of Yext Pages where the embedded Uber link should appear Filtering Type: `object` ``` Eligible For: * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` uberTripBranding: required: - text - url - description additionalProperties: false type: object properties: description: minLength: 0 maxLength: 150 type: string description: |- A longer description that will appear near the call-to-action in the Uber app during a trip to your entity. **NOTE:** If a value for **`uberTripBranding.description`** is provided, values must also be provided for **`uberTripBranding.text`** and **`uberTripBranding.url`**. Filtering Type: `text` text: minLength: 0 maxLength: 28 type: string description: |- The text of the call-to-action that will appear in the Uber app during a trip to your entity (e.g., `Check out our menu!`) **NOTE:** If a value for **`uberTripBranding.text`** is provided, values must also be provided for **`uberTripBranding.url`** and **`uberTripBranding.description`**. Filtering Type: `text` url: minLength: 0 format: uri type: string description: |- 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 entity. **NOTE:** If a value for **`uberTripBranding.url`** is provided, values must also be provided for **`uberTripBranding.text`** and **`uberTripBranding.description`**. Filtering Type: `text` description: |- Information about the call-to-action consumers will see in the Uber app during a trip to your entity Filtering Type: `object` ``` Eligible For: * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` valetParking: enum: - VALET_PARKING_AVAILABLE - VALET_PARKING_AVAILABLE_FOR_FREE - NOT_APPLICABLE type: string description: |- Indicates whether the entity offers valet parking services. Filtering Type: `option` ``` Eligible For: * hotel ``` validThrough: format: date-time type: string description: |- The date this entity is valid through. Filtering Type: `datetime` ``` Eligible For: * job ``` vendingMachine: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity has a vending machine. Filtering Type: `option` ``` Eligible For: * hotel ``` venueName: minLength: 0 type: string description: |- Name of the venue where the event is being held Filtering Type: `text` ``` Eligible For: * event ``` videos: description: |- Valid YouTube URLs for embedding a video on some publisher sites **NOTE:** Currently, only the first URL in the Array appears in your listings. Array must be ordered. Filtering Type: `list of object` ``` Eligible For: * financialProfessional * healthcareFacility * healthcareProfessional * hotel * hotelRoomType * location * organization * product * restaurant ``` uniqueItems: true type: array items: required: - video additionalProperties: false type: object properties: description: minLength: 0 maxLength: 140 type: string description: |- Cannot Include: * HTML markup Filtering Type: `text` video: required: - url additionalProperties: false type: object properties: url: minLength: 0 format: uri type: string description: 'Filtering Type: `text`' description: 'Filtering Type: `object`' description: 'Filtering Type: `object`' wadingPool: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity has a wading pool. Filtering Type: `option` ``` Eligible For: * hotel ``` wakeUpCalls: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity offers wake up call services. Filtering Type: `option` ``` Eligible For: * hotel ``` walkableCoordinate: additionalProperties: false type: object properties: latitude: minimum: -90 maximum: 90 type: number description: 'Filtering Type: `float`' longitude: minimum: -180 maximum: 180 type: number description: 'Filtering Type: `float`' description: |- Destination coordinates to use for walking directions to the entity, as provided by you Filtering Type: `object` ``` Eligible For: * atm * event * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` waterPark: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity has a water park. Filtering Type: `option` ``` Eligible For: * hotel ``` waterSkiing: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity offers water skiing. Filtering Type: `option` ``` Eligible For: * hotel ``` watercraft: enum: - WATERCRAFT_RENTALS - WATERCRAFT_RENTALS_FOR_FREE - NOT_APPLICABLE type: string description: |- Indicates whether the entity offers any kind of watercrafts. Filtering Type: `option` ``` Eligible For: * hotel ``` waterslide: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity has a water slide. Filtering Type: `option` ``` Eligible For: * hotel ``` wavePool: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity has a wave pool. Filtering Type: `option` ``` Eligible For: * hotel ``` websiteUrl: additionalProperties: false type: object properties: displayUrl: minLength: 0 maxLength: 2000 format: uri type: string description: |- The URL that is shown on your listings in place of **`websiteUrl.url`**. You can use **`websiteUrl.displayUrl`** to display a short, memorable web address that redirects consumers to the URL given in **`websiteUrl.url`**. Must be a valid URL and be specified along with **`websiteUrl.url`**. Filtering Type: `text` preferDisplayUrl: type: boolean description: |- If set to true, only the display URL will be sent to those publishers who do not support separate display and tracking URLs for this field. Filtering Type: `boolean` url: minLength: 0 maxLength: 2000 format: uri type: string description: |- A valid URL for this entity's website Filtering Type: `text` description: |- Information about the website for this entity Filtering Type: `object` ``` Eligible For: * atm * contactCard * event * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * organization * restaurant ``` weightMachine: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity has a weight machine. Filtering Type: `option` ``` Eligible For: * hotel ``` wheelchairAccessible: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates if the entity is wheelchair accessible. Filtering Type: `option` ``` Eligible For: * hotel ``` wifiAvailable: enum: - WIFI_AVAILABLE - WIFI_AVAILABLE_FOR_FREE - NOT_APPLICABLE type: string description: |- Indicates whether the entity has WiFi available Filtering Type: `option` ``` Eligible For: * hotel ``` workRemote: type: boolean description: |- Indicates whether the job is remote. Filtering Type: `boolean` ``` Eligible For: * job ``` yearEstablished: multipleOf: 1 minimum: 1000 maximum: 2028 type: number description: |- The year the entity was established. Filtering Type: `integer` ``` Eligible For: * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` yearLastRenovated: multipleOf: 1 minimum: 1000 maximum: 2028 type: number description: |- The most recent year the entity was partially or completely renovated. Filtering Type: `integer` ``` Eligible For: * hotel ``` yextDisplayCoordinate: additionalProperties: false type: object properties: latitude: minimum: -90 maximum: 90 type: number description: 'Filtering Type: `float`' longitude: minimum: -180 maximum: 180 type: number description: 'Filtering Type: `float`' description: |- Coordinates where the map pin for the entity should be displayed, as calculated by Yext Filtering Type: `object` ``` Eligible For: * atm * event * financialProfessional * healthcareFacility * healthcareProfessional * hotel * job * location * restaurant ``` yextDropoffCoordinate: additionalProperties: false type: object properties: latitude: minimum: -90 maximum: 90 type: number description: 'Filtering Type: `float`' longitude: minimum: -180 maximum: 180 type: number description: 'Filtering Type: `float`' description: |- Coordinates of where consumers can be dropped off at the entity, as calculated by Yext Filtering Type: `object` ``` Eligible For: * atm * event * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` yextPickupCoordinate: additionalProperties: false type: object properties: latitude: minimum: -90 maximum: 90 type: number description: 'Filtering Type: `float`' longitude: minimum: -180 maximum: 180 type: number description: 'Filtering Type: `float`' description: |- Coordinates of where consumers can be picked up at the entity, as calculated by Yext Filtering Type: `object` ``` Eligible For: * atm * event * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` yextRoutableCoordinate: additionalProperties: false type: object properties: latitude: minimum: -90 maximum: 90 type: number description: 'Filtering Type: `float`' longitude: minimum: -180 maximum: 180 type: number description: 'Filtering Type: `float`' description: |- Destination coordinates to use for driving directions to the entity, as calculated by Yext Filtering Type: `object` ``` Eligible For: * atm * event * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` yextWalkableCoordinate: additionalProperties: false type: object properties: latitude: minimum: -90 maximum: 90 type: number description: 'Filtering Type: `float`' longitude: minimum: -180 maximum: 180 type: number description: 'Filtering Type: `float`' description: |- Destination coordinates to use for walking directions to the entity, as calculated by Yext Filtering Type: `object` ``` Eligible For: * atm * event * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` youTubeChannelUrl: minLength: 0 format: uri type: string description: |- URL for your YouTube channel, format should be https://www.youtube.com/c/yourUsername Filtering Type: `text` ``` Eligible For: * contactCard * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * organization * restaurant ``` headers: {} '400': description: Error Response content: application/json: schema: additionalProperties: false type: object properties: meta: additionalProperties: false type: object properties: errors: uniqueItems: false type: array items: additionalProperties: false type: object properties: code: multipleOf: 1 type: number description: | Code that uniquely identifies the error or warning. message: minLength: 0 type: string description: Message explaining the problem. type: enum: - FATAL_ERROR - NON_FATAL_ERROR - WARNING type: string description: List of errors and warnings. uuid: minLength: 0 type: string description: 'Filtering Type: `object`' headers: {} /accounts/{accountId}/menus/{listId}: get: operationId: getMenus parameters: - $ref: '#/components/parameters/listId' - $ref: '#/components/parameters/accountId' - $ref: '#/components/parameters/v' tags: - Live API summary: 'Menus: Get' description: Retrieve a specific Menu responses: '200': $ref: '#/components/responses/MenuResponse' default: $ref: '#/components/responses/ErrorResponse' /accounts/{accountId}/bios/{listId}: get: operationId: getBios parameters: - $ref: '#/components/parameters/listId' - $ref: '#/components/parameters/accountId' - $ref: '#/components/parameters/v' tags: - Live API summary: 'Bios: Get' description: Retrieve a specific Bios ECL responses: '200': $ref: '#/components/responses/BioResponse' default: $ref: '#/components/responses/ErrorResponse' /accounts/{accountId}/products/{listId}: get: operationId: getProducts parameters: - $ref: '#/components/parameters/listId' - $ref: '#/components/parameters/accountId' - $ref: '#/components/parameters/v' tags: - Live API summary: 'Products: Get' description: Retrieve a specific Products ECL responses: '200': $ref: '#/components/responses/ProductResponse' default: $ref: '#/components/responses/ErrorResponse' /accounts/{accountId}/events/{listId}: get: operationId: getEvents parameters: - $ref: '#/components/parameters/listId' - $ref: '#/components/parameters/accountId' - $ref: '#/components/parameters/v' tags: - Live API summary: 'Events (Legacy): Get' description: Retrieve a specific Events ECL responses: '200': $ref: '#/components/responses/EventResponse' default: $ref: '#/components/responses/ErrorResponse' /accounts/{accountId}/locations/{locationId}/profiles/{languageCode}: get: operationId: getLanguageProfiles parameters: - $ref: '#/components/parameters/accountId' - $ref: '#/components/parameters/locationId' - $ref: '#/components/parameters/languageCode' - $ref: '#/components/parameters/fields' - $ref: '#/components/parameters/v' tags: - Live API summary: 'Language Profiles (Legacy): Get' description: | Gets the requested Language Profile for a given Location **NOTE:** * Responses will contain resolved values for embedded fields * If the `fields` parameter is unspecified, responses will contain the full entity profile for the requested language responses: '200': $ref: '#/components/responses/LanguageProfileResponse' default: $ref: '#/components/responses/ErrorResponse' /accounts/{accountId}/locations/{locationId}/profiles: get: operationId: listLocationLanguageProfiles parameters: - $ref: '#/components/parameters/accountId' - $ref: '#/components/parameters/locationId' - $ref: '#/components/parameters/fields' - $ref: '#/components/parameters/v' tags: - Live API summary: 'Language Profiles (Legacy): List' description: | Gets all Language Profiles for a Location **NOTE:** * Responses will contain resolved values for embedded fields * If the `fields` parameter is unspecified, responses will contain the full entity profile for the requested language responses: '200': $ref: '#/components/responses/LanguageProfilesResponse' default: $ref: '#/components/responses/ErrorResponse' /accounts/{accountId}/locations/{locationId}/profiles/{languageCode}/schema: get: operationId: getLanguageProfilesSchema parameters: - $ref: '#/components/parameters/accountId' - $ref: '#/components/parameters/locationId' - $ref: '#/components/parameters/languageCode' - $ref: '#/components/parameters/v' tags: - Live API summary: 'Language Profiles Schema (Legacy): Get' description: Gets the schema.org-compliant schema for the requested Language Profile of a given Location. Schema will vary depending on the primary category of the Location. responses: '200': $ref: '#/components/responses/LanguageProfileSchemaResponse' default: $ref: '#/components/responses/ErrorResponse' /accounts/{accountId}/locations/{locationId}: get: operationId: getLocation parameters: - $ref: '#/components/parameters/accountId' - $ref: '#/components/parameters/locationId' - $ref: '#/components/parameters/fields' - $ref: '#/components/parameters/v' tags: - Live API summary: 'Locations (Legacy): Get' description: | Gets the primary profile for a single Location **NOTE:** Responses will contain resolved values for embedded fields responses: '200': $ref: '#/components/responses/LocationResponse' default: $ref: '#/components/responses/ErrorResponse' /accounts/{accountId}/locations: parameters: - $ref: '#/components/parameters/accountId' - $ref: '#/components/parameters/limit' - $ref: '#/components/parameters/offset' - $ref: '#/components/parameters/languages' - $ref: '#/components/parameters/fields' - $ref: '#/components/parameters/filters' - $ref: '#/components/parameters/v' - $ref: '#/components/parameters/sortBy' get: operationId: locationsList tags: - Live API summary: 'Locations (Legacy): List' description: | Get multiple Locations (primary profile only). Filters are evaluated against all language profiles as well as the primary profile. **NOTE:** Responses will contain resolved values for embedded fields responses: '200': $ref: '#/components/responses/LocationsResponse' default: $ref: '#/components/responses/ErrorResponse' /accounts/{accountId}/locations/{locationId}/schema: get: operationId: getLocationSchema parameters: - $ref: '#/components/parameters/accountId' - $ref: '#/components/parameters/locationId' - $ref: '#/components/parameters/v' tags: - Live API summary: 'Locations Schema (Legacy): Get' description: Gets the schema.org-compliant schema for the primary profile of a single Location. Schema will vary depending on the primary category of the Location. responses: '200': $ref: '#/components/responses/LocationSchemaResponse' default: $ref: '#/components/responses/ErrorResponse' /accounts/{accountId}/locations/geosearch: parameters: - $ref: '#/components/parameters/accountId' - $ref: '#/components/parameters/limit' - $ref: '#/components/parameters/offset' - $ref: '#/components/parameters/location' - $ref: '#/components/parameters/radius' - $ref: '#/components/parameters/geocoderBias' - $ref: '#/components/parameters/countryBias' - $ref: '#/components/parameters/languages' - $ref: '#/components/parameters/fields' - $ref: '#/components/parameters/filters' - $ref: '#/components/parameters/v' - $ref: '#/components/parameters/sortBy' get: operationId: geoSearch tags: - Live API summary: 'Locations (Legacy): GeoSearch' description: | Gets multiple Locations (primary profile only) near a given location, ordered by proximity to the location (if no other sort criteria are given) and restricted to a radius. Searches through all language profiles, including the primary profile. **NOTE:** Responses will contain resolved values for embedded fields responses: '200': $ref: '#/components/responses/GeoSearchResponse' default: $ref: '#/components/responses/ErrorResponse' /accounts/{accountId}/createQuestion: post: operationId: createQuestion tags: - Live API summary: | Question: Create requestBody: $ref: '#/components/requestBodies/createQuestionRequest' parameters: - $ref: '#/components/parameters/accountId' - $ref: '#/components/parameters/v' description: Create a new Question. responses: '200': $ref: '#/components/responses/EmptyResponse' default: $ref: '#/components/responses/ErrorResponse' /accounts/{accountId}/reviewSubmission: post: operationId: createReview tags: - Live API description: Create a new Review. summary: | Review: Create parameters: - $ref: '#/components/parameters/accountId' - $ref: '#/components/parameters/v' requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/CreateReview' responses: '202': $ref: '#/components/responses/ReviewsResponse' default: $ref: '#/components/responses/ErrorResponse' /accounts/{accountId}/reviewSubmission/{apiIdentifier}: put: operationId: updateReview tags: - Live API description: Update a Review. summary: | Review: Update parameters: - $ref: '#/components/parameters/accountId' - $ref: '#/components/parameters/v' - $ref: '#/components/parameters/apiIdentifier' requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/UpdateReview' responses: '202': $ref: '#/components/responses/ReviewsResponse' default: $ref: '#/components/responses/ErrorResponse' delete: operationId: deleteReview tags: - Live API description: Delete a Review. summary: | Review: Delete parameters: - $ref: '#/components/parameters/accountId' - $ref: '#/components/parameters/v' - $ref: '#/components/parameters/apiIdentifier' responses: '202': $ref: '#/components/responses/ReviewsResponse' default: $ref: '#/components/responses/ErrorResponse' /accounts/{accountId}/content/{endpoint}/{ids}: get: operationId: contentGet parameters: - $ref: '#/components/parameters/accountId' - $ref: '#/components/parameters/endpoint' - $ref: '#/components/parameters/contentDocIds' - $ref: '#/components/parameters/v' tags: - Content API summary: 'Content: Get' description: Retrieve records by ID from a Content Endpoint responses: '200': $ref: '#/components/responses/StreamsResponse' default: $ref: '#/components/responses/ErrorResponse' /accounts/{accountId}/content/{endpoint}: get: operationId: contentList parameters: - $ref: '#/components/parameters/accountId' - $ref: '#/components/parameters/endpoint' - $ref: '#/components/parameters/v' - $ref: '#/components/parameters/limit' - $ref: '#/components/parameters/pageToken' tags: - Content API summary: 'Content: List' description: | List records from a Content Endpoint Content API provides the ability for a user to filter and sort records by the contents of an indexed field. The filters and sorting parameters can be provided as query parameters, in addition to the query parameters documented here. If no filters are provided, the API returns all the records (with pagination). For example, with the parameter **`name=Alice`**, only records where the field **`name`** has value **`Alice`** will be returned. Similarly, adding the parameters **`name__in=Alice`** and **`name__in=Bob`** will result in records with **`name`** equal to **`Alice`** OR **`name`** equal to **`Bob`** being returned. ### Filters Filters are supported on Text, Numeric, Date and DateTime fields, although not all filters are supported by all fields. It is also possible to filter on an array of strings, or a string field nested in an array of objects. In this case, the record will be present in the response if one of the field values in the array matches the filter. Multiple filters on different fields and different filter types can be combined in the same query. An indexed field with an object can be filtered by using the dot notation, for example, **`address.city=Brooklyn`**. A number of different types of filters are supported. #### Equals This can be specified as simple query parameter. Supported Types: Text, Numeric, Date, DateTime, Fields within Arrays. *Example:* Adding **`&name=Alice`** as a query parameter will return records where the name field matches Alice. #### Not Equals This can be specified with the **`neq`** modifier to the query parameter key. Supported Types: Text, Numeric, Date, DateTime, Fields within Arrays. *Example:* Adding **`&name__neq=Alice`** as a query parameter will return records where the name field does not match Alice. #### Equals Any Of This is basically an `OR` clause for Equals on a given field. This can be specified with the **`in`** modifier to the query parameter key. Supported Types: Text, Numeric, Date, DateTime, Fields within Arrays. *Example:* Adding **`&name__in=Alice&name__in=Bob`** as a query parameter will return records where the name field matches either Alice or Bob. #### Comparison The following comparison filters are supported: * Greater Than with the modifier `gt` * Greater Than Or Equals with the modifier `gte` * Less Than with the modifier `lt` * Less Than Or Equals with the modifier `lte` Supported Types: Numeric, Date, DateTime. *Example:* Adding **`&createdDate__gt=2020-11-11&rating__gte=4`** as a query parameter will return records where the `createdDate` is after `2020-11-11` and the `rating` field has a value greater than or equal to `4`. #### GeoSearch Supports filtering to records for which the specified field is within the supplied radius to the supplied latitude and longitude. Supported Types: Coordinates (ex: `yextDisplayCoordinate`, `displayCoordinate`, etc.). GeoSearch queries are constructed by appending a `__geo` comparator to a coordinate field in the request. The details of the GeoSearch must then be included, comma separated, as part of the query value, optionally surrounded by parantheses. The following parameters are supported: * The latitude of the point to geosearch from, specified as `lat` * The longitude of the point to geosearch from, specified as `lon` * The numeric radius from the point which results will be filtered to, specifed as `radius` * The unit of measurement for the radius, specified as `unit`. One of `km`, `mi`, `m`, `ft`. Defaults to `mi` *Example:* Adding **`&yextDisplayCoordinate__geo=(lat:40.740,lon:-73.987565,radius:50,unit:km)`** as a query parameter will return records where the `yextDisplayCoordinate` field on the entities is within 50 km of the provided latitude and longitude. Like all other filters, the field which is being geosearched upon must be specified in the `fieldIndexes` of the endpoint definition. ### Sorting Content Endpoints support sorting by an indexed field. This can be enabled by adding the `$sortBy` query parameter with field name as the value. Optionally, the modifiers `asc` and `desc` can be added to indicate sorting by ascending and descending orders respectively. If no modifier is specified, the results will be returned in descending order. Currently, sorting is only supported on a single field per request. *Example:* Adding **`&$sortBy__desc=createdDate`** as a query parameter will return records with the most recent `createdDate` first. ### Additional Notes on Supported Types Indexes are supported on String, Numeric, Date and DateTime types. The set of supported filters for each type is documented in the previous section. #### String Content Endpoints support indexing UTF-8 strings with a maximum length of 256 characters. #### Date and DateTime * The timezone information on a DateTime, if present, will be stripped away during indexing, without converting the time to another timezone. * For indexing, the system expects to get [RFC3339 DateTime format](https://datatracker.ietf.org/doc/html/rfc3339) for DateTimes and `YYYY-MM-DD` for Dates. * For querying, API accepts the following formats: `YYYY-MM-DD`, `YYYY-MM-DDTHH`, `YYYY-MM-DDTHH:MM` and `YYYY-MM-DDTHH:MM:SS`. responses: '200': $ref: '#/components/responses/StreamsResponse' default: $ref: '#/components/responses/ErrorResponse' components: securitySchemes: api_key: type: apiKey name: api_key in: query api-key: type: apiKey name: api-key in: header parameters: accountId: name: accountId in: path required: true schema: type: string entityId: name: entityId in: path schema: type: string required: true description: | The external ID of the requested Entity. languageCode: name: languageCode in: path required: true schema: type: string description: | The language code corresponding to the language of the profiles that the user wishes to retrieve entityTypePath: name: entityType in: path schema: type: string required: true description: | The type of entity to be created. Should be one of the following: * `atm` * `event` * `healthcareFacility` * `healthcareProfessional` * `hotel` * `job` * `location` * `restaurant` * `faq` OR the API name of a custom entity type. v: name: v in: query required: true schema: type: string description: A date in `YYYYMMDD` format. listId: name: listId in: path required: true schema: type: string description: ID of this List. locationId: name: locationId in: path required: true schema: type: string fields: name: fields in: query required: false schema: type: string description: | Comma-separated list of field names from the Location object. When present, only the fields listed will be returned. You can use dot notation to specify substructures (e.g., `"logo.url"`). To include a custom field, specify it as `custom###`, where "###" is the custom field's **`id`**. limit: name: limit in: query schema: type: integer default: 10 maximum: 50 description: Number of results to return. offset: name: offset in: query required: false schema: type: integer minimum: 0 maximum: 9949 default: 0 description: Number of results to skip. Used to move through results languages: name: languages in: query required: false schema: type: string default: 'false' description: | Comma-separated list of language codes. When present, the system will return Locations with one or more of the provided languages. For each Location, only the first available language from the provided list will be returned. The keyword `"primary"` can be used to refer to a Location’s primary profile without providing a specific language code. filters: name: filters in: query required: false schema: type: string description: | 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 `custom###`, where "###" is the custom field’s **`id`**. For example, to provide a filter that would match location names containing the word "gourmet", the filter parameter would be `[{"name":{"contains":["gourmet"]}}]`, which URL-encoded would be `%5B%7B%22name%22%3A%7B%22contains%22%3A%5B%22gourmet%22%5D%7D%7D%5D`. NOTE: "x", "xx", and "xxx" are reserved keywords that, when passed in a `contains` matcher for a Full or Text filter, will cause that filter to match on all locations. The filter types are the following. Note there may be multiple available specifications for a given filter type:
Filter Type Syntax Description
Full fieldName: {contains: $search} $search is the search string
Text fieldName: {$type: [$search,...]} $type is one of [contains,doesNotContain,startsWith,equalTo], $search is an array of search strings, combined with OR
Text fieldName: $type $type is one of [empty,notEmpty]
Number fieldName: {$type: $value} $type is one of [eq,lt,gt,le,ge], $value is the numeric value
Number fieldName: {$type: [$value1, $value2]} $type is one of [between], $value1 and $value2 are numeric values
Date fieldName: {$type: $value} $type is one of [eq,lt,gt,le,ge], $value is a string of "YYYY-MM-DD" formatted date
Date fieldName: $type $type is one of [empty,notEmpty]
Date fieldName: {$type: [$value1, $value2]} $type is one of [between], $value1 and $value2 are strings of "YYYY-MM-DD" formatted date
Categories fieldName: {$type: [$id,...]} $type is one of [includes,notIncludes], $id is an array of numeric category IDs, combined with OR
Categories fieldName: $type $type is one of [none]
Assets fieldName: {$type: [$id,...]} $type is one of [includes,notIncludes], $id is an array of numeric category IDs, combined with OR
Assets fieldName: $type $type is one of [none]
Country fieldName: {$type: [$country,...]} $type is one of [includes,notIncludes], $country is an array of country code strings, combined with OR
PrimaryLanguage fieldName: {$type: [$language,...]} $type is one of [is,isNot], $language is an array of language code strings, combined with OR
AlternateLanguage fieldName: {$type: [$language,...]} $type is one of [includes, notIncludes], $language is an array of language code strings, combined with OR
StringSingle fieldName: {$type: [$string,...]} $type is one of [is,isNot], $string is an array of strings, combined with OR
StringList fieldName: {$type: [$string,...]} $type is one of [includes,notIncludes], $string is an array of strings, combined with OR
LocationType fieldName: {$type: [$id,...]} $type is one of [is,isNot], $id is an array of location type IDs, combined with OR
Bool fieldName: $type $type is one of [true,false]
Option fieldName: {$type: $id} $type is one of [is,isNot], $id is an option ID (For single option custom fields)
Option fieldName: {$type: [$id,...]} $type is one of [includes,notIncludes], $id is an array of option IDs, combined with OR (For multi option custom fields)
Folder fieldName: [$id,...] $id is a numeric folder ID
Folder fieldName: $id $id is a numeric folder ID
Folder fieldName: {$type: [$id,...]} $id is a numeric folder ID, $type is one of ['isIn', 'isNotIn']
Labels fieldName: {$type: [$id,...]} $type is one of [includes,notIncludes], $id is an array of label IDs, combined with OR
The following fields can be specified in the request (Field name/Filter Type/Example(s)):
Field Name Filter Type Example(s)
location Full "location": {"contains": "Atlanta"}
name Text "name": {"startsWith": ["Guitar"]}, "name": {"contains": ["A","B"]}
address Text "address": {"startsWith": ["South"]}
address2 Text "address2": {"contains": ["Suite"]}
city Text "city": {"contains": ["Atlanta"]}
state Text "state": {"contains": ["AK","VA"]}
zip Text "zip": {"contains": ["M5K 7QB"]}
phones Text "phones": {"startsWith": ["703","571"]}
specialOffer Text "specialOffer": "notEmpty"
emails Text "emails": {"doesNotContain": ["@yext.com"]}
website Text "website": {"equalTo": ["https://www.yext.com/"]}
categories Categories "categories": {"includes": [23,755,34]}
closed Bool "closed": true
storeId Text "storeId": {"equalTo": ["MCD0001"]}
countryCode Country "countryCode": {"notIncludes": ["US"]}
products Text "products": {"startsWith": ["Burger","Fries"]}
services Text "services": {"contains": ["Manicures"]}
specialities Text "services": "notEmpty"
associations Text "associations": "empty"
brands Text "brands": {"equalTo": ["North Face"]}
languages Text "languages": {"equalTo": ["English","Spanish"]}
keywords Text "keywords": {"startsWith": ["Franchise"]}
menuIds IdList "menuIds": {"includes": ["m-23","755","menu34"]}
productListIds IdList "productListIds": {"notIncludes": ["pl-2"]}
calendarIds IdList "calendarIds": {"notIncludes": ["cal34"]}
bioIds IdList "bioIds": {"includes": ["b23","34"]}
custom### Text (for Multiline Text, URL, Text List, and Text Custom Fields), Number, Date, Bool, or Option "custom123": {"equalTo": ["asdf"]}
folder Folder "folder": 123, "folder": [123,456]
primary_language PrimaryLanguage "primary_language": {"is": "fr_CA"}
alternateProfileLanguage AlternateLanguage "alternateProfileLanguage": {"includes": ["en", "fr"]}
npi StringSingle "npi": {"is": ["1234567890", "1111111111"]}
conditionsTreated Text "conditionsTreated": {"startsWith": ["Influenza"]}, "conditionsTreated": {"contains": ["A","B"]}
lastUpdated Date "lastUpdated": {"eq": "2018-01-01"}, "lastUpdated": {"between": ["2017-01-01", "2018-01-01"]}
fieldsWithData Fields "fieldsWithData": ["email", "hours"]
fieldsWithoutData Fields "fieldsWithoutData": ["logo", "video"]
reviewCount Number "review_count": {"gt": 1}, "review_count ": {"lt": 10}
averageRating Number "averageRating": {"lt": 3}
locationType LocationType "locationType": {"is": [1]}, "locationType": {"isNot": [123]}
gender StringSingle "gender": {"is": ["FEMALE"]}, "gender": {"isNot": ["MALE"]}
degrees StringList "degrees": {"includes": ["MD"]}, "degrees": {"notIncludes": ["PHD"]}
experiences StringList "experiences": {"includes": ["FELLOWSHIP"]}, "experiences": {"notIncludes":["INTERNSHIP"]}
yearCompleted Number "yearCompleted": {"gt": 2000}, "yearCompleted": {"lt": 2015}
acceptingNewPatients Bool "acceptingNewPatients": true
firstName Text "firstName": {"startsWith": ["David"]}, "firstName": {"contains": ["A","B"]}
middleName Text "middleName": {"startsWith": ["P"]}, "middleName": {"contains": ["N","E"]}
lastName Text "lastName": {"startsWith": ["Sm"]}, "lastName": {"contains": ["Y","Z"]}
officeName Text "officeName": {"startsWith": ["Chiropractic"]}, "officeName": {"contains":["Center","P"]}
certifications Text "certifications": {"contains": ["Radiation Oncology"]}
institutionName Text "institutionName": {"startsWith": ["New York"]}
insuranceAccepted Text "insuranceAccepted": {"startsWith": ["United"]}, "insuranceAccepted":{"contains": ["C","Health"]}
admittingHospitals Text "admittingHospitals": {"startsWith": ["Children's"]}, "admittingHospitals":{"contains": ["Medical","University"]}
subscriptions IdList "subscriptions": {"notIncludes": ["123"]}
facebookAccounts IdList "facebookAccounts": {"notIncludes": ["1111"]}
foursquareAccounts IdList "foursquareAccounts": {"notIncludes": ["1111"]}
googleplusAccounts IdList "googleplusAccounts": {"notIncludes": ["1111"]}
labels Labels "labels": {"includes": [1, 100]}
sortBy: name: sortBy in: query required: false schema: type: string description: | Specifies the fields and direction by which the output should be sorted. Should be provided as a URL-encoded string containing a JSON array of `sortDefinition` objects. A `sortDefinition` object consists of a `sortField` and a `sortDirection` field. The `sortField` is the name of the field you are sorting by (e.g., `firstName` or `custom###` for a custom field, where "###" is the custom field’s **`id`**). The `sortDirection` indicates whether the sort is ascending (`ASCENDING`) or descending (`DESCENDING`). For example, to sort by last name ascending and first name descending, this parameter would be `[{"sortField":"lastName","sortDirection":"ASCENDING"},{"sortField":"firstName", "sortDirection":"DESCENDING"}]`, which, when URL-encoded, would be `%5B%7B%22sortField%22%3A%22lastName%22%2C%22sortDirection%22%3A%22ASCENDING%22%7D%2C%7B%22sortField%22%3A%22firstName%22%2C%22sortDirection%22%3A%22DESCENDING%22%7D%5D`. **NOTE:** Currently, we support sorting by **`firstName`**, **`lastName`**, and text custom fields. location: name: location in: query required: true schema: type: string description: | Only entities near this position will be returned. The values can be specified in one of two ways: 1) Latitude and Longitude: The latitude and longitude of the point, separated by a comma (e.g.`"40.740957,-73.987565"`), 2) Address: A free-form address to geocode into a latitude and longitude (e.g., `"1 Madison Ave, New York, NY 10010"` or `"New York, NY"`). Note that providing an address that resolves to an area, like a city or a postal code, does not restrict the search to exactly that area; it simply centers the search circle on a point in that area. radius: name: radius in: query required: false schema: type: number default: 10 minimum: 0.1 maximum: 500 description: | Indicates the search radius around the provided **`location`** in miles geocoderBias: name: geocoderBias in: query required: false schema: type: string description: | The latitude, longitude, and approximate radius in miles, separated by commas, where the geocoder should be biased. countryBias: name: countryBias in: query schema: type: string required: false description: | The two-character ISO 3166-1 code of the country where the geocoder should be biased. The value of the **`countryBias`** parameter influences the search results, but it does not guarantee that the geocoded location will be in the country provided. If both **`countryBias`** and **`geocoderBias`** are provided, **`geocoderBias`** is given priority, but both values are considered in the search. apiIdentifier: name: apiIdentifier in: path required: true schema: type: string description: | The unique identifier of this review. One of: * A UUID generated at the time the Review Creation request is accepted. * The invitationUid, if the review is associated with an invitation. This ID will be returned in the response to any requests to the Review: Create Live API endpoint. This ID will also be included in the Reviews Webhook, and the Review: Get/List Knowledge API endpoints. endpoint: name: endpoint in: path required: true schema: type: string description: The ID of the Content Endpoint to query. contentDocIds: name: ids in: path required: true schema: type: array items: type: string style: simple description: | The Content records to get. Multiple record IDs can be provided separated by commas. pageToken: name: pageToken in: query schema: type: string required: false description: | If a response to a previous request contained the **`nextPageToken`** field, pass that field's value as the **`pageToken`** parameter to retrieve the next page of data. schemas: ResponseMeta: type: object properties: uuid: type: string example: 4f72b877-e2d0-4de4-9324-b9cf2c03e1a0 description: Unique ID for this request / response. ResponseError: type: object properties: name: type: string code: type: integer description: | Code that uniquely identifies the error or warning. type: type: string enum: - FATAL_ERROR - NON_FATAL_ERROR - WARNING message: type: string description: Message explaining the problem. ResponseMetaWithError: allOf: - $ref: '#/components/schemas/ResponseMeta' - type: object properties: errors: type: array description: List of errors and warnings. items: $ref: '#/components/schemas/ResponseError' EntitySchema: type: object properties: '@context': type: string '@type': type: string '@id': type: string Name: type: string Image: type: string Geo: type: object properties: '@type': type: string Latitude: type: number format: double Longitude: type: number format: double Address: type: object properties: '@type': type: string StreetAddress: type: string AddressLocality: type: string PostalCode: type: string AddressCountry: type: string Telephone: type: string BaseEcl: type: object properties: id: type: string maxLength: 32 description: List ID. accountId: type: string readOnly: true description: ID of account that owns this List. name: type: string description: List name. title: type: string description: List title that appears on listings. size: type: integer readOnly: true description: Number of items in the List. publish: type: boolean description: Indicates whether the List should be shown on your listings. language: type: string description: | List language in ISO 639-1 format. An ISO 3166-1 alpha-2 country code can optionally be appended to the language. **Examples:** en, en_GB, fr_CA BaseEclSection: type: object properties: id: type: string description: Section ID. name: type: string description: Section name. description: type: string description: Section description. BaseEclItem: type: object properties: id: type: string description: Item ID. name: type: string description: Item name. description: type: string description: Item description. Photo: type: object properties: url: type: string description: URL of photo. height: type: integer description: Dimension in pixels. width: type: integer description: Dimension in pixels. alternateText: type: string description: The alternate text to be used for accessibility purposes. Calories: type: object properties: type: type: string enum: - FIXED - RANGE calorie: type: integer description: Calorie count. Must be greater than or equal to 0 and less than or equal to 1000000. rangeTo: type: integer description: Specified only if `name` is `RANGE`. In that case, this Calories represents a calorie count range from `calorie` to `rangeTo`. Must be greater than `calorie` and less than or equal to 1000000. ContentListCostOption: type: object properties: name: type: string description: e.g., Small, Medium, Large, Add Bacon. price: type: string description: A simple price in USD, e.g., 1.00. calorie: type: integer description: How many calories this option adds. This field is for Menu items only. ContentListCost: type: object properties: type: type: string enum: - PRICE - RANGE - NONE - OTHER price: type: string description: Price in USD, e.g., 9.50. Must be greater than or equal to 0.0 and less than or equal to 1000000.00. unit: type: string description: e.g., Per Gallon, Each. rangeTo: type: string description: Specified only if `type` is `RANGE`. In that case, this Cost represents a `price` range from `price` to `rangeTo`. Must be greater than `price` and less than or equal to 1000000.00. other: type: string description: Specified only if `type` is `OTHER`. User-entered text, e.g., Market Price. options: type: array description: Add-ons or product variations that affect the price. items: $ref: '#/components/schemas/ContentListCostOption' MenuItem: allOf: - $ref: '#/components/schemas/BaseEclItem' - type: object properties: photo: $ref: '#/components/schemas/Photo' calories: $ref: '#/components/schemas/Calories' cost: $ref: '#/components/schemas/ContentListCost' url: type: string description: The URL of the item's webpage. allergens: type: array items: type: string description: | A list of allergens associated with the menu item. Valid elements are: * Peanuts * Wheat * Sesame * Tree Nuts * Gluten * Soy * Dairy * Eggs * Fish * Shellfish * Shrimp * Crab * Soba featured: type: boolean description: Indicates whether the item is a featured item on the menu. spiciness: type: string description: | The spiciness level of a food item. Valid elements are: * Mild * Medium * Hot dietaryRestrictions: type: array items: type: string description: | Dietary information of a food item. Valid elements are: * Halal * Kosher * Organic * Vegan * Vegetarian preparationMethods: type: array items: type: string description: | Methods on how the food dish option is prepared. Valid elements are: * Baked * Barbecued * Basted * Blanched * Boiled * Braised * Coddled * Fermented * Fried * Grilled * Kneaded * Marinated * Pan Fried * Pickled * Pressure Cooked * Roasted * Sauteed * Seared * Simmered * Smoked * Steamed * Steeped * Stir Fried * Other Method Section: allOf: - $ref: '#/components/schemas/BaseEclSection' - type: object properties: items: type: array description: Section Items. items: $ref: '#/components/schemas/MenuItem' Menu: allOf: - $ref: '#/components/schemas/BaseEcl' - type: object properties: currency: type: string description: The three-letter ISO 4217 currency code. Defaults to USD. sourceUrl: type: string description: The URL of the source the menu's content is retrieved from. sections: type: array description: A list of sections. items: $ref: '#/components/schemas/Section' BioItem: allOf: - $ref: '#/components/schemas/BaseEclItem' - type: object properties: photo: $ref: '#/components/schemas/Photo' title: type: string description: Person's title. phone: type: string description: Item Phone. email: type: string description: Item Email. education: type: array description: List of up to 10 strings. items: type: string certifications: type: array description: List of up to 10 strings. items: type: string services: type: array description: List of up to 100 strings. items: type: string url: type: string description: Item URL. BioEcl_Section: allOf: - $ref: '#/components/schemas/BaseEclSection' - type: object properties: items: type: array description: Section Items. items: $ref: '#/components/schemas/BioItem' Bio: allOf: - $ref: '#/components/schemas/BaseEcl' - type: object properties: sections: type: array description: A list of sections. items: $ref: '#/components/schemas/BioEcl_Section' Photos: type: array description: List of up to 5 photos. items: $ref: '#/components/schemas/Photo' Duration: type: object description: Product duration. properties: unit: type: string enum: - MINUTES - HOURS - DAYS description: Unit of time (i.e. minutes, hours, days). value: type: number minimum: 1 description: Value of time. ProductItem: allOf: - $ref: '#/components/schemas/BaseEclItem' - type: object properties: photos: $ref: '#/components/schemas/Photos' cost: $ref: '#/components/schemas/ContentListCost' idcode: type: string description: Displayed item ID. url: type: string description: Product home page. video: type: string description: Youtube URL. duration: $ref: '#/components/schemas/Duration' ranking: type: number minimum: 0 description: Product ranking. ProductEcl_Section: allOf: - $ref: '#/components/schemas/BaseEclSection' - type: object properties: items: type: array description: Section Items. items: $ref: '#/components/schemas/ProductItem' Product: allOf: - $ref: '#/components/schemas/BaseEcl' - type: object properties: currency: type: string description: The three-letter ISO 4217 currency code. Defaults to USD. sections: type: array description: A list of sections. items: $ref: '#/components/schemas/ProductEcl_Section' EventItem: allOf: - $ref: '#/components/schemas/BaseEclItem' - type: object properties: type: type: string description: User-provided event type. starts: type: string format: date description: Start time in ISO 8601 format (yyyy-mm-ddThh:mm) (e.g., 2012-01-09T04:00). ends: type: string format: date description: End time in ISO 8601 format (yyyy-mm-ddThh:mm) (e.g., 2012-01-09T05:00). photos: $ref: '#/components/schemas/Photos' url: type: string description: Item URL. video: type: string description: Youtube URL. EventEcl_Section: allOf: - $ref: '#/components/schemas/BaseEclSection' - type: object properties: items: type: array description: Section Items. items: $ref: '#/components/schemas/EventItem' Event: allOf: - $ref: '#/components/schemas/BaseEcl' - type: object properties: sections: type: array description: A list of sections. However, Calendars cannot have more than one section. items: $ref: '#/components/schemas/EventEcl_Section' LocationType: type: string enum: - LOCATION - HEALTHCARE_PROFESSIONAL - HEALTHCARE_FACILITY - RESTAURANT - ATM Photo-2: type: object properties: url: type: string description: | Valid URL to image. Accepted formats: .jpg, .gif, .png. While updating this field, if the image could not be downloaded, or if its URL is invalid, the image will be ignored. The success response will contain a warning message explaining why the image was not stored in the system. sourceUrl: type: string readOnly: true description: | The URL the image was uploaded from, if applicable. Note that this URL may not currently be valid. description: type: string description: Image description. details: type: string description: Image details. alternateText: type: string description: The alternate text to be used for accessibility purposes. width: type: integer readOnly: true description: Original photo width. height: type: integer readOnly: true description: Original photo height. derivatives: type: array readOnly: true items: type: object properties: url: type: string readOnly: true description: |- The URL to derivative image. Derivative images are alternate versions of the original image (e.g., smaller versions used to improve page-load times on your site). They are primarily used with our Pages product. width: type: integer readOnly: true description: Derivative photo width. height: type: integer readOnly: true description: Derivative photo height. description: If no derivative photos are available, this attribute is omitted rather than empty. Location: type: object properties: id: type: string maxLength: 50 description: Primary key. Unique alphanumeric (Latin-1) ID assigned by the Customer. uid: type: string readOnly: true description: A static globally unique id for the location. Note that this field cannot be used in place of the location id in API calls to get or update location information. accountId: type: string maxLength: 50 description: Must refer to an **account.id** that already exists. timestamp: type: integer format: int64 readOnly: true description: | The timestamp of the most recent change to this location record. Will be ignored when the client is saving location data to Yext. **NOTE:** The timestamp may change even if observable fields stay the same. timezone: readOnly: true description: | The timezone of the location minLength: 0 type: string locationType: $ref: '#/components/schemas/LocationType' locationName: type: string maxLength: 100 description: | Cannot include: * inappropriate language * HTML markup or entities * a URL or domain name * a phone number * control characters ([\x00-\x1F\x7F]) Should be in appropriate letter case (e.g., not in all capital letters) firstName: type: string description: | The first name of the healthcare professional **NOTE:** This field is only available to locations whose **`locationType`** is `HEALTHCARE_PROFESSIONAL`. middleName: type: string description: | The middle name of the healthcare professional **NOTE:** This field is only available to locations whose **`locationType`** is `HEALTHCARE_PROFESSIONAL`. lastName: type: string description: | The last name of the healthcare professional **NOTE:** This field is only available to locations whose **`locationType`** is `HEALTHCARE_PROFESSIONAL`. officeName: type: string description: | The name of the office where the healthcare professional works, if different from **locationName** **NOTE:** This field is only available to locations whose **`locationType`** is `HEALTHCARE_PROFESSIONAL`. gender: type: string description: | The gender of the healthcare professional **NOTE:** This field is only available to locations whose **`locationType`** is `HEALTHCARE_PROFESSIONAL`. enum: - FEMALE - F - MALE - M - UNSPECIFIED npi: type: string description: | The National Provider Identifier (NPI) of the healthcare provider **NOTE:** This field is only available to locations whose **`locationType`** is `HEALTHCARE_PROFESSIONAL` or `HEALTHCARE_FACILITY`. address: type: string maxLength: 255 description: | Must be a valid address Cannot be a P.O. Box address2: type: string maxLength: 255 description: Cannot be a P.O. Box suppressAddress: type: boolean description: If true, do not show street address on listings. Defaults to false. displayAddress: type: string maxLength: 255 description: | 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: type: string maxLength: 80 state: type: string maxLength: 80 description: | 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: type: string maxLength: 255 description: The name of the location's sublocality. zip: type: string maxLength: 10 description: The location's postal code. For US locations, this field contains the five- or nine-digit ZIP code (the hyphen is optional). countryCode: type: string maxLength: 2 description: The two-character ISO 3166-1 code of the location's country or region. If omitted, US is used. serviceArea: type: object properties: radius: type: number format: double description: | The distance around the location that the business serves **NOTE:** This field is no longer supported by Google Business Profile and is deprecated. We no longer accept or store values for **`radius`**. unit: type: string description: | The unit in which radius is measured. **NOTE:** This field is no longer supported by Google Business Profile and is deprecated. We no longer accept or store values for **`units`**. places: type: array items: type: string description: | A list of places served by the location, where each place is either: * a postal code, or * the name of a city. description: | 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: type: string description: Must be a valid phone number. isPhoneTracked: type: boolean description: | 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: type: string description: | Must be a valid, non-toll-free phone number. Required if: * **isPhoneTracked** is true and the non-tracked number is a toll-free number, **OR** * **isPhoneTracked** is false and **phone** is a toll-free number alternatePhone: type: string description: Must be a valid phone number, based on the country specified in `countryCode`. Phone numbers for US locations must contain 10 digits. faxPhone: type: string description: Must be a valid phone number, based on the country specified in `countryCode`. Phone numbers for US locations must contain 10 digits. mobilePhone: type: string description: Must be a valid phone number, based on the country specified in `countryCode`. Phone numbers for US locations must contain 10 digits. tollFreePhone: type: string description: Must be a valid phone number, based on the country specified in `countryCode`. Phone numbers for US locations must contain 10 digits. ttyPhone: type: string description: Must be a valid phone number, based on the country specified in `countryCode`. Phone numbers for US locations must contain 10 digits. categoryIds: type: array items: type: string description: | 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: type: string maxLength: 50 description: | The Featured Message. Default: Call today! Cannot include: * inappropriate language * HTML markup * a URL or domain name * a phone number * control characters ([\x00-\x1F\x7F]) * insufficient spacing If you submit a Featured Message that contains profanity or more than 50 characters, it will be ignored. The success response will contain a warning message explaining why your Featured Message wasn't stored in the system. featuredMessageUrl: type: string maxLength: 255 description: Valid URL to which the Featured Message is linked websiteUrl: type: string maxLength: 255 description: | The URL of the location's website. This URL will be shown on your listings unless you specify a value for `displayWebsiteUrl`. Must be a valid URL and is required whenever `displayWebsiteUrl` is specified. displayWebsiteUrl: type: string maxLength: 255 description: | The URL that is shown on your listings in place of `websiteUrl`. You can use `displayWebsiteUrl` to display a short, memorable web address that redirects consumers to the URL given in `websiteUrl`. Must be a valid URL and be specified along with `websiteUrl`. reservationUrl: type: string maxLength: 255 description: A valid URL used for reservations at this location. displayReservationUrl: type: string maxLength: 255 description: | The URL that is shown on your listings in place of `reservationUrl`. You can use `displayReservationUrl` to display a short, memorable web address that redirects consumers to the URL given in `reservationUrl`. Must be a valid URL and be specified along with `reservationUrl`. menuUrl: type: string maxLength: 255 description: The URL of the location's menu. displayMenuUrl: type: string maxLength: 255 description: | The URL that is shown on your listings in place of `menuUrl`. You can use `displayMenuUrl` to display a short, memorable web address that redirects consumers to the URL given in `menuUrl`. Must be a valid URL and be specified along with `menuUrl`. orderUrl: type: string maxLength: 255 description: The URL used to place orders that will be fulfilled at the location. displayOrderUrl: type: string maxLength: 255 description: | The URL that is shown on your listings in place of `orderUrl`. You can use `displayOrderUrl` to display a short, memorable web address that redirects consumers to the URL given in `orderUrl`. Must be a valid URL and be specified along with `orderUrl`. hours: type: string maxLength: 255 description: | Hours should be submitted as a comma-separated list of days, where each day's hours are specified as follows: d:oh:om:ch:cm * d = day of the week – * 1 – Sunday * 2 – Monday * 3 – Tuesday * 4 – Wednesday * 5 – Thursday * 6 – Friday * 7 – Saturday * oh:om = opening time in 24-hour format * ch:cm = closing time in 24-hour format Times with single-digit hours (e.g., 9 AM) can be submitted with or without a leading zero (9:00 or 09:00). **Example:** open 9 AM to 5 PM Monday and Tuesday, open 10 AM to 4 PM on Saturday – 2:9:00:17:00,3:9:00:17:00,7:10:00:16:00 SPECIAL CASES: * To indicate that a location is open 24 hours on a specific day, set 00:00 as both the opening and closing time for that day. * **Example:** open all day on Saturdays – 7:00:00:00:00 * To indicate that a location is closed on a specific day, omit that day from the list or set it as closed ("closed" is not case sensitive). * **Example:** closed on Sundays – 1:closed * **NOTE:** If a location is closed seven days a week, set at least one day to closed. Otherwise, **hours** is an empty string, and we assume you are not submitting hours information for that location. * To indicate that a location has split hours on a specific day, submit a set of hours for each block of time the location is open. * **Example:** open from 9:00 AM to 12:00 PM and again from 1:00 PM to 5:00 PM on Mondays – 2:9:00:12:00,2:13:00:17:00 **NOTE:** To set hours for specific days of the year rather than days of the week, use **holidayHours**. additionalHoursText: type: string maxLength: 255 description: Additional information about business hours that does not fit in **hours** (e.g., Closed during the winter) holidayHours: type: array items: type: object properties: hours: type: string description: | Special opening and closing times in 24-hour format (OH:OM:CH:CM, where OH:OM is the opening time and CH:CM is the closing time). Times with single-digit hours (e.g., 9 AM) can be submitted with or without a leading zero (9:00 or 09:00). Examples: * 9:00:15:00 — Opening at 9:00 AM, closing at 3:00 PM * "" (empty string) — Closed all day * 0:00:0:00 or 0:00:23:59 — Open 24 hours * 9:00:15:00,17:00:19:00 — Split hours: open from 9:00 AM to 3:00 PM and again from 5:00 PM to 7:00 PM **NOTE:** If **isRegularHours** is set to true, we will ignore this field. date: type: string format: date description: The date on which the holiday hours will be in effect isRegularHours: type: boolean default: false description: Indicates whether the holiday hours are the same as the regular business hours for the given date. If set to true, we will update the holiday hours if the regular business hours change for the date's day of the week. description: | Holiday hours for this location. **NOTE:** hours must be set in order for holidayHours to appear on your listings) description: type: string minLength: 10 maxLength: 5000 conditionsTreated: type: array items: type: string description: | A list of the conditions treated by the healthcare provider **NOTE:** This field is only available to locations whose **`locationType`** is `HEALTHCARE_PROFESSIONAL` or `HEALTHCARE_FACILITY`. certifications: type: array items: type: string description: | A list of the certifications held by the healthcare professional **NOTE:** This field is only available to locations whose **`locationType`** is `HEALTHCARE_PROFESSIONAL`. educationList: type: array items: type: object properties: type: type: string description: The kind of education or training completed enum: - FELLOWSHIP - INTERNSHIP - MEDICAL_SCHOOL - RESIDENCY institutionName: type: string description: The name of the institution where the healthcare professional received the education or training yearCompleted: type: string description: The year the healthcare professional completed the education or training description: | A list of the types of education and training completed by the healthcare professional **NOTE:** This field is only available to locations whose **`locationType`** is `HEALTHCARE_PROFESSIONAL`. degrees: type: array items: type: string description: | A list of the degrees earned by the healthcare professional **NOTE:** This field is only available to locations whose **`locationType`** is `HEALTHCARE_PROFESSIONAL`. Valid values: * `ANP` (Adult Nurse Practitioner) * `APN` (Advanced Practice Nurse) * `APRN` (Advanced Practice Registered Nurse) * `ARNP` (Advanced Registered Nurse Practitioner) * `CNM` (Certified Nurse Midwife) * `CNP` (Certified Nurse Practitioner) * `CNS` (Clinical Nurse Specialist) * `CPNP` (Certified Pediatric Nurse Practitioner) * `CRNA` (Certified Registered Nurse Anesthetist) * `CRNP` (Certified Registered Nurse Practitioner) * `DC` (Doctor of Chiropractic) * `DDS` (Doctor of Dental Surgery) * `DMD` (Doctor of Dental Medicine) * `DO` (Doctor of Osteopathy) * `DPM` (Doctor of Podiatric Medicine) * `DVM` (Doctor of Veterinary Medicine) * `FNP` (Family Nurse Practitioner) * `GNP` (Geriatric Nurse Practitioner) * `LAC` (Licensed Acupuncturist) * `LPN` (Licensed Practical Nurse) * `MD` (Medical Doctor) * `ND` (Naturopathic Doctor) * `NP` (Nurse Practitioner) * `OD` (Doctor of Optometry) * `PA` (Physician Assistant) * `PAC` (Physician Assistant Certified) * `PHARMD` (Doctor of Pharmacy) * `PHD` (Doctor of Philosophy) * `PNP` (Pediatric Nurse Practitioner) * `VMD` (Veterinary Medical Doctor) * `WHNP` (Womens Health Nurse Practitioner) admittingHospitals: type: array items: type: string description: | A list of hospitals where the healthcare professional admits patients **NOTE:** This field is only available to locations whose **`locationType`** is `HEALTHCARE_PROFESSIONAL`. acceptingNewPatients: type: boolean description: | Indicates whether the healthcare provider is accepting new patients Default is true **NOTE:** This field is only available to locations whose **`locationType`** is `HEALTHCARE_PROFESSIONAL` or `HEALTHCARE_FACILITY`. closed: type: object properties: isClosed: type: boolean description: Indicates whether the location is closed description: | 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: type: array items: type: string description: | The payment methods accepted at this location Valid elements depend on the location's country. For US locations, valid elements are: * AMERICANEXPRESS * CASH * CHECK * DINERSCLUB * DISCOVER * FINANCING * INVOICE * MASTERCARD * TRAVELERSCHECK * VISA * ANDROIDPAY * APPLEPAY * SAMSUNGPAY * BITCOIN * PAYPAL insuranceAccepted: type: array items: type: string description: | A list of insurance policies accepted by the healthcare provider **NOTE:** This field is only available to locations whose **`locationType`** is `HEALTHCARE_PROFESSIONAL`. logo: $ref: '#/components/schemas/Photo-2' photos: type: array items: $ref: '#/components/schemas/Photo-2' description: | 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. headshot: type: object description: | A portrait of the healthcare professional **NOTE:** This field is only available to locations whose **`locationType`** is `HEALTHCARE_PROFESSIONAL`. allOf: - $ref: '#/components/schemas/Photo-2' videoUrls: type: array items: type: string maxLength: 255 description: | 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: type: string description: Valid Instagram username for the location (e.g., NewCityFiat (without the leading "@")) twitterHandle: type: string maxLength: 15 description: |- 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: type: string maxLength: 255 description: | 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. googleCoverPhoto: type: object description: | The cover photo for your business's Google profile NOTE: Your cover photo must meet all of the following requirements: * have a 16:9 aspect ratio * be at least 480 x 270 pixels * be no more than 2120 x 1192 pixels allOf: - $ref: '#/components/schemas/Photo-2' googleProfilePhoto: type: object description: | The profile photo for your business's Google profile **NOTE:** Your profile picture must meet all of the following requirements: * be a square * be at least 250 x 250 pixels allOf: - $ref: '#/components/schemas/Photo-2' googleAttributes: type: array items: type: object properties: id: type: string description: | The unique ID Of the Google Business Profile keyword Keywords are determined by the location's primary category (e.g., `has_drive_through`, `has_fitting_room`, `kitchen_in_room`). optionIds: type: array items: type: string description: | The unique IDs of any options selected for the keyword. Keyword options provide more details on how the keyword applies to the location (e.g., if **`id`** is `has_drive_through`, **`optionIds`** may be `true` or `false`). description: | The Google Business Profile attributes for this location. facebookPageUrl: type: string maxLength: 255 description: | URL for the location's Facebook Page. Valid formats: * facebook.com/profile.php?id=[numId] * facebook.com/group.php?gid=[numId] * facebook.com/groups/[numId] * facebook.com/[Name] * facebook.com/pages/[Name]/[numId] where [Name] is a String and [numId] is an Integer If you submit a URL that is not in one of the valid formats, it will be ignored. The success response will contain a warning message explaining why the URL wasn't stored in the system. **NOTE:** This value is automatically set to the location's Facebook Page URL. You can only manually set **facebookPageUrl** if the location meets one of the following criteria: * It is not subscribed to a Listings package that contains Facebook. * It is opted out of Facebook. facebookCallToAction: description: Designates the Facebook Call-to-Action button text and value type: object properties: type: description: The action the consumer is being prompted to take by the button's text enum: - NONE - BOOK_NOW - CALL_NOW - CONTACT_US - SEND_MESSAGE - USE_APP - PLAY_GAME - SHOP_NOW - SIGN_UP - WATCH_VIDEO - SEND_EMAIL - LEARN_MORE - PURCHASE_GIFT_CARDS - ORDER_NOW - FOLLOW_PAGE type: string value: description: |- Indicates where consumers will be directed to upon clicking the Call-to-Action button (e.g., a URL). It can be a free-form string or an embedded value, depending on what the user specifies. For example, if the user sets the Facebook Call-to-Action as " 'Sign Up' using 'Website URL' " in the Yext platform, **`type`** will be `SIGN_UP` and **`value`** will be `[[websiteUrl]]`. The Call-to-Action will have the same behavior if the user sets the value to "Custom Value" in the platform and embeds a field. type: string additionalProperties: false facebookCoverPhoto: type: object description: | 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. allOf: - $ref: '#/components/schemas/Photo-2' facebookProfilePicture: type: object description: | 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. allOf: - $ref: '#/components/schemas/Photo-2' uberLinkType: type: string description: | 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. enum: - LINK - BUTTON uberLinkText: type: string maxLength: 100 description: | The text of the embedded Uber link Default is "Ride there with Uber". **NOTE:** This field is only available if **uberLinkType** is LINK. uberTripBrandingText: type: string maxLength: 28 description: | 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: type: string description: | 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: type: string maxLength: 150 description: | 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**. uberEmbedCode: type: string readOnly: true description: The Yext-powered code that can be copied and pasted into the markup of emails or web pages where the embedded Uber link should appear uberLink: type: string readOnly: true description: The Yext-powered link that can be copied and pasted into the markup of Yext Pages where the embedded Uber link should appear uberLinkRaw: type: string readOnly: true description: | The Uber universal link for the location. For more information on universal links, see Uber's developer documentation. **NOTE**: This field is only available in the LiveAPI and only for US locations. yearEstablished: type: string maxLength: 4 description: | The year that this location was opened, not the number of years it was open Minimum of 1000, maximum of current year + 10. displayLat: type: number format: double description: | Latitude where the map pin should be displayed, as provided by you Between -90.0 and 90.0, inclusive displayLng: type: number format: double description: | Longitude where the map pin should be displayed, as provided by you Between -180.0 and 180.0, inclusive routableLat: type: number format: double description: | Latitude to use for driving directions to the location, as provided by you Between -90.0 and 90.0, inclusive routableLng: type: number format: double description: | Longitude to use for driving directions to the location, as provided by you Between -180.0 and 180.0, inclusive walkableLat: type: number format: double description: | Latitude to use for walking directions to the location, as provided by you Between -90.0 and 90.0, inclusive walkableLng: type: number format: double description: | Longitude to use for walking directions to the location, as provided by you Between -180.0 and 180.0, inclusive pickupLat: type: number format: double description: | Latitude to use for pickup spot for the location, as provided by you Between -90.0 and 90.0, inclusive pickupLng: type: number format: double description: | Longitude to use for pickup spot for the location, as provided by you Between -180.0 and 180.0, inclusive dropoffLat: type: number format: double description: | Latitude to use for drop off spot for the location, as provided by you Between -90.0 and 90.0, inclusive dropoffLng: type: number format: double description: | Longitude to use for drop off spot for the location, as provided by you Between -180.0 and 180.0, inclusive yextDisplayLat: type: number format: double readOnly: true description: | Latitude where the map pin should be displayed, as calculated by Yext Between -90.0 and 90.0, inclusive yextDisplayLng: type: number format: double readOnly: true description: | Longitude where the map pin should be displayed, as calculated by Yext Between -180.0 and 180.0, inclusive yextRoutableLat: type: number format: double readOnly: true description: | Latitude to use for driving directions to the location, as calculated by Yext Between -90.0 and 90.0, inclusive yextRoutableLng: type: number format: double readOnly: true description: | Longitude to use for driving directions to the location, as calculated by Yext Between -180.0 and 180.0, inclusive yextWalkableLat: type: number format: double readOnly: true description: | Latitude to use for walking directions to the location, as calculated by Yext Between -90.0 and 90.0, inclusive yextWalkableLng: type: number format: double readOnly: true description: | Longitude to use for walking directions to the location, as calculated by Yext Between -180.0 and 180.0, inclusive yextPickupLat: type: number format: double readOnly: true description: | Latitude to use for pickup spot for the location, as calculated by Yext Between -90.0 and 90.0, inclusive yextPickupLng: type: number format: double readOnly: true description: | Longitude to use for pickup spot for the location, as calculated by Yext Between -180.0 and 180.0, inclusive yextDropoffLat: type: number format: double readOnly: true description: | Latitude to use for drop off spot for the location, as calculated by Yext Between -90.0 and 90.0, inclusive yextDropoffLng: type: number format: double readOnly: true description: | Longitude to use for drop off spot for the location, as calculated by Yext Between -180.0 and 180.0, inclusive emails: type: array items: type: string maxLength: 255 description: | Up to five emails addresses for reaching this location Must be valid email addresses specialities: type: array items: type: string maxLength: 100 description: | Up to 100 specialities (e.g., for food and dining: Chicago style) All strings must be non-empty when trimmed of whitespace. associations: type: array items: type: string maxLength: 100 description: | 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: type: array items: type: string maxLength: 100 description: | Up to 100 products sold at this location All strings must be non-empty when trimmed of whitespace. services: type: array items: type: string maxLength: 100 description: | Up to 100 services offered at this location All strings must be non-empty when trimmed of whitespace. brands: type: array items: type: string maxLength: 100 description: | Up to 100 brands sold by this location All strings must be non-empty when trimmed of whitespace. language: type: string maxLength: 10 description: | 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: type: array items: type: string maxLength: 100 description: | Up to 100 languages spoken at this location. All strings must be non-empty when trimmed of whitespace. keywords: type: array items: type: string maxLength: 100 description: | Up to 100 keywords may be provided All strings must be non-empty when trimmed of whitespace. menusLabel: type: string description: Label to be used for this location’s Menus. This label will appear on your location's listings. menuIds: type: array items: type: string description: IDs of Menus associated with this location. bioListsLabel: type: string description: Label to be used for this location’s Bio lists. This label will appear on your location's listings. bioListIds: type: array items: type: string description: IDs of Bio lists associated with this location. productListsLabel: type: string description: Label to be used for this location’s Product & Services lists. This label will appear on your location's listings. productListIds: type: array items: type: string description: IDs of Product lists associated with this location. eventListsLabel: type: string description: Label to be used for this location’s Event lists. This label will appear on your location's listings. eventListIds: type: array items: type: string description: IDs of Event lists associated with this location. folderId: type: string description: The folder that this location is in. Must be a valid, existing Yext Folder ID labelIds: type: array items: type: string description: | The IDs of the location labels that have been added to this location. Location labels help you identify locations that share a certain characteristic; they do not appear on your location's listings. **NOTE:** You can only add labels that have already been created via our web interface. Currently, it is not possible to create new labels via the API. In Locations: Update requests: * If the **`v`** parameter is before `20180223`: setting the value of **`labelIds`** to an empty array has no effect on the current value * If the **`v`** parameter is `20180223` or after: setting the value of **`labelIds`** to an empty array deletes the current value customFields: type: object additionalProperties: type: object description: | A set of key-value pairs indicating the location's custom fields and their values. The keys are the **`ids`** of the custom fields, and the values are the fields' contents for this location. To retrieve a list of custom fields for your account, use the Custom Fields: List endpoint. If a field's **`type`** is `SINGLE_OPTION` or `MULTI_OPTION`, the option or options that apply to this location must be represented by their **`key`**s. Examples of each type of custom field: * BOOLEAN: * `{ "9662": "true" }` * DAILY_TIMES: * `{ "10012": { "dailyTimes": "2:7:00,3:7:00,4:7:00,5:7:00,6:7:00,7:7:00,1:7:00" } }` * DATE: * `{ "7066": "2016-10-12" }` * GALLERY: * `{ "7070": [ { "url": "http://a.mktgcdn.com/p/ounkg7aq6Oy029-sRf4CIH64/128x128.jpg" }, { "url": "http://a.mktgcdn.com/p/YkQGqxK8jFBqOlailQ9QIBsgs/1.0000/316x316.png" } ] }` * HOURS: * `{ "10011": { "hours": "1:7:00:20:00,2:7:00:20:00,3:7:00:20:00,4:7:00:20:00,5:7:00:20:00,6:7:00:20:00,7:7:00:20:00", "additionalHoursText": "Also by appointment" }` * LOCATION_LIST: * `{ "8098" : [ "locationId1", "locationId2" ] }` * MULTILINE_TEXT (up to 4,000 characters): * `{ "1592": "Take Route 13 south. Pass Riverrun Reservoir. At the traffic light before the post office, turn right off of Route 13. Pass the library and community center on your right and then pass a diner on your left. Cross over the bridge and at the third intersection, turn left onto Jones Street. We are located on the right side in the middle of the block." }` * MULTI_OPTION: * `{ "7068": ["2614", "2615"] }` (`"2614"` and `"2615"` are the options' **`key`**s) * NUMBER: * `{ "7078": "123" }` * PHOTO: * `{ "7071": { "url": "http://a.mktgcdn.com/p/bRtQXQZP2kEzgy2C8/800x800.jpg", "description": "New storefront", "details": "A picture of the new storefront" } }` * `{ "7071": null }` (This setting will clear the existing value of the Photo custom field.) * SINGLE_OPTION: * `{ "7069": "2617" }` (`"2617"` is the option's **`key`**) * TEXT (up to 255 characters): * `{ "6157": "Buy One, Get One 50% Off" }` * TEXT_LIST: * `{ "7072": [ "Item 1", "Item 2", "Item 3" ] }` * URL: * `{ "9381": "http://www.location.example.com" }` * VIDEO: * `{ "7077": { "url": "http://www.youtube.com/watch?v=6KQPho" } }` * VIDEO_GALLERY: * `{ "8452": [ { "url": "http://www.youtube.com/watch?v=B1EC1U" }, { "url": "http://www.youtube.com/watch?v=SkEtnN" } ] }` intelligentSearchTrackingEnabled: type: boolean description: | Indicates whether Intelligent Search Tracker is enabled. The Intelligent Search Tracker allows you to understand your performance in local search. intelligentSearchTrackingFrequency: type: string enum: - WEEKLY - MONTHLY - QUARTERLY description: | How often we send search queries to track your search performance. locationKeywords: type: array items: type: string enum: - NAME - PRIMARY_CATEGORY description: | 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: type: array items: type: string description: | Additional keywords you would like us to use when tracking your search performance queryTemplates: type: array items: type: string enum: - KEYWORD - KEYWORD_ZIP - KEYWORD_CITY - KEYWORD_IN_CITY - KEYWORD_NEAR_ME - KEYWORD_CITY_STATE description: | The ways in which your keywords will be arranged in the search queries we use to track your performance alternateNames: type: array items: type: string description: | Other names for your business that you would like us to use when tracking your search performance alternateWebsites: type: array items: type: string description: | Other websites for your business that we should look for when tracking your search performance competitors: type: array items: type: object properties: name: type: string description: The competitor's name website: type: string description: The competitor's website. description: | The names and websites of the competitors whose search performance you would like to compare to your own trackingSites: type: array items: type: string enum: - GOOGLE_DESKTOP - GOOGLE_MOBILE - BING_DESKTOP - BING_MOBILE - YAHOO_DESKTOP - YAHOO_MOBILE description: | The search engines that we will use to track your performance isoRegionCode: type: string readOnly: true description: | The ISO 3166-2 region code for the location. Yext will determine the location’s code and update isoRegionCode with that value. If Yext is unable to determine the code for the location, the location’s ISO 3166-1 alpha-2 country code will be used. reviewBalancingURL: type: string maxLength: 255 readOnly: true description: | Link to the balancing URL that will auto-direct consumers to certain sites to leave reviews, based on review-generation settings firstPartyReviewPage: type: string maxLength: 255 readOnly: true description: | Link to the review-collection page, where consumers can leave first-party reviews isClusterPrimary: type: boolean description: | Indicates whether the location is the primary location in its group schemaTypes: type: array readOnly: true items: type: string description: | List of Schema Types for this location, based on its categories attire: type: string enum: - UNSPECIFIED - DRESSY - CASUAL - FORMAL description: | The formality of clothing typically worn at this location **NOTE:** This field is only available to locations whose **`locationType`** is `RESTAURANT`. priceRange: type: string enum: - UNSPECIFIED - ONE - TWO - THREE - FOUR description: | The typical price of products sold at this location, on a scale of 1 (low) to 4 (high) **NOTE:** This field is only available to locations whose **`locationType`** is `RESTAURANT`. mealsServed: type: array items: type: string description: | Types of meals served at this location **NOTE:** This field is only available to locations whose **`locationType`** is `RESTAURANT`. Valid values: * `BREAKFAST` * `LUNCH` * `BRUNCH` * `HAPPY_HOUR` * `LATE_NIGHT` locatedIn: type: string description: | For ATMs, the external ID of the location that the ATM is installed in. The location must be in the same business account as the ATM. **NOTE:** This field is only available to locations whose **`locationType`** is `ATM`. primaryContact: type: string description: | ID of the user who is the primary Knowledge Assistant contact for the entity reviewResponseConversationEnabled: type: boolean description: | Indicates whether or not review response conversations are enabled for the Yext Knowledge Assistant holidayHoursConfirmationEnabled: type: boolean description: | Indicates whether or not holiday hour confirmation alerts are enabled for the Yext Knowledge Assistant LocationSchema: type: object properties: '@context': type: string '@type': type: string '@id': type: string Name: type: string Image: type: string Geo: type: object properties: '@type': type: string Latitude: type: number format: double Longitude: type: number format: double Address: type: object properties: '@type': type: string StreetAddress: type: string AddressLocality: type: string PostalCode: type: string AddressCountry: type: string Telephone: type: string OpeningHoursSpecification: type: array items: type: object properties: '@type': type: string DayOfWeek: type: array items: type: string Opens: type: string Closes: type: string Geo: type: object description: If location provided in geosearch cannot be geocoded, this field will be set to null. properties: latitude: type: string description: Latitude as returned by geocoder. If no value, returns "" longitude: type: string description: Longitude as returned by geocoder. If no value, returns "" address: type: string description: Address field as returned by geocoder. If no value, returns "" address2: type: string description: Address2 field as returned by geocoder. If no value, returns "" locality: type: string description: Locality (city) field as returned by geocoder. If no value, returns "" region: type: string description: Region (state) field as returned by geocoder. If no value, returns "" postalCode: type: string description: PostalCode (ZIP) field as returned by geocoder. If no value, returns "" country: type: string description: Country field as returned by geocoder. If no value, returns "" granularity: type: string enum: - POINT - ADDRESS - STREET - SUBLOCALITY - LOCALITY - POSTALCODE - REGION - COUNTRY - UNKNOWN required: - latitude - longitude - address - address2 - locality - region - postalCode - country - granularity LocationDistance: type: object properties: id: type: string description: External location ID distanceMiles: type: number description: Distance in miles between the Location and the location specified in the Geo object. distanceKilometers: type: number description: Distance in kilometers between the Location and the location specified in the Geo object. QuestionRequest: type: object required: - entityId - name - email - questionText - questionLanguage properties: entityId: type: string description: ID of the entity associated to this question. site: type: string description: Site on which to create this question. name: type: string description: The name of the author of the question. email: type: string description: The email of the author of the question. questionText: type: string description: The question that is being asked. questionDescription: type: string description: Additional details for this question. questionLanguage: type: string description: The language code of the language that the question is being asked in. CreateReview: type: object required: - entity - authorName - authorEmail - rating properties: entity: type: object properties: id: type: string description: ID of the entity associated with this review. authorName: type: string description: The name of the person who wrote the review. authorEmail: type: string description: The email address of the person who wrote the review. title: type: string description: The title of the review. rating: type: number format: double description: Normalized rating out of 5. content: type: string description: The content of the review. status: type: string enum: - LIVE - QUARANTINED - REMOVED description: | The status of the review. Defaults to `QUARANTINED` when creating. reviewLabelNames: type: array items: type: string description: | The names of the Review Labels which will be attached to the resulting review. This is an _upsert_ operation, meaning the system will determine if a Review Label exists already in your account, and create and append a new label if not. reviewDate: type: string format: date description: | If the v parameter is before 20240515: (YYYY-MM-DD format) If provided, the date you received the review from the customer. Defaults to the date the review was uploaded to Yext. Time defaults to midnight ET. If the v parameter is 20240515 or later: ISO-8601 format (YYYY-MM-DDThh:mm:ssTZD) if provided, the date you received the review from the customer. Date defaults to the date the review was uploaded to Yext. Time defaults to midnight and timezone defaults to UTC. Examples: 2024-05-15, 2024-05-15T04:44:50, 2024-05-15T04:44:50-05:00 invitationUid: type: string description: The ID of the invitation which should be associated with this review. url: type: string description: | The URL of the review, or the URL of the listing where the review can be found if there is no specific URL for the review. publisherId: type: string description: | The ID of the publisher associated with the review. Defaults to `FIRSTPARTY`. externalId: type: string description: | The External ID of the review, typically assigned by the Publisher. Created External IDs must be unique per account and publisher pair. UpdateReview: type: object properties: entity: type: object properties: id: type: string description: ID of the entity associated with this review. authorName: type: string description: The name of the person who wrote the review. authorEmail: type: string description: The email address of the person who wrote the review. title: type: string description: The title of the review. rating: type: number format: double description: Normalized rating out of 5. content: type: string description: The content of the review. status: type: string enum: - LIVE - QUARANTINED - REMOVED description: | The status of the review. Defaults to `QUARANTINED` when creating. reviewLabelNames: type: array items: type: string description: | The names of the Review Labels which will be attached to the resulting review. This is an _upsert_ operation, meaning the system will determine if a Review Label exists already in your account, and create and append a new label if not. reviewDate: type: string format: date description: | If provided, the date you received the review from the customer. Defaults to the date the review was uploaded to Yext. (`YYYY-MM-DD` format) url: type: string description: | The URL of the review, or the URL of the listing where the review can be found if there is no specific URL for the review. externalId: type: string description: | The External ID of the review, typically assigned by the Publisher. Created External IDs must be unique per account and publisher pair. NextPageToken: type: string description: | This field is only included if there is an additional page of data to display. To retrieve the next page of data, pass this field's value as the **``pageToken``** parameter in a subsequent request. responses: ErrorResponse: description: Error Response content: application/json: schema: title: ErrorResponse type: object properties: meta: $ref: '#/components/schemas/ResponseMetaWithError' response: type: object EntitySchemaResponse: description: Entity Schema Response. content: application/json: schema: title: EntitySchemaResponse type: object properties: meta: $ref: '#/components/schemas/ResponseMeta' response: $ref: '#/components/schemas/EntitySchema' MenuResponse: description: Menu Response. content: application/json: schema: title: MenuListResponse type: object properties: meta: $ref: '#/components/schemas/ResponseMeta' response: $ref: '#/components/schemas/Menu' BioResponse: description: Bio List Response. content: application/json: schema: title: BioListResponse type: object properties: meta: $ref: '#/components/schemas/ResponseMeta' response: $ref: '#/components/schemas/Bio' ProductResponse: description: Product List Response. content: application/json: schema: title: ProductListResponse type: object properties: meta: $ref: '#/components/schemas/ResponseMeta' response: $ref: '#/components/schemas/Product' EventResponse: description: Event List Response. content: application/json: schema: title: EventListResponse type: object properties: meta: $ref: '#/components/schemas/ResponseMeta' response: $ref: '#/components/schemas/Event' LanguageProfileResponse: description: Language Profile Response. content: application/json: schema: title: LanguageProfileResponse type: object properties: meta: $ref: '#/components/schemas/ResponseMeta' response: $ref: '#/components/schemas/Location' LanguageProfilesResponse: description: Language Profiles Response. content: application/json: schema: title: LanguageProfilesResponse type: object properties: meta: $ref: '#/components/schemas/ResponseMeta' response: type: object properties: languageProfiles: type: array items: $ref: '#/components/schemas/Location' LanguageProfileSchemaResponse: description: Language Profile Schema Response. content: application/json: schema: title: LanguageProfileSchemaResponse type: object properties: meta: $ref: '#/components/schemas/ResponseMeta' response: $ref: '#/components/schemas/LocationSchema' LocationResponse: description: Location Response. content: application/json: schema: title: LocationResponse type: object properties: meta: $ref: '#/components/schemas/ResponseMeta' response: $ref: '#/components/schemas/Location' LocationsResponse: description: Locations Response. content: application/json: schema: title: LocationsResponse type: object properties: meta: $ref: '#/components/schemas/ResponseMeta' response: type: object properties: count: type: integer description: Total number of Locations (up to 10,000) that meet filter criteria (ignores limit / offset). locations: type: array items: $ref: '#/components/schemas/Location' LocationSchemaResponse: description: Location Schema Response. content: application/json: schema: title: LocationSchemaResponse type: object properties: meta: $ref: '#/components/schemas/ResponseMeta' response: $ref: '#/components/schemas/LocationSchema' GeoSearchResponse: description: Geo Search Response content: application/json: schema: title: GeoSearchResponse type: object properties: meta: $ref: '#/components/schemas/ResponseMeta' response: type: object properties: count: type: integer description: | Total number of Locations (up to 10,000) that meet filter criteria (ignores **`limit`** / **`offset`** parameters) geo: $ref: '#/components/schemas/Geo' locationDistances: type: array items: $ref: '#/components/schemas/LocationDistance' locations: type: array items: $ref: '#/components/schemas/Location' EmptyResponse: description: Empty Response. content: application/json: schema: title: EmptyResponse type: object properties: meta: $ref: '#/components/schemas/ResponseMeta' response: type: object ReviewsResponse: description: Reviews Response content: application/json: schema: title: ReviewsResponse type: object properties: meta: $ref: '#/components/schemas/ResponseMeta' response: type: object properties: apiIdentifier: type: string description: | The unique identifier which will need to be included in any further requests to update or delete this review. One of: * A UUID generated at the time the Review Creation request is accepted. * The invitationUid, if the review is associated with an invitation. StreamsResponse: description: Content Response content: application/json: schema: title: ContentResponse type: object properties: meta: $ref: '#/components/schemas/ResponseMeta' response: type: object required: - count properties: count: type: integer description: | Total number of documents that meet the filter criteria. docs: type: array description: Documents containing the data for the relevant Content Endpoint and request. items: type: object nextPageToken: $ref: '#/components/schemas/NextPageToken' requestBodies: createQuestionRequest: content: application/json: schema: $ref: '#/components/schemas/QuestionRequest' security: - api_key: [] - api-key: [] tags: - name: Live API - name: Content API