openapi: 3.0.0 info: title: Yext Admin Account Settings Knowledge Manager API version: '2.0' servers: - url: https://api.yextapis.com/v2 security: - api_key: [] - api-key: [] tags: - name: Knowledge Manager 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.\n - `false`: **Markdown** fields will be returned as JSON\n - `true`: **Markdown** fields will be returned as HTML\n" name: convertMarkdownToHTML in: query required: false - schema: minLength: 0 type: string description: "Optional parameter to return fields of type **Rich Text** as HTML.\n - `false`: **Rich Text** fields will be returned as JSON\n - `true`: **Rich Text** fields will be returned as HTML\n" name: convertRichTextToHTML in: query required: false - schema: minLength: 0 type: string description: "Comma-separated list of Entity types to filter on. Example: `\"location,event\"`\n\nShould be from the following types:\n * `atm`\n * `event`\n * `faq`\n * `financialProfessional`\n * `healthcareFacility`\n * `healthcareProfessional`\n * `hotel`\n * `hotelRoomType`\n * `job`\n * `location`\n * `organization`\n * `product`\n * `restaurant`\n\nOR the API name of a custom entity type.\n" 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.\n\nFor 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`\n\n**Basic Filter Structure**\n\nThe filter object at its core consists of a *matcher*, a *field*, and an *argument*.\n\nFor example, in the following filter JSON:\n\n```\n{\n \"name\":{\n \"$eq\":\"John\"\n }\n}\n```\n\n`$eq` is the *matcher*, or filtering operation (equals, in this example),\n\n`name` is the *field* being filtered by, and\n\n`John` is *value* to be matched against.\n\n**Combining Multiple Filters**\n\nMultiple 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.\n```\n{\n \"$and\":[\n {\n \"firstName\":{\n \"$eq\":\"John\"\n }\n },\n {\n \"countryCode\":{\n \"$in\":[\n \"US\",\n \"GB\"\n ]\n }\n }\n ]\n}\n```\n\n**Filter Negation**\n\nCertain filter types may be negated. For example:\n\n```\n{\n \"$not\": {\n \"name\": {\n \"$eq\": \"John\"\n }\n }\n}\n```\n\nThis can also be written more simply with a `!` in the `$eq` parameter. The following filter would have the same effect:\n\n```\n{\n \"name\":{\n \"!$eq\":\"John\"\n }\n}\n```\n\n**Filter Complement**\n\nYou 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.\n\n```\n{\n \"$complement\":{\n \"description\":{\n \"$contains\":\"hello\"\n }\n }\n}\n```\n\n**Addressing Subfields**\n\nSubfields of fields can be addressed using the \"dot\" notation while filtering. For example, if you have a custom field called **`c_myCustomField`**:\n\n```\n{\n \"c_myCustomField\":{\n \"age\": 30,\n \"name\": \"Jim\",\n }\n}\n```\n\nWhile filtering, subfields may be addressed using the \"dot\" notation.\n\n```\n{\n \"c_myCustomField.name\":{\n \"!$eq\":\"John\"\n }\n}\n```\n\nFields 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`**.\n\n**Field Support**\n\nEntity 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).\n\n**TEXT**\n\nThe `TEXT` filter type is supported for text fields. (e.g., **`name`**, **`countryCode`**)\n\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
MatcherDetails
$eq (equals)\n\n {\n \"countryCode\":{\n \"$eq\":\"US\"\n }\n },\n {\n \"countryCode\":{\n \"!$eq\":\"US\"\n }\n }\n\n Supports negation. Case insensitive.\n
$startsWith\n\n Matches if the field starts with the argument value.\n\n e.g., \"Amazing\" starts with \"amaz\"\n\n {\n \"address.line1\":{\n \"$startsWith\": \"Jo\"\n }\n }\n\n Supports negation. Case insensitive.\n
$in\n\n Matches if field value is a member of the argument list.\n\n {\n \"firstName\":{\n \"$in\": [\"John\", \"Jimmy\"]\n }\n }\n\n Does not support negation. Negation can be mimicked by using an \"OR\" matcher, for example:\n\n {\n \"$and\":[\n {\n \"firstName\":{\n \"!$eq\": \"John\"\n }\n },\n {\n \"firstName\":{\n \"!$eq\": \"Jimmy\"\n }\n }\n ]\n }\n\n
$contains\n\n {\n \"c_myString\":{\n \"$contains\":\"sample\"\n }\n }\n\n This filter will match if \"sample\" is contained in any string within **`c_myString`**.\n\n 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\".\n\n Supports negation.\n
$containsAny\n\n {\n \"c_myString\":{\n \"$containsAny\":[\n \"sample1\", \"sample2\"\n ]\n }\n }\n\n 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.\n\n 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\".\n\n Supports negation.\n
$containsAll\n\n {\n \"c_myString\":{\n \"$containsAll\":[\n \"sample1\",\n \"sample2\"\n ]\n }\n }\n\n 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.\n\n 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\".\n\n Supports negation.\n
\n\n**BOOLEAN**\n\n\nThe BOOLEAN filter type is supported for boolean fields and Yes / No custom fields.\n\n \n \n \n \n \n \n \n
MatcherDetails
$eq\n\n {\n \"isFreeEvent\": {\n \"$eq\": true\n }\n }\n\n For booleans, the filter takes a boolean value, not a string.\n Supports negation.\n
\n\n**STRUCT**\n\nThe STRUCT filter type is supported for compound fields with subfields.\n\n*e.g., **`address`**, **`featuredMessage`**, fields of custom types*\n\n\n \n \n \n \n \n \n \n
MatcherDetails
$hasProperty\n\n 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.\n\n {\n \"address\": {\n \"$hasProperty\": \"line1\"\n }\n }\n\n 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.\n\n Supports negation.\n\n
\n\n**OPTION**\n\nThe OPTION filter type is supported for options custom fields and fields that have a predetermined list of valid values.\n\n *e.g., **`eventStatus`**, **`gender`**, `SINGLE_OPTION` and `MULTI_OPTION` types of custom fields.*\n\n\n \n \n \n \n \n \n \n \n \n \n
MatcherDetails
$eq\n\n Matching is case insensitive and insensitive to consecutive whitespace.\n\n e.g., \"XYZ 123\" matches \"xyz 123\"\n\n {\n \"eventStatus\": {\n \"$eq\": \"SCHEDULED\"\n }\n }\n\n Supports negation. Negating `$eq` on the list will match any field that does not hold any of the provided values.\n\n
$in\n\n {\n \"eventStatus\": {\n \"$in\": [\n \"SCHEDULED\",\n \"POSTPONED\"\n ]\n }\n }\n\n Does not support negation. However, negation can be mimicked by using an `$and` matcher to negate individually over the desired values. For example:\n\n {\n \"$and\": [\n {\n \"eventStatus\":{\n \"!$eq\": \"SCHEDULED\"\n }\n },\n {\n \"firstName\":{\n \"!$eq\": \"POSTPONED\"\n }\n }\n ]\n }\n\n
\n\n**PHONE**\n\nThe 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.\n\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n
MatcherDetails
$eq\n\n {\n \"mainPhone\":{\n \"$eq\":\"+18187076189\"\n }\n },\n {\n \"mainPhone\":{\n \"$eq\":\"8187076189\"\n }\n },\n {\n \"mainPhone\":{\n \"!$eq\":\"9177076189\"\n }\n }\n\n Supports negation. Case insensitive.\n\n
$startsWith\n\n Matches if the field starts with the argument value.\n\n e.g., \"8187076189\" starts with \"818\"\n\n {\n \"mainPhone\":{\n \"$startsWith\": \"818\"\n }\n }\n\n Supports negation. Case insensitive.\n\n
$in\n\n Matches if field value is a member of the argument list.\n\n {\n \"mainPhone\":{\n \"$in\": [\n \"8185551616\",\n \"9171112211\"\n ]\n }\n }\n\n Does not support negation. However, negation can be mimicked by using an `$and` matcher to negate individually over the desired values.\n\n
\n\n**INTEGER, FLOAT, DATE, DATETIME, and TIME**\n\nThese filter types are strictly ordered -- therefore, they support the following matchers:\n- Equals\n- Less Than / Less Than or Equal To\n- Greater Than / Greater Than or Equal To\n\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
MatcherDetails
$eq\n\n Equals\n\n {\n \"ageRange.maxValue\": {\n \"$eq\": \"80\"\n }\n }\n\n Supports negation.\n\n
$lt\n\n Less than\n\n {\n \"time.start\": {\n \"$lt\": \"2018-08-28T05:56\"\n }\n }\n\n
$gt\n\n Greater than\n\n {\n \"ageRange.maxValue\": {\n \"$gt\": \"50\"\n }\n }\n\n
$le\n\n Less than or equal to\n\n {\n \"ageRange.maxValue\": {\n \"$le\": \"40\"\n }\n }\n\n
$ge\n\n Greater than or equal to\n\n {\n \"time.end\": {\n \"$ge\": \"2018-08-28T05:56\"\n }\n }\n\n
Combinations\n\n 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:\n\n {\n \"ageRange.maxValue : {\n \"$gt\" : 10,\n \"$lt\": 20\n }\n }\n\n
\n\n**LIST OF TEXT**\n\nAny field that has a list of valid values and supports any of the previously mentioned filter types will also support the `$contains` matcher.\n\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
MatcherDetails
$eq\n\n {\n \"c_myStringList\": {\n \"$eq\": \"sample\"\n }\n }\n\n This filter will match if \"sample\" EXACTLY matches any string within **`c_myStringList`**.\n\n Supports negation.\n\n
$eqAny\n\n {\n \"c_myStringList\": {\n \"$eqAny\": [\n \"sample1\",\n \"sample2\"\n ]\n }\n }\n\n 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.\n\n Supports negation.\n\n
$eqAll\n\n {\n \"c_myStringList\": {\n \"$eqAll\": [\n \"sample1\",\n \"sample2\"\n ]\n }\n }\n\n This filter will match if both \"sample1\" AND \"sample2\" EXACTLY match a string within **`c_myStringList`**. The argument can have more than two strings.\n\n Supports negation.\n\n
$contains\n\n {\n \"c_myStringList\":{\n \"$contains\":\"sample\"\n }\n }\n\n This filter will match if \"sample\" is contained in any string within **`c_myStringList`**.\n\n 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\".\n\n Supports negation.\n\n
$containsAny\n\n {\n \"c_myStringList\": {\n \"$containsAny\": [\n \"sample1\",\n \"sample2\"\n ]\n }\n }\n\n\n 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.\n\n 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\".\n\n Supports negation.\n\n
$containsAll\n\n {\n \"c_myStringList\": {\n \"$containsAll\": [\n \"sample1\",\n \"sample2\"\n ]\n }\n }\n\n 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.\n\n 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\".\n\n Supports negation.\n\n
$startsWith\n\n {\n \"c_myStringList\": {\n \"$startsWith\":\"sample\"\n }\n }\n\n This filter will match if any string within **`c_myStringList`** starts with \"sample\".\n\n Does not supports negation. Case Insensitive.\n\n
\n\n**LIST OF BOOLEAN, OPTION, PHONE, INTEGER, FLOAT, DATE, DATETIME, OR TIME**\n\n\n \n \n \n \n \n \n \n \n \n \n\n \n \n \n
MatcherDetails
$eq\n\n {\n \"c_myDateList\": {\n \"$eq\": \"2019-01-01\"\n }\n }\n\n\n This filter will match if \"2019-01-01\" EXACTLY matches any date within **`c_myDateList`**.\n\n Supports negation.\n\n
$eqAny\n\n {\n \"c_myIntegerList\": {\n \"$eqAny\": [1, 2]\n }\n }\n\n This filter will match if 1 or 2 EXACTLY match any integer within **`c_myIntegerList`**. The argument list can have more than two elements.\n\n Supports negation.\n\n
$eqAll\n\n {\n \"c_myStringList\": {\n \"$eqAll\": [\n \"sample1\",\n \"sample2\"\n ]\n }\n }\n\n 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.\n\n Supports negation.\n\n
\n\n**LIST OF STRUCT**\n\nFiltering on lists of struct types is a bit nuanced. Filtering can only be done on lists of structs of the SAME type.\nFor 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:\n\n```\n{\n \"c_myStructList.age\":{\n \"$eq\": 20\n }\n}\n```\n\nwill 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`).\n\n\n**HOURS**\n\nBy 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.\n\n\n \n \n \n \n \n \n \n \n \n \n\n \n \n \n \n \n \n \n \n \n \n \n \n
MatcherDetails
$openAt\n\n {\n \"hours\": {\n \"$openAt\":\n \"2019-01-06T13:45\"\n }\n }\n\n\n This filter would match entities open at the specified time.\n\n
$closedAt\n\n {\n \"hours\": {\n \"$closedAt:\n \"2019-01-06T13:45\"\n }\n }\n\n
$openForAllOf\n\n {\n \"hours\": {\n \"$openForAllOf\": {\n \"start\":\n \"2019-01-06T13:45\",\n \"end\":\n \"2019-01-06T15:00\"\n }\n }\n }\n\n\n This filter would match only those entities that are open for the entire range between 2019-01-06T13:45 and 2019-01-06T15:00.\n\n {\n \"hours\": {\n \"$openForAllOf\":\n \"2019-05-10\"\n }\n }\n\n This filter would match entities open for the entire 24 hour period on 2019-05-10.\n\n You can also supply a year, a month, or an hour to filter for entities open for the entire year, month, or hour, respectively.\n\n
$openForAnyOf\n\n {\n \"hours\": {\n \"$openForAnyOf\": {\n \"start\": \"now\",\n \"end\": \"now+2h\"\n }\n }\n }\n\n 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.\n\n
$closedForAllOf\n\n {\n \"hours\": {\n \"$closedForAllOf\": {\n \"start\":\n \"2019-01-06T13:45\",\n \"end\":\n \"2019-01-06T15:00\"\n }\n }\n }\n\n This filter will match only those entities that are closed for the entire given time range.\n
$closedForAnyOf\n\n {\n \"hours\": {\n \"$closedForAnyOf\": {\n \"start\":\n \"2019-01-06T13:45\",\n \"end\":\n \"2019-01-06T15:00\"\n }\n }\n }\n\n This filter will match any entities that are closed for at least a portion of the given time range.\n
\n\n\n**Filtering by Dates and Times**\n\n**Time zones**\n\nThe 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.\n\nTo search in local time, simply provide the date or time without any zone: `2019-06-07T15:30` or `2019-06-07`.\n\nTo 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]`.\n\n\n**Date and time types**\n\nIn addition to searching with dates and datetimes, you can also query with years, months, and hours. For example, the filter:\n\n```\n{\n \"time.start\": {\n \"$eq\": \"2018\"\n }\n}\n```\n\nwould 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`).\n\nThese types also work with ordered searches. For example:\n\n```\n{\n \"time.start\": {\n \"$lt\": \"2018\"\n }\n}\n```\n\nwould 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.\n\n**\"Now\" and Date Math**\n\nInstead 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.\n\nIn 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`).\n\nIt 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`.\n\nYou 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.\n\n**Filtering Across an Entity**\n\nIt is possible to search for a specific text string across all fields of an entity by using the `$anywhere` matcher.\n\n\n \n \n \n \n \n \n \n
MatcherDetails
$anywhere\n\n Matches if the argument text appears anywhere in the entity (including subfields, structs, and lists)\n\n {\n \"$anywhere\": \"hello\"\n }\n\n This filter will match all entities that contain the string \"hello\" or strings that begin with \"hello\".\n\n
\n\n**Examples**\n\nThe following filter will match against entities that:\n- Are of type `event` (note that entity types can also be filtered by the **`entityTypes`** query parameter)\n- Have a name that starts with the text \"Century\"\n- Have a maximum age between 10 and 20\n- Have a minimum age between 5 and 7\n- Start after 7 PM (19:00) on August 28, 2018\n\n```\n{\n \"$and\":[\n {\n \"entityType\":{\n \"$eq\":\"event\"\n }\n },\n {\n \"name\":{\n \"$startsWith\":\"Century\"\n }\n },\n {\n \"ageRange.maxValue\":{\n \"$gt\":10,\n \"$lt\":20\n }\n },\n {\n \"ageRange.minValue\":{\n \"$gt\":5,\n \"$lt\":7\n }\n },\n {\n \"time.start\":{\n \"$ge\":\"2018-08-28T19:00\"\n }\n }\n ]\n}\n```\n" 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**.\"\n\nValid values:\n * `markdown`\n * `html`\n * `none`\n" 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: type: boolean default: 'false' description: "Optional parameter to resolve all embedded fields in a Location object response.\n - `false`: Location object returns placeholder labels, e.g., \"Your [[CITY]] store\"\n - `true`: Location object returns placeholder values, e.g., \"Your Fairfax store\"\n" name: resolvePlaceholders 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: - Knowledge Manager summary: 'Entities: List' description: 'Retrieve a list of Entities within an account **NOTE** * If the **`v`** parameter is `20240221` or later: returned entities replace the **`categoryIds`** field with the **`categories`** field. ' 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.\n\n```\nEligible For: \n * atm\n * event\n * faq\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * job\n * location\n * restaurant\n```" name: minLength: 0 maxLength: 5000 type: string description: "\n\n\nCannot Include:\n* HTML markup\n\nFiltering Type: `text`\n\n```\nEligible For: \n * atm\n * board\n * brand\n * card\n * contactCard\n * event\n * faq\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * helpArticle\n * hotel\n * hotelRoomType\n * job\n * location\n * organization\n * product\n * restaurant\n```" 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)\n\nMust be a valid address\nCannot be a P.O. Box\n\nIf the entity is an `event`, either an **`address`** value or a **`linkedLocation`** value can be provided.\n\nFiltering Type: `object`\n\n```\nEligible For: \n * atm\n * event\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * restaurant\n```" acceptingNewPatients: type: boolean description: "Indicates whether the healthcare provider is accepting new patients.\n\nFiltering Type: `boolean`\n\n```\nEligible For: \n * healthcareFacility\n * healthcareProfessional\n```" acceptsReservations: type: boolean description: "Indicates whether the entity accepts reservations.\n\nFiltering Type: `boolean`\n\n```\nEligible For: \n * restaurant\n```" 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.\n\nEach 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.\nSimilarly, holiday access hours are represented by the `holidayHours` sub-field.\nSetting the `reopenDate` sub-field indicates that the business is temporarily closed and will reopen on the specified date.\nSPECIAL CASES:\n* 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.\n* 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.\n* If you are providing `openIntervals`, you may not set `isClosed` to true for that day.\n\nFiltering Type: `hours`\n\n```\nEligible For: \n * atm\n * healthcareFacility\n * hotel\n * location\n * restaurant\n```" additionalHoursText: minLength: 0 maxLength: 255 type: string description: "Additional information about hours that does not fit in **`hours`** (e.g., `\"Closed during the winter\"`)\n\nFiltering Type: `text`\n\n```\nEligible For: \n * atm\n * contactCard\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * restaurant\n```" additionalPromotingLocations: description: "If other locations are promoting this event, a list of those locations' **`id`**s in the Yext Knowledge Manager\n\n\nArray must be ordered.\n\n\nFiltering Type: `list of entityId`\n\n```\nEligible For: \n * event\n```" 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`.\n\nFiltering Type: `boolean`\n\n```\nEligible For: \n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * restaurant\n```" admittingHospitals: description: "A list of hospitals where the healthcare professional admits patients\n\n\nArray must be ordered.\n\nArray may have a maximum of 100 elements.\n\nArray item description:\n\n>Cannot Include:\n>* HTML markup\n\nFiltering Type: `list of text`\n\n```\nEligible For: \n * healthcareProfessional\n```" 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.\n\nFiltering Type: `option`\n\n```\nEligible For: \n * hotel\n```" 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\n\nFiltering Type: `object`\n\n```\nEligible For: \n * event\n```" 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.\n\nFiltering Type: `option`\n\n```\nEligible For: \n * hotel\n```" 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.\n\nFiltering Type: `option`\n\n```\nEligible For: \n * hotel\n```" allInclusive: enum: - ALL_INCLUSIVE_RATES_AVAILABLE - ALL_INCLUSIVE_RATES_ONLY - NOT_APPLICABLE type: string description: "Indicates whether the entity offers all-inclusive rates.\n\nFiltering Type: `option`\n\n```\nEligible For: \n * hotel\n```" alternateNames: description: "Other names for your business that you would like us to use when tracking your search performance\n\n\nArray must be ordered.\n\nArray may have a maximum of 3 elements.\n\nArray item description:\n\n>Cannot Include:\n>* HTML markup\n\nFiltering Type: `list of text`\n\n```\nEligible For: \n * atm\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * organization\n * restaurant\n```" 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.\n\nIf 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.\n\nFiltering Type: `text`\n\n```\nEligible For: \n * atm\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * restaurant\n```" alternateWebsites: description: "Other websites for your business that we should search for when tracking your search performance\n\n\nArray must be ordered.\n\nArray may have a maximum of 3 elements.\n\nArray item description:\n\n>Cannot Include:\n>* common domain names, e.g., google.com, youtube.com, etc.\n\nFiltering Type: `list of text`\n\n```\nEligible For: \n * atm\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * organization\n * restaurant\n```" 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\n\nFiltering Type: `text`\n\n```\nEligible For: \n * brand\n * financialProfessional\n * hotel\n * location\n * restaurant\n```" answer: description: "The answer to the frequently asked question represented by this entity\n\n\nCharacter limit: 0 .. 15000\n\nSupported formats include:\n* BOLD\n* ITALICS\n* UNDERLINE\n* BULLETED_LIST\n* NUMBERED_LIST\n* HYPERLINK\n* IMAGE\n* CODE_SPAN\n* HEADINGS\n\n```\nEligible For: \n * faq\n```" type: string format: rich-text appleActionLinks: description: "Use this field to add action links to your Apple Listings.\n\nThe call to action category will be displayed on the action link button.\n\nThe App Store URL should contain a valid link to the landing page of an App in the Apple App Store.\n\nThe Quick Link URL is where a user is taken when an action link is clicked by a user.\n\nThe 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.\n\n\nArray must be ordered.\n\n\nFiltering Type: `list of object`\n\n```\nEligible For: \n * atm\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * restaurant\n```" 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\n\nFiltering Type: `text`\n\n```\nEligible For: \n * atm\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * restaurant\n```" appleBusinessId: minLength: 0 pattern: ^\d*\.?\d*$ type: string description: "The ID associated with an individual Business Folder in your Apple account\n\nFiltering Type: `text`\n\n```\nEligible For: \n * atm\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * restaurant\n```" appleCompanyId: minLength: 0 pattern: ^\d*\.?\d*$ type: string description: "The ID associated with your Apple account. Numerical values only\n\nFiltering Type: `text`\n\n```\nEligible For: \n * atm\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * restaurant\n```" appleCoverPhoto: required: - url additionalProperties: false type: object description: "The cover photo for the entity''s Apple profile\n\n\nImage must be at least 1600 x 1040 pixels\n\nImage may be no more than 4864 x 3163 pixels\n\nSupported Aspect Ratios:\n* 154 x 100\n\n**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.\n\n\nFiltering Type: `object`\n\n```\nEligible For: \n * atm\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * restaurant\n```" 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.\nNOTE: The names of Brands and their respective Locations within an Apple Business Connect Account must match identically.\nCannot Include:\nHTML markup \n\n\nCannot Include:\n* HTML markup\n\nFiltering Type: `text`\n\n```\nEligible For: \n * atm\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * restaurant\n```" applicationUrl: minLength: 0 format: uri type: string description: "The application URL\n\nFiltering Type: `text`\n\n```\nEligible For: \n * job\n```" associations: description: "Association memberships relevant to the entity (e.g., `\"New York Doctors Association\"`)\nAll strings must be non-empty when trimmed of whitespace.\n\n\n\nArray must be ordered.\n\nArray may have a maximum of 100 elements.\n\nArray item description:\n\n>Cannot Include:\n>* HTML markup\n\nFiltering Type: `list of text`\n\n```\nEligible For: \n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * restaurant\n```" 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.\nA `virtualLocationUrl` must be specified for online and mixed events.\n\nFiltering Type: `object`\n\n```\nEligible For: \n * event\n```" attire: enum: - UNSPECIFIED - DRESSY - CASUAL - FORMAL type: string description: "The formality of clothing typically worn at this restaurant\n\nFiltering Type: `option`\n\n```\nEligible For: \n * restaurant\n```" babysittingOffered: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: "Indicates whether the entity offers babysitting.\n\nFiltering Type: `option`\n\n```\nEligible For: \n * hotel\n```" baggageStorage: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: "Indicates whether the entity offers baggage storage pre check-in and post check-out.\n\nFiltering Type: `option`\n\n```\nEligible For: \n * hotel\n```" bar: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: "Indicates whether the entity has an indoor or outdoor bar onsite.\n\nFiltering Type: `option`\n\n```\nEligible For: \n * hotel\n```" beachAccess: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: "Indicates whether the entity has access to a beach.\n\nFiltering Type: `option`\n\n```\nEligible For: \n * hotel\n```" beachFrontProperty: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: "Indicates whether the entity is physically located next to a beach.\n\nFiltering Type: `option`\n\n```\nEligible For: \n * hotel\n```" bicycles: enum: - BICYCLE_RENTALS - BICYCLE_RENTALS_FOR_FREE - NOT_APPLICABLE type: string description: "Indicates whether the entity offers bicycles for rent or for free.\n\nFiltering Type: `option`\n\n```\nEligible For: \n * hotel\n```" 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\n\nFiltering Type: `object`\n\n```\nEligible For: \n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * organization\n * restaurant\n```" 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.\n\nFiltering Type: `option`\n\n```\nEligible For: \n * hotel\n```" brands: description: "Brands sold by this entity\nAll strings must be non-empty when trimmed of whitespace.\n\n\n\nArray must be ordered.\n\nArray may have a maximum of 100 elements.\n\nArray item description:\n\n>Cannot Include:\n>* HTML markup\n\nFiltering Type: `list of text`\n\n```\nEligible For: \n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * restaurant\n```" 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.\n\nFiltering Type: `option`\n\n```\nEligible For: \n * hotel\n```" 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.\n\nEach 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.\nSimilarly, holiday brunch hours are represented by the `holidayHours` sub-field.\nSetting the `reopenDate` sub-field indicates that the business is temporarily closed and will reopen on the specified date.\nSPECIAL CASES:\n* 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.\n* 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.\n* If you are providing `openIntervals`, you may not set `isClosed` to true for that day.\n\nFiltering Type: `hours`\n\n```\nEligible For: \n * hotel\n * location\n * restaurant\n```" businessCenter: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: "Indicates whether the entity has a business center.\n\nFiltering Type: `option`\n\n```\nEligible For: \n * hotel\n```" 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\n\nFiltering Type: `object`\n\n```\nEligible For: \n * financialProfessional\n * healthcareFacility\n * hotel\n * location\n * restaurant\n```" carRental: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: "Indicates whether the entity offers car rental.\n\nFiltering Type: `option`\n\n```\nEligible For: \n * hotel\n```" casino: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: "Indicates whether the entity has a casino on premise or nearby.\n\nFiltering Type: `option`\n\n```\nEligible For: \n * hotel\n```" categories: additionalProperties: false type: object properties: {} description: "Yext Categories. (Supported for versions > 20240220)\n\nA map of category list external IDs (i.e. \"yext\") to a list of category IDs.\n\nIDs must be valid and selectable (i.e., cannot be parent categories).\n\nPartial updates are accepted, meaning sending only the \"yext\" property will have no effect on any category list except the \"yext\" category. \n\nFiltering Type: `object`\n\n```\nEligible For: \n * atm\n * event\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * restaurant\n```" categoryIds: uniqueItems: false type: array items: minLength: 0 type: string description: 'Filtering Type: `text`' description: "Yext Category IDs. (Deprecated: For versions > 20240220)\n\nIDs must be valid and selectable (i.e., cannot be parent categories).\n\nNOTE: 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.\n\n\nFiltering Type: `list of text`\n\n```\nEligible For: \n * atm\n * event\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * restaurant\n```" catsAllowed: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: "Indicates if the entity is cat friendly.\n\nFiltering Type: `option`\n\n```\nEligible For: \n * hotel\n```" certifications: description: "A list of the certifications held by the healthcare professional\n**NOTE:** This field is only available to locations whose **`entityType`** is `healthcareProfessional`.\n\n\n\nArray must be ordered.\n\nArray may have a maximum of 100 elements.\n\nArray item description:\n\n>Cannot Include:\n>* HTML markup\n\nFiltering Type: `list of text`\n\n```\nEligible For: \n * financialProfessional\n * healthcareProfessional\n```" 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\n\nFiltering Type: `time`\n\n```\nEligible For: \n * hotel\n```" checkOutTime: format: time type: string description: "The check-out time\n\nFiltering Type: `time`\n\n```\nEligible For: \n * hotel\n```" classificationRating: pattern: ^\d*\.?\d*$ type: string description: "The 1 to 5 star rating of the entitiy based on its services and facilities.\n\nFiltering Type: `decimal`\n\n```\nEligible For: \n * hotel\n```" closed: type: boolean description: "Indicates whether the entity is closed\n\nFiltering Type: `boolean`\n\n```\nEligible For: \n * atm\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * restaurant\n```" concierge: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: "Indicates whether the entity offers concierge service.\n\nFiltering Type: `option`\n\n```\nEligible For: \n * hotel\n```" conditionsTreated: description: "A list of the conditions treated by the healthcare provider\n\n\nArray must be ordered.\n\nArray may have a maximum of 100 elements.\n\nArray item description:\n\n>Cannot Include:\n>* HTML markup\n\nFiltering Type: `list of text`\n\n```\nEligible For: \n * healthcareFacility\n * healthcareProfessional\n```" 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.\n\nFiltering Type: `option`\n\n```\nEligible For: \n * hotel\n```" covidMessaging: minLength: 0 maxLength: 15000 type: string description: "Information or messaging related to COVID-19.\n\nFiltering Type: `text`\n\n```\nEligible For: \n * healthcareFacility\n * healthcareProfessional\n * location\n```" covidTestAppointmentUrl: minLength: 0 format: uri type: string description: "An appointment URL for scheduling a COVID-19 test.\n\nFiltering Type: `text`\n\n```\nEligible For: \n * healthcareFacility\n * location\n```" covidTestingAppointmentRequired: type: boolean description: "Indicates whether an appointment is required for a COVID-19 test.\n\nFiltering Type: `boolean`\n\n```\nEligible For: \n * healthcareFacility\n * location\n```" covidTestingDriveThroughSite: type: boolean description: "Indicates whether location is a drive-through site for COVID-19 tests.\n\nFiltering Type: `boolean`\n\n```\nEligible For: \n * healthcareFacility\n * location\n```" covidTestingIsFree: type: boolean description: "Indicates whether location offers free COVID-19 testing.\n\nFiltering Type: `boolean`\n\n```\nEligible For: \n * healthcareFacility\n * location\n```" covidTestingPatientRestrictions: type: boolean description: "Indicates whether there are patient restrictions for COVID-19 testing.\n\nFiltering Type: `boolean`\n\n```\nEligible For: \n * healthcareFacility\n * location\n```" covidTestingReferralRequired: type: boolean description: "Indicates whether a referral is required for COVID-19 testing.\n\nFiltering Type: `boolean`\n\n```\nEligible For: \n * healthcareFacility\n * location\n```" covidTestingSiteInstructions: minLength: 0 maxLength: 15000 type: string description: "Information or instructions for the COVID-19 testing site.\n\nFiltering Type: `text`\n\n```\nEligible For: \n * healthcareFacility\n * location\n```" covidVaccineAppointmentRequired: type: boolean description: "Indicates whether an appointment is required for a COVID-19 vaccine.\n\nFiltering Type: `boolean`\n\n```\nEligible For: \n * healthcareFacility\n * location\n```" covidVaccineDriveThroughSite: type: boolean description: "Indicates whether location is a drive-through site for COVID-19 vaccines.\n\nFiltering Type: `boolean`\n\n```\nEligible For: \n * healthcareFacility\n * location\n```" covidVaccineInformationUrl: minLength: 0 format: uri type: string description: "An information URL for more information about COVID-19 vaccines.\n\nFiltering Type: `text`\n\n```\nEligible For: \n * healthcareFacility\n * location\n```" covidVaccinePatientRestrictions: type: boolean description: "Indicates whether there are patient restrictions for a COVID-19 vaccine.\n\nFiltering Type: `boolean`\n\n```\nEligible For: \n * healthcareFacility\n * location\n```" covidVaccineReferralRequired: type: boolean description: "Indicates whether a referral is required for a COVID-19 vaccine.\n\nFiltering Type: `boolean`\n\n```\nEligible For: \n * healthcareFacility\n * location\n```" covidVaccineSiteInstructions: minLength: 0 maxLength: 15000 type: string description: "Information or instructions for the COVID-19 vaccination site.\n\nFiltering Type: `text`\n\n```\nEligible For: \n * healthcareFacility\n * location\n```" 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.\n\nFiltering Type: `list of option`\n\n```\nEligible For: \n * healthcareFacility\n * location\n```" currencyExchange: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: "Indicates whether the entity offers currency exchange services.\n\nFiltering Type: `option`\n\n```\nEligible For: \n * hotel\n```" customKeywords: description: "Additional keywords you would like us to use when tracking your search performance\n\n\nArray must be ordered.\n\nArray may have a maximum of 5 elements.\n\n\nFiltering Type: `list of text`\n\n```\nEligible For: \n * atm\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * organization\n * restaurant\n```" 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\n\nFiltering Type: `date`\n\n```\nEligible For: \n * job\n```" degrees: description: "A list of the degrees earned by the healthcare professional\n\n\nArray must be ordered.\n\n\nFiltering Type: `list of option`\n\n```\nEligible For: \n * healthcareProfessional\n```" 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.\n\nEach 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.\nSimilarly, holiday delivery hours are represented by the `holidayHours` sub-field.\nSetting the `reopenDate` sub-field indicates that the business is temporarily closed and will reopen on the specified date.\nSPECIAL CASES:\n* 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.\n* 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.\n* If you are providing `openIntervals`, you may not set `isClosed` to true for that day.\n\nFiltering Type: `hours`\n\n```\nEligible For: \n * location\n * restaurant\n```" description: minLength: 10 maxLength: 15000 type: string description: "A description of the entity\n\n\nCannot Include:\n* HTML markup\n\nFiltering Type: `text`\n\n```\nEligible For: \n * atm\n * contactCard\n * event\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * job\n * location\n * organization\n * restaurant\n```" 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\n\nFiltering Type: `object`\n\n```\nEligible For: \n * atm\n * event\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * job\n * location\n * restaurant\n```" doctorOnCall: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: "Indicates whether the entity has a doctor on premise or on call.\n\nFiltering Type: `option`\n\n```\nEligible For: \n * hotel\n```" dogsAllowed: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: "Indicates if the entity is dog friendly.\n\nFiltering Type: `option`\n\n```\nEligible For: \n * hotel\n```" 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.\n\nEach 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.\nSimilarly, holiday drive-through hours are represented by the `holidayHours` sub-field.\nSetting the `reopenDate` sub-field indicates that the business is temporarily closed and will reopen on the specified date.\nSPECIAL CASES:\n* 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.\n* 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.\n* If you are providing `openIntervals`, you may not set `isClosed` to true for that day.\n\nFiltering Type: `hours`\n\n```\nEligible For: \n * atm\n * location\n * restaurant\n```" 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\n\nFiltering Type: `object`\n\n```\nEligible For: \n * atm\n * event\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * restaurant\n```" educationList: description: "Information about the education or training completed by the healthcare professional\n\n\nArray must be ordered.\n\n\nFiltering Type: `list of object`\n\n```\nEligible For: \n * healthcareProfessional\n```" 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.\n\nFiltering Type: `option`\n\n```\nEligible For: \n * hotel\n```" elevator: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: "Indicates whether the entity has an elevator.\n\nFiltering Type: `option`\n\n```\nEligible For: \n * hotel\n```" ellipticalMachine: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: "Indicates whether the entity has an elliptical machine.\n\nFiltering Type: `option`\n\n```\nEligible For: \n * hotel\n```" emails: description: "Emails addresses for this entity's point of contact\n\nMust be valid email addresses\n\n\n\nArray must be ordered.\n\nArray may have a maximum of 5 elements.\n\n\nFiltering Type: `list of text`\n\n```\nEligible For: \n * contactCard\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * organization\n * restaurant\n```" 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.\n\nFiltering Type: `option`\n\n```\nEligible For: \n * job\n```" eventStatus: enum: - SCHEDULED - RESCHEDULED - POSTPONED - CANCELED - EVENT_MOVED_ONLINE type: string description: "Information on whether the event will take place as scheduled\n\nFiltering Type: `option`\n\n```\nEligible For: \n * event\n```" facebookAbout: minLength: 0 maxLength: 255 type: string description: "A description of the entity to be used in the \"About You\" section on Facebook\n\nFiltering Type: `text`\n\n```\nEligible For: \n * atm\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * restaurant\n```" 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\n\nValid contents of **`value`** depends on the Call-to-Action's **`type`**:\n* `NONE`: (optional)\n* `BOOK_NOW`: URL\n* `CALL_NOW`: Phone number\n* `CONTACT_US`: URL\n* `SEND_MESSAGE`: Any string\n* `USE_APP`: URL\n* `PLAY_GAME`: URL\n* `SHOP_NOW`: URL\n* `SIGN_UP`: URL\n* `WATCH_VIDEO`: URL\n* `SEND_EMAIL`: Email address\n* `LEARN_MORE`: URL\n* `PURCHASE_GIFT_CARDS`: URL\n* `ORDER_NOW`: URL\n* `FOLLOW_PAGE`: Any string\n\nFiltering Type: `object`\n\n```\nEligible For: \n * atm\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * restaurant\n```" facebookCoverPhoto: required: - url additionalProperties: false type: object description: "The cover photo for the entity's Facebook profile\n\nDisplayed as a 851 x 315 pixel image\n\nYou may need a cover photo in order for your listing to appear on Facebook. Please check your listings tab to learn more.\n\n\nImage must be at least 400 x 150 pixels\n\nImage area (width x height) may be no more than 41000000 pixels\n\nImage may be no more than 30000 x 30000 pixels\n\nSupported Aspect Ratios:\n* 1 x 1\n* 4 x 3\n* 3 x 2\n* 5 x 3\n* 16 x 9\n* 3 x 1\n* 2 x 3\n* 5 x 7\n* 4 x 5\n* 4 x 1\n\n**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.\n\n\nFiltering Type: `object`\n\n```\nEligible For: \n * atm\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * restaurant\n```" 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.\n\n\nCannot Include:\n* HTML markup\n\nFiltering Type: `text`\n\n```\nEligible For: \n * atm\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * restaurant\n```" 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.\n\nFiltering Type: `text`\n\n```\nEligible For: \n * atm\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * restaurant\n```" facebookOverrideCity: minLength: 0 type: string description: "The city to be displayed on this entity's Facebook profile\n\nFiltering Type: `text`\n\n```\nEligible For: \n * atm\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * restaurant\n```" facebookPageUrl: minLength: 0 type: string description: "URL for the entity's Facebook Page.\n\nValid formats:\n\n- facebook.com/profile.php?id=[numId]\n- facebook.com/group.php?gid=[numId]\n- facebook.com/groups/[numId]\n- facebook.com/[Name]\n- facebook.com/pages/[Name]/[numId]\n- facebook.com/people/[Name]/[numId]\n\nwhere [Name] is a String and [numId] is an Integer\nThe success response will contain a warning message explaining why the URL wasn't stored in the system.\n\nFiltering Type: `text`\n\n```\nEligible For: \n * atm\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * organization\n * restaurant\n```" 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\n\nFiltering Type: `text`\n\n```\nEligible For: \n * atm\n * brand\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * restaurant\n```" facebookProfilePhoto: required: - url additionalProperties: false type: object description: "The profile picture for the entity's Facebook profile\n\nYou must have a profile picture in order for your listing to appear on Facebook.\n\n\nImage must be at least 180 x 180 pixels\n\nImage area (width x height) may be no more than 41000000 pixels\n\nImage may be no more than 30000 x 30000 pixels\n\nSupported Aspect Ratios:\n* 1 x 1\n* 4 x 3\n* 3 x 2\n* 5 x 3\n* 16 x 9\n* 3 x 1\n* 2 x 3\n* 5 x 7\n* 4 x 5\n* 4 x 1\n\n**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.\n\n\nFiltering Type: `object`\n\n```\nEligible For: \n * atm\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * restaurant\n```" 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\n\nFiltering Type: `text`\n\n```\nEligible For: \n * atm\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * restaurant\n```" 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.\n\nFiltering Type: `text`\n\n```\nEligible For: \n * atm\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * restaurant\n```" 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).\n\nFiltering Type: `text`\n\n```\nEligible For: \n * atm\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * restaurant\n```" fax: minLength: 0 type: string description: "Must be a valid fax number.\n\nIf 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.\n\nFiltering Type: `text`\n\n```\nEligible For: \n * atm\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * restaurant\n```" 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\n\nFiltering Type: `object`\n\n```\nEligible For: \n * atm\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * restaurant\n```" firstName: minLength: 0 maxLength: 35 type: string description: "The first name of the healthcare professional\n\n\nCannot Include:\n* a URL or domain name\n* HTML markup\n\nFiltering Type: `text`\n\n```\nEligible For: \n * healthcareProfessional\n```" firstPartyReviewPage: minLength: 0 type: string description: "Link to the review-collection page, where consumers can leave first-party reviews\n\n```\nEligible For: \n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * restaurant\n```" fitnessCenter: enum: - FITNESS_CENTER_AVAILABLE - FITNESS_CENTER_AVAILABLE_FOR_FREE - NOT_APPLICABLE type: string description: "Indicates whether the entity has a fitness center.\n\nFiltering Type: `option`\n\n```\nEligible For: \n * hotel\n```" floorCount: multipleOf: 1 minimum: 0 type: number description: "The number of floors the entity has from ground floor to top floor.\n\nFiltering Type: `integer`\n\n```\nEligible For: \n * hotel\n```" freeWeights: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: "Indicates whether the entity has free weights.\n\nFiltering Type: `option`\n\n```\nEligible For: \n * hotel\n```" frequentlyAskedQuestions: description: "A list of questions that are frequently asked about this entity\n\n\nArray must be ordered.\n\nArray may have a maximum of 100 elements.\n\n\nFiltering Type: `list of object`\n\n```\nEligible For: \n * atm\n * event\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * restaurant\n```" 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.\n\nFiltering Type: `option`\n\n```\nEligible For: \n * hotel\n```" fullyVaccinatedStaff: type: boolean description: "Indicates whether the staff is vaccinated against COVID-19.\n\nFiltering Type: `boolean`\n\n```\nEligible For: \n * healthcareFacility\n * hotel\n * location\n * restaurant\n```" gameRoom: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: "Indicates whether the entity has a game room.\n\nFiltering Type: `option`\n\n```\nEligible For: \n * hotel\n```" gender: enum: - UNSPECIFIED - FEMALE - MALE - NONBINARY - TRANSGENDER_FEMALE - TRANSGENDER_MALE - OTHER - PREFER_NOT_TO_DISCLOSE type: string description: "The gender of the healthcare professional\n\nFiltering Type: `option`\n\n```\nEligible For: \n * healthcareProfessional\n```" geomodifier: minLength: 0 type: string description: "Provides additional information on where the entity can be found (e.g., `Times Square`, `Global Center Mall`)\n\nFiltering Type: `text`\n\n```\nEligible For: \n * atm\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * restaurant\n```" giftShop: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: "Indicates whether the entity has a gift shop.\n\nFiltering Type: `option`\n\n```\nEligible For: \n * hotel\n```" 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.\n\nFiltering Type: `option`\n\n```\nEligible For: \n * hotel\n```" 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.\n\nValid 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.\n\nKeyword 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`).\n\n* 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\" ] }]`)\n* 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\" ]}`)\n\n**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.\n\nFiltering Type: `object`\n\n```\nEligible For: \n * atm\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * restaurant\n```" googleCoverPhoto: required: - url additionalProperties: false type: object description: "The cover photo for the entity's Google profile\n\n\nImage must be at least 250 x 250 pixels\n\n\nFiltering Type: `object`\n\n```\nEligible For: \n * atm\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * restaurant\n```" 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.\nMust be a valid phone number.\nIf 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. \n\nFiltering 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.\n\nNOTE: 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.\n\nFiltering Type: `object`\n\n```\nEligible For: \n * atm\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * restaurant\n```" googleMyBusinessLabels: description: "Google Business Profile Labels help users organize their locations into groups within GBP.\n\n\nArray must be ordered.\n\nArray may have a maximum of 10 elements.\n\nArray item description:\n\n>Cannot Include:\n>* HTML markup\n\nFiltering Type: `list of text`\n\n```\nEligible For: \n * atm\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * restaurant\n```" 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.\n\nFiltering Type: `text`\n\n```\nEligible For: \n * atm\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * restaurant\n```" googleProfilePhoto: required: - url additionalProperties: false type: object description: "The profile photo for the entity's Google profile\n\n\nImage must be at least 250 x 250 pixels\n\nImage may be no more than 5000 x 5000 pixels\n\nSupported Aspect Ratios:\n* 1 x 1\n\n**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.\n\n\nFiltering Type: `object`\n\n```\nEligible For: \n * atm\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * restaurant\n```" 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).\n\nFor 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.\n\nFiltering Type: `text`\n\n```\nEligible For: \n * atm\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * restaurant\n```" 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.\n\nEach 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.\nSimilarly, holiday happy hours are represented by the `holidayHours` sub-field.\nSetting the `reopenDate` sub-field indicates that the business is temporarily closed and will reopen on the specified date.\nSPECIAL CASES:\n* 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.\n* 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.\n* If you are providing `openIntervals`, you may not set `isClosed` to true for that day.\n\nFiltering Type: `hours`\n\n```\nEligible For: \n * hotel\n * location\n * restaurant\n```" headshot: required: - url additionalProperties: false type: object description: "A portrait of the healthcare professional\n\nFiltering Type: `object`\n\n```\nEligible For: \n * contactCard\n * financialProfessional\n * healthcareProfessional\n```" 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\n\nFiltering Type: `text`\n\n```\nEligible For: \n * job\n```" holidayHoursConversationEnabled: type: boolean description: "Indicates whether holiday-hour confirmation alerts are enabled for the Yext Knowledge Assistant for this entity\n\nFiltering Type: `boolean`\n\n```\nEligible For: \n * atm\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * restaurant\n```" horsebackRiding: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: "Indicates whether the entity offers horseback riding.\n\nFiltering Type: `option`\n\n```\nEligible For: \n * hotel\n```" hotTub: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: "Indicates whether the entity has a hot tub.\n\nFiltering Type: `option`\n\n```\nEligible For: \n * hotel\n```" 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.\n\nEach 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.\nSimilarly, holiday hours are represented by the `holidayHours` sub-field.\nSetting the `reopenDate` sub-field indicates that the business is temporarily closed and will reopen on the specified date.\nSPECIAL CASES:\n* 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.\n* 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.\n* If you are providing `openIntervals`, you may not set `isClosed` to true for that day.\n\nFiltering Type: `hours`\n\n```\nEligible For: \n * atm\n * contactCard\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * restaurant\n```" housekeeping: enum: - HOUSEKEEPING_AVAILABLE - HOUSEKEEPING_AVAILABLE_DAILY - NOT_APPLICABLE type: string description: "Indicates whether the entity offers housekeeping services.\n\nFiltering Type: `option`\n\n```\nEligible For: \n * hotel\n```" 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.\n\nFiltering Type: `text`\n\n```\nEligible For: \n * atm\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * restaurant\n```" indoorPoolCount: multipleOf: 1 minimum: 0 type: number description: "A count of the number of indoor pools\n\nFiltering Type: `integer`\n\n```\nEligible For: \n * hotel\n```" instagramHandle: minLength: 0 maxLength: 30 type: string description: "Valid Instagram username for the entity without the leading \"@\" (e.g., `NewCityAuto`)\n\nFiltering Type: `text`\n\n```\nEligible For: \n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * organization\n * restaurant\n```" insuranceAccepted: description: "A list of insurance policies accepted by the healthcare provider\n\n\nArray must be ordered.\n\nArray may have a maximum of 100 elements.\n\nArray item description:\n\n>Cannot Include:\n>* HTML markup\n\nFiltering Type: `list of text`\n\n```\nEligible For: \n * healthcareFacility\n * healthcareProfessional\n```" 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\n\nFiltering Type: `text`\n\n```\nEligible For: \n * brand\n * financialProfessional\n * hotel\n * location\n * restaurant\n```" isClusterPrimary: type: boolean description: "Indicates whether the healthcare entity is the primary entity in its group\n\nFiltering Type: `boolean`\n\n```\nEligible For: \n * healthcareProfessional\n```" isFreeEvent: type: boolean description: "Indicates whether or not the event is free\n\nFiltering Type: `boolean`\n\n```\nEligible For: \n * event\n```" isoRegionCode: minLength: 0 type: string description: "The ISO 3166-2 region code for the entity\n\nYext 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.\n\nFiltering Type: `text`\n\n```\nEligible For: \n * atm\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * restaurant\n```" keywords: description: "Keywords that describe the entity.\n\nAll strings must be non-empty when trimmed of whitespace.\n\n\n\nArray must be ordered.\n\nArray may have a maximum of 100 elements.\n\nArray item description:\n\n>Cannot Include:\n>* HTML markup\n\nFiltering Type: `list of text`\n\n```\nEligible For: \n * atm\n * card\n * event\n * faq\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * helpArticle\n * hotel\n * job\n * location\n * product\n * restaurant\n```" 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.\n\nFiltering Type: `option`\n\n```\nEligible For: \n * hotel\n```" kidsClub: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: "Indicates if the property has a Kids Club.\n\nFiltering Type: `option`\n\n```\nEligible For: \n * hotel\n```" kidsStayFree: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: "Indicates whether the entity allows kids to stay free.\n\nFiltering Type: `option`\n\n```\nEligible For: \n * hotel\n```" 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.\n\nEach 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.\nSimilarly, holiday kitchen hours are represented by the `holidayHours` sub-field.\nSetting the `reopenDate` sub-field indicates that the business is temporarily closed and will reopen on the specified date.\nSPECIAL CASES:\n* 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.\n* 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.\n* If you are providing `openIntervals`, you may not set `isClosed` to true for that day.\n\nFiltering Type: `hours`\n\n```\nEligible For: \n * hotel\n * location\n * restaurant\n```" 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.\n\n**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.\n\nFiltering Type: `opaque`\n\n```\nEligible For: \n * atm\n * board\n * brand\n * card\n * contactCard\n * event\n * faq\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * helpArticle\n * hotel\n * hotelRoomType\n * job\n * location\n * organization\n * product\n * restaurant\n```" landingPageUrl: minLength: 0 format: uri type: string description: "The URL of this entity's Landing Page that was created with Yext Pages\n\nFiltering Type: `text`\n\n```\nEligible For: \n * atm\n * card\n * event\n * faq\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * helpArticle\n * hotel\n * job\n * location\n * product\n * restaurant\n```" languages: description: "The langauges in which consumers can commicate with this entity or its staff members\nAll strings must be non-empty when trimmed of whitespace.\n\n\n\nArray must be ordered.\n\nArray may have a maximum of 100 elements.\n\nArray item description:\n\n>Cannot Include:\n>* HTML markup\n\nFiltering Type: `list of text`\n\n```\nEligible For: \n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * restaurant\n```" 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\n\n\nCannot Include:\n* a URL or domain name\n* HTML markup\n\nFiltering Type: `text`\n\n```\nEligible For: \n * healthcareProfessional\n```" laundry: enum: - FULL_SERVICE - SELF_SERVICE - NOT_APPLICABLE type: string description: "Indicates whether the entity offers laundry services.\n\nFiltering Type: `option`\n\n```\nEligible For: \n * hotel\n```" lazyRiver: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: "Indicates if the property has a lazy river\n\nFiltering Type: `option`\n\n```\nEligible For: \n * hotel\n```" lifeguard: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: "Indicates if the property has a lifeguard on duty\n\nFiltering Type: `option`\n\n```\nEligible For: \n * hotel\n```" linkedInUrl: minLength: 0 format: uri type: string description: "URL for your LinkedIn account, format should be https://www.linkedin.com/in/yourUsername\n\nFiltering Type: `text`\n\n```\nEligible For: \n * contactCard\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * organization\n * restaurant\n```" linkedLocation: type: string description: "location ID of the event location, if the event is held at a location managed in the Yext Knowledge Manager\n\nFiltering Type: `entityId`\n\n```\nEligible For: \n * contactCard\n * event\n```" 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.\n\nFiltering Type: `text`\n\n```\nEligible For: \n * atm\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * restaurant\n```" localShuttle: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: "Indicates whether the entity offers local shuttle services.\n\nFiltering Type: `option`\n\n```\nEligible For: \n * hotel\n```" 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.\n\nFiltering Type: `entityId`\n\n```\nEligible For: \n * atm\n```" 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\n\nFiltering Type: `object`\n\n```\nEligible For: \n * job\n```" locationType: enum: - LOCATION - HEALTHCARE_FACILITY - HEALTHCARE_PROFESSIONAL - ATM - RESTAURANT - HOTEL type: string description: "Indicates the entity's type, if it is not an event\n\nFiltering Type: `option`\n\n```\nEligible For: \n * atm\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * restaurant\n```" logo: required: - image additionalProperties: false type: object description: "An image of the entity's logo\n\n\nSupported Aspect Ratios:\n* 1 x 1\n\n**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.\n\n\nFiltering Type: `object`\n\n```\nEligible For: \n * atm\n * contactCard\n * faq\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * job\n * location\n * organization\n * restaurant\n```" 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\n\nMust be a valid phone number.\n\nIf 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.\n\nFiltering Type: `text`\n\n```\nEligible For: \n * atm\n * contactCard\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * organization\n * restaurant\n```" massage: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: "Indicates whether the entity offers massage services.\n\nFiltering Type: `option`\n\n```\nEligible For: \n * hotel\n```" 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\n\nFiltering Type: `integer`\n\n```\nEligible For: \n * hotel\n```" 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\n\nFiltering Type: `integer`\n\n```\nEligible For: \n * hotel\n```" 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\n\nFiltering Type: `list of option`\n\n```\nEligible For: \n * restaurant\n```" meetingRoomCount: multipleOf: 1 minimum: 0 type: number description: "The number of meeting rooms the entity has.\n\nFiltering Type: `integer`\n\n```\nEligible For: \n * hotel\n```" 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\n\nFiltering Type: `object`\n\n```\nEligible For: \n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * restaurant\n```" 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\n\nFiltering Type: `object`\n\n```\nEligible For: \n * hotel\n * location\n * restaurant\n```" middleName: minLength: 0 maxLength: 35 type: string description: "The middle name of the healthcare professional\n\n\nCannot Include:\n* a URL or domain name\n* HTML markup\n\nFiltering Type: `text`\n\n```\nEligible For: \n * healthcareProfessional\n```" mobilePhone: minLength: 0 type: string description: "Must be a valid phone number.\n\nIf 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.\n\nFiltering Type: `text`\n\n```\nEligible For: \n * atm\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * restaurant\n```" mobilityAccessible: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: "Indicates whether the entity is mobility/wheelchair accessible\n\nFiltering Type: `option`\n\n```\nEligible For: \n * hotel\n```" nightclub: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: "Indicates whether the entity has a nightclub.\n\nFiltering Type: `option`\n\n```\nEligible For: \n * hotel\n```" npi: minLength: 0 type: string description: "The National Provider Identifier (NPI) of the healthcare provider\n\nFiltering Type: `text`\n\n```\nEligible For: \n * healthcareFacility\n * healthcareProfessional\n```" nudgeEnabled: type: boolean description: "Indicates whether Knowledge Nudge is enabled for the Yext Knowledge Assistant for this entity\n\nFiltering Type: `boolean`\n\n```\nEligible For: \n * atm\n * faq\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * helpArticle\n * hotel\n * job\n * location\n * organization\n * product\n * restaurant\n```" officeName: minLength: 0 type: string description: "The name of the office where the healthcare professional works, if different from **`name`**\n\nFiltering Type: `text`\n\n```\nEligible For: \n * healthcareProfessional\n```" 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.\n\nEach 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.\nSimilarly, holiday online service hours are represented by the `holidayHours` sub-field.\nSetting the `reopenDate` sub-field indicates that the business is temporarily closed and will reopen on the specified date.\nSPECIAL CASES:\n* 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.\n* 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.\n* If you are providing `openIntervals`, you may not set `isClosed` to true for that day.\n\nFiltering Type: `hours`\n\n```\nEligible For: \n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * location\n * restaurant\n```" openDate: format: date type: string description: "The date that the entity is set to open for the first time.\nMust be formatted in YYYY-MM-DD format.\n\nDate must be on or after 1970-01-01 Date must be before or on 2038-01-01\n\n\nFiltering Type: `date`\n\n```\nEligible For: \n * atm\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * restaurant\n```" 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\n\nFiltering Type: `list of option`\n\n```\nEligible For: \n * organization\n```" 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\n\nFiltering Type: `object`\n\n```\nEligible For: \n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * restaurant\n```" organizerEmail: minLength: 0 format: email type: string description: "Point of contact for the event organizer (not to be published publicly)\n\nFiltering Type: `text`\n\n```\nEligible For: \n * event\n```" organizerName: minLength: 0 type: string description: "Point of contact for the event organizer (not to be published publicly)\n\nFiltering Type: `text`\n\n```\nEligible For: \n * event\n```" organizerPhone: minLength: 0 type: string description: "Point of contact for the event organizer (not to be published publicly)\n\nFiltering Type: `text`\n\n```\nEligible For: \n * event\n```" outdoorPoolCount: multipleOf: 1 minimum: 0 type: number description: "The number of outdoor pools the entity has.\n\nFiltering Type: `integer`\n\n```\nEligible For: \n * hotel\n```" parking: enum: - PARKING_AVAILABLE - PARKING_AVAILABLE_FOR_FREE - NOT_APPLICABLE type: string description: "Indicates whether the entity offers parking services.\n\nFiltering Type: `option`\n\n```\nEligible For: \n * hotel\n```" 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\n\nValid elements depend on the entity's country.\n\n\nFiltering Type: `list of option`\n\n```\nEligible For: \n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * restaurant\n```" performers: description: "Performers at the event\n\n\nArray must be ordered.\n\nArray may have a maximum of 100 elements.\n\n\nFiltering Type: `list of text`\n\n```\nEligible For: \n * event\n```" 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.\n\nFiltering Type: `option`\n\n```\nEligible For: \n * hotel\n```" photoGallery: description: "\n**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.\n\n\n\nArray must be ordered.\n\nArray may have a maximum of 500 elements.\n\nArray item description:\n\n>Supported Aspect Ratios:\n>* 1 x 1\n>* 4 x 3\n>* 3 x 2\n>* 5 x 3\n>* 16 x 9\n>* 3 x 1\n>* 2 x 3\n>* 5 x 7\n>* 4 x 5\n>* 4 x 1\n>\n>**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.\n>\n\nFiltering Type: `list of object`\n\n```\nEligible For: \n * atm\n * event\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * hotelRoomType\n * location\n * organization\n * product\n * restaurant\n```" 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\n\nFiltering Type: `object`\n\n```\nEligible For: \n * atm\n * event\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * restaurant\n```" 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.\n\nEach 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.\nSimilarly, holiday pickup hours are represented by the `holidayHours` sub-field.\nSetting the `reopenDate` sub-field indicates that the business is temporarily closed and will reopen on the specified date.\nSPECIAL CASES:\n* 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.\n* 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.\n* If you are providing `openIntervals`, you may not set `isClosed` to true for that day.\n\nFiltering Type: `hours`\n\n```\nEligible For: \n * healthcareFacility\n * location\n * restaurant\n```" pinterestUrl: minLength: 0 format: uri type: string description: "URL for your Pinterest account, format should be https://www.pinterest.com/yourUsername\n\nFiltering Type: `text`\n\n```\nEligible For: \n * contactCard\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * organization\n * restaurant\n```" 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)\n\nFiltering Type: `option`\n\n```\nEligible For: \n * atm\n * healthcareFacility\n * healthcareProfessional\n * location\n * restaurant\n```" primaryConversationContact: minLength: 0 type: string description: "ID of the user who is the primary Knowledge Assistant contact for the entity\n\nFiltering Type: `option`\n\n```\nEligible For: \n * atm\n * faq\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * helpArticle\n * hotel\n * job\n * location\n * organization\n * product\n * restaurant\n```" privateBeach: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: "Indicates whether the entity has access to a private beach.\n\nFiltering Type: `option`\n\n```\nEligible For: \n * hotel\n```" privateCarService: enum: - PRIVATE_CAR_SERVICE - PRIVATE_CAR_SERVICE_FOR_FREE - NOT_APPLICABLE type: string description: "Indicates whether the entity offers private car services.\n\nFiltering Type: `option`\n\n```\nEligible For: \n * hotel\n```" 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\n\nFiltering Type: `object`\n\n```\nEligible For: \n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * restaurant\n```" products: description: "Products sold by this entity\n\nAll strings must be non-empty when trimmed of whitespace.\n\n\n\nArray must be ordered.\n\nArray may have a maximum of 100 elements.\n\nArray item description:\n\n>Cannot Include:\n>* HTML markup\n\nFiltering Type: `list of text`\n\n```\nEligible For: \n * financialProfessional\n * location\n```" 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\n\nFiltering Type: `boolean`\n\n```\nEligible For: \n * atm\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * organization\n * restaurant\n```" rankTrackingCompetitors: description: "Information about the competitors whose search performance you would like to compare to your own\n\n\nArray must be ordered.\n\nArray may have a maximum of 5 elements.\n\n\nFiltering Type: `list of object`\n\n```\nEligible For: \n * atm\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * organization\n * restaurant\n```" 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\n\nFiltering Type: `boolean`\n\n```\nEligible For: \n * atm\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * organization\n * restaurant\n```" rankTrackingFrequency: enum: - WEEKLY - MONTHLY - QUARTERLY type: string description: "How often we send search queries to track your search performance\n\nFiltering Type: `option`\n\n```\nEligible For: \n * atm\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * organization\n * restaurant\n```" rankTrackingQueryTemplates: description: "The ways in which your keywords will be arranged in the search queries we use to track your performance\n\n\nArray must have a minimum of 2 elements.\n\nArray may have a maximum of 4 elements.\n\n\nFiltering Type: `list of option`\n\n```\nEligible For: \n * atm\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * organization\n * restaurant\n```" 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\n\nFiltering Type: `list of option`\n\n```\nEligible For: \n * atm\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * organization\n * restaurant\n```" 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\n\nFiltering Type: `object`\n\n```\nEligible For: \n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * restaurant\n```" restaurantCount: multipleOf: 1 minimum: 0 type: number description: "The number of restaurants the entity has.\n\nFiltering Type: `integer`\n\n```\nEligible For: \n * hotel\n```" reviewGenerationUrl: minLength: 0 type: string description: "The URL given Review Invitation emails where consumers can leave a review about the entity\n\n```\nEligible For: \n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * restaurant\n```" reviewResponseConversationEnabled: type: boolean description: "Indicates whether Yext Knowledge Assistant review-response conversations are enabled for this entity\n\nFiltering Type: `boolean`\n\n```\nEligible For: \n * atm\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * restaurant\n```" roomCount: multipleOf: 1 minimum: 0 type: number description: "The number of rooms the entity has.\n\nFiltering Type: `integer`\n\n```\nEligible For: \n * hotel\n```" roomService: enum: - ROOM_SERVICE_AVAILABLE - ROOM_SERVICE_AVAILABLE_24_HOURS - NOT_APPLICABLE type: string description: "Indicates whether the entity offers room service.\n\nFiltering Type: `option`\n\n```\nEligible For: \n * hotel\n```" 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\n\nFiltering Type: `object`\n\n```\nEligible For: \n * atm\n * event\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * restaurant\n```" salon: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: "Indicates whether the entity has a salon.\n\nFiltering Type: `option`\n\n```\nEligible For: \n * hotel\n```" sauna: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: "Indicates whether the entity has a sauna.\n\nFiltering Type: `option`\n\n```\nEligible For: \n * hotel\n```" scuba: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: "Indicates whether the entity offers scuba diving.\n\nFiltering Type: `option`\n\n```\nEligible For: \n * hotel\n```" selfParking: enum: - SELF_PARKING_AVAILABLE - SELF_PARKING_AVAILABLE_FOR_FREE - NOT_APPLICABLE type: string description: "Indicates whether the entity offers self parking services.\n\nFiltering Type: `option`\n\n```\nEligible For: \n * hotel\n```" 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.\n\nEach 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.\nSimilarly, holiday senior hours are represented by the `holidayHours` sub-field.\nSetting the `reopenDate` sub-field indicates that the business is temporarily closed and will reopen on the specified date.\nSPECIAL CASES:\n* 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.\n* 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.\n* If you are providing `openIntervals`, you may not set `isClosed` to true for that day.\n\nFiltering Type: `hours`\n\n```\nEligible For: \n * location\n * restaurant\n```" serviceArea: additionalProperties: false type: object properties: places: description: "A list of places served by the entity, where each place is either:\n - a postal code, or\n - the name of a city.\n\n\n\nArray must be ordered.\n\nArray may have a maximum of 200 elements.\n\n\nFiltering 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.\n\n**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.\n\nFiltering Type: `object`\n\n```\nEligible For: \n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * restaurant\n```" 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.\n**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.\n\n\nArray may have a maximum of 200 elements.\n\n\nFiltering Type: `list of object`\n\n```\nEligible For: \n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * restaurant\n```" 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\n\nAll strings must be non-empty when trimmed of whitespace.\n\n\n\nArray must be ordered.\n\nArray may have a maximum of 100 elements.\n\nArray item description:\n\n>Cannot Include:\n>* HTML markup\n\nFiltering Type: `list of text`\n\n```\nEligible For: \n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * restaurant\n```" 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.\n\nFiltering Type: `option`\n\n```\nEligible For: \n * hotel\n```" snorkeling: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: "Indicates whether the entity offers snorkeling.\n\nFiltering Type: `option`\n\n```\nEligible For: \n * hotel\n```" socialHour: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: "Indicates whether the entity offers a social hour.\n\nFiltering Type: `option`\n\n```\nEligible For: \n * hotel\n```" spa: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: "Indicates whether the entity has a spa.\n\nFiltering Type: `option`\n\n```\nEligible For: \n * hotel\n```" specialities: description: "Up to 100 of this entity's specialities (e.g., for food and dining: `Chicago style`)\n\nAll strings must be non-empty when trimmed of whitespace.\n\n\n\nArray must be ordered.\n\nArray may have a maximum of 100 elements.\n\nArray item description:\n\n>Cannot Include:\n>* HTML markup\n\nFiltering Type: `list of text`\n\n```\nEligible For: \n * financialProfessional\n * location\n * restaurant\n```" 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.\n\nFiltering Type: `option`\n\n```\nEligible For: \n * hotel\n```" 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.\n\nEach 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.\nSimilarly, holiday takeout hours are represented by the `holidayHours` sub-field.\nSetting the `reopenDate` sub-field indicates that the business is temporarily closed and will reopen on the specified date.\nSPECIAL CASES:\n* 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.\n* 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.\n* If you are providing `openIntervals`, you may not set `isClosed` to true for that day.\n\nFiltering Type: `hours`\n\n```\nEligible For: \n * location\n * restaurant\n```" tennis: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: "Indicates whether the entity has tennis courts.\n\nFiltering Type: `option`\n\n```\nEligible For: \n * hotel\n```" thermalPool: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: "Indicates whether the entity has a thermal pool.\n\nFiltering Type: `option`\n\n```\nEligible For: \n * hotel\n```" ticketAvailability: enum: - IN_STOCK - SOLD_OUT - PRE_ORDER - UNSPECIFIED type: string description: "Information about the availability of tickets for the event\n\nFiltering Type: `option`\n\n```\nEligible For: \n * event\n```" 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\n\nFiltering Type: `object`\n\n```\nEligible For: \n * event\n```" ticketSaleDateTime: format: date-time type: string description: "The date/time tickets are available for sale (local time)\n\nFiltering Type: `datetime`\n\n```\nEligible For: \n * event\n```" ticketUrl: minLength: 0 format: uri type: string description: "URL to purchase tickets for the event (if ticketed)\n\nFiltering Type: `text`\n\n```\nEligible For: \n * event\n```" tikTokUrl: minLength: 0 format: uri type: string description: "URL for your TikTok profile, format should be https://www.tiktok.com/yourUsername\n\nFiltering Type: `text`\n\n```\nEligible For: \n * contactCard\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * organization\n * restaurant\n```" 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\n\nFiltering Type: `object`\n\n```\nEligible For: \n * event\n```" timeZoneUtcOffset: minLength: 0 type: string description: "Represents the time zone offset of the entity from UTC, in `±hh:mm` format.\n\nFor example, if the entity is 4 hours ahead of UTC time, the offset will be `+04:00`.\n\nIf the entity is 15.5 hours behind UTC time, the offset will be `-15:30`.\n\nIf the entity is in UTC time, the offset will be `+00:00`.\n\n\n```\nEligible For: \n * atm\n * event\n * faq\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * job\n * location\n * restaurant\n```" 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\"`\n\nFiltering Type: `option`\n\n```\nEligible For: \n * atm\n * board\n * card\n * contactCard\n * event\n * faq\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * helpArticle\n * hotel\n * hotelRoomType\n * job\n * location\n * organization\n * product\n * restaurant\n```" tollFreePhone: minLength: 0 type: string description: "Must be a valid phone number.\n\nIf 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.\n\nFiltering Type: `text`\n\n```\nEligible For: \n * atm\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * restaurant\n```" treadmill: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: "Indicates whether the entity has a treadmill.\n\nFiltering Type: `option`\n\n```\nEligible For: \n * hotel\n```" ttyPhone: minLength: 0 type: string description: "Must be a valid phone number.\n\nIf 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.\n\nFiltering Type: `text`\n\n```\nEligible For: \n * atm\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * restaurant\n```" turndownService: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: "Indicates whether the entity offers turndown service.\n\nFiltering Type: `option`\n\n```\nEligible For: \n * hotel\n```" twitterHandle: minLength: 0 maxLength: 15 type: string description: "Valid Twitter handle for the entity without the leading \"@\" (e.g., `JohnSmith`)\n\nIf 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.\n\nFiltering Type: `text`\n\n```\nEligible For: \n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * organization\n * restaurant\n```" 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\n\nFiltering Type: `object`\n\n```\nEligible For: \n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * restaurant\n```" 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\n\nFiltering Type: `object`\n\n```\nEligible For: \n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * restaurant\n```" valetParking: enum: - VALET_PARKING_AVAILABLE - VALET_PARKING_AVAILABLE_FOR_FREE - NOT_APPLICABLE type: string description: "Indicates whether the entity offers valet parking services.\n\nFiltering Type: `option`\n\n```\nEligible For: \n * hotel\n```" validThrough: format: date-time type: string description: "The date this entity is valid through.\n\nFiltering Type: `datetime`\n\n```\nEligible For: \n * job\n```" vendingMachine: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: "Indicates whether the entity has a vending machine.\n\nFiltering Type: `option`\n\n```\nEligible For: \n * hotel\n```" venueName: minLength: 0 type: string description: "Name of the venue where the event is being held\n\nFiltering Type: `text`\n\n```\nEligible For: \n * event\n```" videos: description: "Valid YouTube URLs for embedding a video on some publisher sites\n\n**NOTE:** Currently, only the first URL in the Array appears in your listings.\n\n\n\nArray must be ordered.\n\n\nFiltering Type: `list of object`\n\n```\nEligible For: \n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * hotelRoomType\n * location\n * organization\n * product\n * restaurant\n```" 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.\n\nFiltering Type: `option`\n\n```\nEligible For: \n * hotel\n```" wakeUpCalls: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: "Indicates whether the entity offers wake up call services.\n\nFiltering Type: `option`\n\n```\nEligible For: \n * hotel\n```" 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\n\nFiltering Type: `object`\n\n```\nEligible For: \n * atm\n * event\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * restaurant\n```" waterPark: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: "Indicates whether the entity has a water park.\n\nFiltering Type: `option`\n\n```\nEligible For: \n * hotel\n```" waterSkiing: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: "Indicates whether the entity offers water skiing.\n\nFiltering Type: `option`\n\n```\nEligible For: \n * hotel\n```" watercraft: enum: - WATERCRAFT_RENTALS - WATERCRAFT_RENTALS_FOR_FREE - NOT_APPLICABLE type: string description: "Indicates whether the entity offers any kind of watercrafts.\n\nFiltering Type: `option`\n\n```\nEligible For: \n * hotel\n```" waterslide: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: "Indicates whether the entity has a water slide.\n\nFiltering Type: `option`\n\n```\nEligible For: \n * hotel\n```" wavePool: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: "Indicates whether the entity has a wave pool.\n\nFiltering Type: `option`\n\n```\nEligible For: \n * hotel\n```" 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\n\nFiltering Type: `object`\n\n```\nEligible For: \n * atm\n * contactCard\n * event\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * organization\n * restaurant\n```" weightMachine: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: "Indicates whether the entity has a weight machine.\n\nFiltering Type: `option`\n\n```\nEligible For: \n * hotel\n```" wheelchairAccessible: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: "Indicates if the entity is wheelchair accessible.\n\nFiltering Type: `option`\n\n```\nEligible For: \n * hotel\n```" wifiAvailable: enum: - WIFI_AVAILABLE - WIFI_AVAILABLE_FOR_FREE - NOT_APPLICABLE type: string description: "Indicates whether the entity has WiFi available\n\nFiltering Type: `option`\n\n```\nEligible For: \n * hotel\n```" workRemote: type: boolean description: "Indicates whether the job is remote.\n\nFiltering Type: `boolean`\n\n```\nEligible For: \n * job\n```" yearEstablished: multipleOf: 1 minimum: 1000 maximum: 2028 type: number description: "The year the entity was established.\n\nFiltering Type: `integer`\n\n```\nEligible For: \n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * restaurant\n```" yearLastRenovated: multipleOf: 1 minimum: 1000 maximum: 2028 type: number description: "The most recent year the entity was partially or completely renovated.\n\nFiltering Type: `integer`\n\n```\nEligible For: \n * hotel\n```" 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\n\nFiltering Type: `object`\n\n```\nEligible For: \n * atm\n * event\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * job\n * location\n * restaurant\n```" 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\n\nFiltering Type: `object`\n\n```\nEligible For: \n * atm\n * event\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * restaurant\n```" 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\n\nFiltering Type: `object`\n\n```\nEligible For: \n * atm\n * event\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * restaurant\n```" 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\n\nFiltering Type: `object`\n\n```\nEligible For: \n * atm\n * event\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * restaurant\n```" 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\n\nFiltering Type: `object`\n\n```\nEligible For: \n * atm\n * event\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * restaurant\n```" youTubeChannelUrl: minLength: 0 format: uri type: string description: "URL for your YouTube channel, format should be https://www.youtube.com/c/yourUsername\n\nFiltering Type: `text`\n\n```\nEligible For: \n * contactCard\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * organization\n * restaurant\n```" 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: {} post: operationId: createEntity requestBody: description: The entity to be created required: true content: application/json: schema: $ref: '#/components/schemas/EntityWrite' parameters: - schema: minLength: 0 type: string name: accountId in: path required: true - schema: minLength: 0 type: string description: "The type of entity to be created. Should be one of the following:\n * `atm`\n * `event`\n * `faq`\n * `financialProfessional`\n * `healthcareFacility`\n * `healthcareProfessional`\n * `hotel`\n * `hotelRoomType`\n * `job`\n * `location`\n * `organization`\n * `product`\n * `restaurant`\n\nOR the API name of a custom entity type.\n" name: entityType 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 ID of the operation. Leave this blank to create a new operation or supply an ID to continue an existing operation ' name: Update-Operation-Id in: header required: false - schema: minLength: 0 type: string default: markdown description: "The formatting language used to parse rich text field values. Present and **required** if an only if the request contains a field with type \"**Rich Text**.\"\n\nValid values:\n * `markdown`\n * `html`\n" name: format in: query required: false - schema: type: boolean description: 'Optional parameter to strip unsupported formats in rich text fields. When this parameter is included, the unsupported formats in rich text fields will be stripped and saved as plain text; otherwise if this parameter is not included, unsupported formats will return an error. ' name: stripUnsupportedFormats in: query required: false - schema: minLength: 0 type: string description: 'Comma-separated list of top-level fields to apply from the template. If provided, only the fields specified will be applied to the entity. Ignored if **`templateId`** is not provided. ' name: templateFields in: query required: false - schema: minLength: 0 type: string description: 'The external ID of the template to apply to the entity **NOTE:** Some fields that are part of the provided template but not present in the API will be applied - e.g. Linked Accounts ' name: templateId in: query required: false tags: - Knowledge Manager summary: 'Entities: Create' description: "Create a new Entity\n\n**NOTE:**\n * If the **`v`** parameter is before `20181129`: the 201 response contains the created Entity's **`id`**\n * If the **`v`** parameter is on or after `20181129`: the 201 response contains the created Entity in its entirety\n * If the **`v`** parameter is `20240221` or later: returned Entity replaces the **`categoryIds`** field with the **`categories`** field.\n" responses: '201': 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.\n\n```\nEligible For: \n * atm\n * event\n * faq\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * job\n * location\n * restaurant\n```" name: minLength: 0 maxLength: 5000 type: string description: "\n\n\nCannot Include:\n* HTML markup\n\nFiltering Type: `text`\n\n```\nEligible For: \n * atm\n * board\n * brand\n * card\n * contactCard\n * event\n * faq\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * helpArticle\n * hotel\n * hotelRoomType\n * job\n * location\n * organization\n * product\n * restaurant\n```" 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)\n\nMust be a valid address\nCannot be a P.O. Box\n\nIf the entity is an `event`, either an **`address`** value or a **`linkedLocation`** value can be provided.\n\nFiltering Type: `object`\n\n```\nEligible For: \n * atm\n * event\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * restaurant\n```" acceptingNewPatients: type: boolean description: "Indicates whether the healthcare provider is accepting new patients.\n\nFiltering Type: `boolean`\n\n```\nEligible For: \n * healthcareFacility\n * healthcareProfessional\n```" acceptsReservations: type: boolean description: "Indicates whether the entity accepts reservations.\n\nFiltering Type: `boolean`\n\n```\nEligible For: \n * restaurant\n```" 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.\n\nEach 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.\nSimilarly, holiday access hours are represented by the `holidayHours` sub-field.\nSetting the `reopenDate` sub-field indicates that the business is temporarily closed and will reopen on the specified date.\nSPECIAL CASES:\n* 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.\n* 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.\n* If you are providing `openIntervals`, you may not set `isClosed` to true for that day.\n\nFiltering Type: `hours`\n\n```\nEligible For: \n * atm\n * healthcareFacility\n * hotel\n * location\n * restaurant\n```" additionalHoursText: minLength: 0 maxLength: 255 type: string description: "Additional information about hours that does not fit in **`hours`** (e.g., `\"Closed during the winter\"`)\n\nFiltering Type: `text`\n\n```\nEligible For: \n * atm\n * contactCard\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * restaurant\n```" additionalPromotingLocations: description: "If other locations are promoting this event, a list of those locations' **`id`**s in the Yext Knowledge Manager\n\n\nArray must be ordered.\n\n\nFiltering Type: `list of entityId`\n\n```\nEligible For: \n * event\n```" 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`.\n\nFiltering Type: `boolean`\n\n```\nEligible For: \n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * restaurant\n```" admittingHospitals: description: "A list of hospitals where the healthcare professional admits patients\n\n\nArray must be ordered.\n\nArray may have a maximum of 100 elements.\n\nArray item description:\n\n>Cannot Include:\n>* HTML markup\n\nFiltering Type: `list of text`\n\n```\nEligible For: \n * healthcareProfessional\n```" 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.\n\nFiltering Type: `option`\n\n```\nEligible For: \n * hotel\n```" 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\n\nFiltering Type: `object`\n\n```\nEligible For: \n * event\n```" 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.\n\nFiltering Type: `option`\n\n```\nEligible For: \n * hotel\n```" 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.\n\nFiltering Type: `option`\n\n```\nEligible For: \n * hotel\n```" allInclusive: enum: - ALL_INCLUSIVE_RATES_AVAILABLE - ALL_INCLUSIVE_RATES_ONLY - NOT_APPLICABLE type: string description: "Indicates whether the entity offers all-inclusive rates.\n\nFiltering Type: `option`\n\n```\nEligible For: \n * hotel\n```" alternateNames: description: "Other names for your business that you would like us to use when tracking your search performance\n\n\nArray must be ordered.\n\nArray may have a maximum of 3 elements.\n\nArray item description:\n\n>Cannot Include:\n>* HTML markup\n\nFiltering Type: `list of text`\n\n```\nEligible For: \n * atm\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * organization\n * restaurant\n```" 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.\n\nIf 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.\n\nFiltering Type: `text`\n\n```\nEligible For: \n * atm\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * restaurant\n```" alternateWebsites: description: "Other websites for your business that we should search for when tracking your search performance\n\n\nArray must be ordered.\n\nArray may have a maximum of 3 elements.\n\nArray item description:\n\n>Cannot Include:\n>* common domain names, e.g., google.com, youtube.com, etc.\n\nFiltering Type: `list of text`\n\n```\nEligible For: \n * atm\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * organization\n * restaurant\n```" 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\n\nFiltering Type: `text`\n\n```\nEligible For: \n * brand\n * financialProfessional\n * hotel\n * location\n * restaurant\n```" answer: description: "The answer to the frequently asked question represented by this entity\n\n\nCharacter limit: 0 .. 15000\n\nSupported formats include:\n* BOLD\n* ITALICS\n* UNDERLINE\n* BULLETED_LIST\n* NUMBERED_LIST\n* HYPERLINK\n* IMAGE\n* CODE_SPAN\n* HEADINGS\n\n```\nEligible For: \n * faq\n```" type: string format: rich-text appleActionLinks: description: "Use this field to add action links to your Apple Listings.\n\nThe call to action category will be displayed on the action link button.\n\nThe App Store URL should contain a valid link to the landing page of an App in the Apple App Store.\n\nThe Quick Link URL is where a user is taken when an action link is clicked by a user.\n\nThe 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.\n\n\nArray must be ordered.\n\n\nFiltering Type: `list of object`\n\n```\nEligible For: \n * atm\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * restaurant\n```" 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\n\nFiltering Type: `text`\n\n```\nEligible For: \n * atm\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * restaurant\n```" appleBusinessId: minLength: 0 pattern: ^\d*\.?\d*$ type: string description: "The ID associated with an individual Business Folder in your Apple account\n\nFiltering Type: `text`\n\n```\nEligible For: \n * atm\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * restaurant\n```" appleCompanyId: minLength: 0 pattern: ^\d*\.?\d*$ type: string description: "The ID associated with your Apple account. Numerical values only\n\nFiltering Type: `text`\n\n```\nEligible For: \n * atm\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * restaurant\n```" appleCoverPhoto: required: - url additionalProperties: false type: object description: "The cover photo for the entity''s Apple profile\n\n\nImage must be at least 1600 x 1040 pixels\n\nImage may be no more than 4864 x 3163 pixels\n\nSupported Aspect Ratios:\n* 154 x 100\n\n**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.\n\n\nFiltering Type: `object`\n\n```\nEligible For: \n * atm\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * restaurant\n```" 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.\nNOTE: The names of Brands and their respective Locations within an Apple Business Connect Account must match identically.\nCannot Include:\nHTML markup \n\n\nCannot Include:\n* HTML markup\n\nFiltering Type: `text`\n\n```\nEligible For: \n * atm\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * restaurant\n```" applicationUrl: minLength: 0 format: uri type: string description: "The application URL\n\nFiltering Type: `text`\n\n```\nEligible For: \n * job\n```" associations: description: "Association memberships relevant to the entity (e.g., `\"New York Doctors Association\"`)\nAll strings must be non-empty when trimmed of whitespace.\n\n\n\nArray must be ordered.\n\nArray may have a maximum of 100 elements.\n\nArray item description:\n\n>Cannot Include:\n>* HTML markup\n\nFiltering Type: `list of text`\n\n```\nEligible For: \n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * restaurant\n```" 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.\nA `virtualLocationUrl` must be specified for online and mixed events.\n\nFiltering Type: `object`\n\n```\nEligible For: \n * event\n```" attire: enum: - UNSPECIFIED - DRESSY - CASUAL - FORMAL type: string description: "The formality of clothing typically worn at this restaurant\n\nFiltering Type: `option`\n\n```\nEligible For: \n * restaurant\n```" babysittingOffered: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: "Indicates whether the entity offers babysitting.\n\nFiltering Type: `option`\n\n```\nEligible For: \n * hotel\n```" baggageStorage: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: "Indicates whether the entity offers baggage storage pre check-in and post check-out.\n\nFiltering Type: `option`\n\n```\nEligible For: \n * hotel\n```" bar: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: "Indicates whether the entity has an indoor or outdoor bar onsite.\n\nFiltering Type: `option`\n\n```\nEligible For: \n * hotel\n```" beachAccess: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: "Indicates whether the entity has access to a beach.\n\nFiltering Type: `option`\n\n```\nEligible For: \n * hotel\n```" beachFrontProperty: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: "Indicates whether the entity is physically located next to a beach.\n\nFiltering Type: `option`\n\n```\nEligible For: \n * hotel\n```" bicycles: enum: - BICYCLE_RENTALS - BICYCLE_RENTALS_FOR_FREE - NOT_APPLICABLE type: string description: "Indicates whether the entity offers bicycles for rent or for free.\n\nFiltering Type: `option`\n\n```\nEligible For: \n * hotel\n```" 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\n\nFiltering Type: `object`\n\n```\nEligible For: \n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * organization\n * restaurant\n```" 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.\n\nFiltering Type: `option`\n\n```\nEligible For: \n * hotel\n```" brands: description: "Brands sold by this entity\nAll strings must be non-empty when trimmed of whitespace.\n\n\n\nArray must be ordered.\n\nArray may have a maximum of 100 elements.\n\nArray item description:\n\n>Cannot Include:\n>* HTML markup\n\nFiltering Type: `list of text`\n\n```\nEligible For: \n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * restaurant\n```" 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.\n\nFiltering Type: `option`\n\n```\nEligible For: \n * hotel\n```" 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.\n\nEach 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.\nSimilarly, holiday brunch hours are represented by the `holidayHours` sub-field.\nSetting the `reopenDate` sub-field indicates that the business is temporarily closed and will reopen on the specified date.\nSPECIAL CASES:\n* 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.\n* 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.\n* If you are providing `openIntervals`, you may not set `isClosed` to true for that day.\n\nFiltering Type: `hours`\n\n```\nEligible For: \n * hotel\n * location\n * restaurant\n```" businessCenter: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: "Indicates whether the entity has a business center.\n\nFiltering Type: `option`\n\n```\nEligible For: \n * hotel\n```" 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\n\nFiltering Type: `object`\n\n```\nEligible For: \n * financialProfessional\n * healthcareFacility\n * hotel\n * location\n * restaurant\n```" carRental: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: "Indicates whether the entity offers car rental.\n\nFiltering Type: `option`\n\n```\nEligible For: \n * hotel\n```" casino: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: "Indicates whether the entity has a casino on premise or nearby.\n\nFiltering Type: `option`\n\n```\nEligible For: \n * hotel\n```" categories: additionalProperties: false type: object properties: {} description: "Yext Categories. (Supported for versions > 20240220)\n\nA map of category list external IDs (i.e. \"yext\") to a list of category IDs.\n\nIDs must be valid and selectable (i.e., cannot be parent categories).\n\nPartial updates are accepted, meaning sending only the \"yext\" property will have no effect on any category list except the \"yext\" category. \n\nFiltering Type: `object`\n\n```\nEligible For: \n * atm\n * event\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * restaurant\n```" categoryIds: uniqueItems: false type: array items: minLength: 0 type: string description: 'Filtering Type: `text`' description: "Yext Category IDs. (Deprecated: For versions > 20240220)\n\nIDs must be valid and selectable (i.e., cannot be parent categories).\n\nNOTE: 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.\n\n\nFiltering Type: `list of text`\n\n```\nEligible For: \n * atm\n * event\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * restaurant\n```" catsAllowed: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: "Indicates if the entity is cat friendly.\n\nFiltering Type: `option`\n\n```\nEligible For: \n * hotel\n```" certifications: description: "A list of the certifications held by the healthcare professional\n**NOTE:** This field is only available to locations whose **`entityType`** is `healthcareProfessional`.\n\n\n\nArray must be ordered.\n\nArray may have a maximum of 100 elements.\n\nArray item description:\n\n>Cannot Include:\n>* HTML markup\n\nFiltering Type: `list of text`\n\n```\nEligible For: \n * financialProfessional\n * healthcareProfessional\n```" 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\n\nFiltering Type: `time`\n\n```\nEligible For: \n * hotel\n```" checkOutTime: format: time type: string description: "The check-out time\n\nFiltering Type: `time`\n\n```\nEligible For: \n * hotel\n```" classificationRating: pattern: ^\d*\.?\d*$ type: string description: "The 1 to 5 star rating of the entitiy based on its services and facilities.\n\nFiltering Type: `decimal`\n\n```\nEligible For: \n * hotel\n```" closed: type: boolean description: "Indicates whether the entity is closed\n\nFiltering Type: `boolean`\n\n```\nEligible For: \n * atm\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * restaurant\n```" concierge: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: "Indicates whether the entity offers concierge service.\n\nFiltering Type: `option`\n\n```\nEligible For: \n * hotel\n```" conditionsTreated: description: "A list of the conditions treated by the healthcare provider\n\n\nArray must be ordered.\n\nArray may have a maximum of 100 elements.\n\nArray item description:\n\n>Cannot Include:\n>* HTML markup\n\nFiltering Type: `list of text`\n\n```\nEligible For: \n * healthcareFacility\n * healthcareProfessional\n```" 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.\n\nFiltering Type: `option`\n\n```\nEligible For: \n * hotel\n```" covidMessaging: minLength: 0 maxLength: 15000 type: string description: "Information or messaging related to COVID-19.\n\nFiltering Type: `text`\n\n```\nEligible For: \n * healthcareFacility\n * healthcareProfessional\n * location\n```" covidTestAppointmentUrl: minLength: 0 format: uri type: string description: "An appointment URL for scheduling a COVID-19 test.\n\nFiltering Type: `text`\n\n```\nEligible For: \n * healthcareFacility\n * location\n```" covidTestingAppointmentRequired: type: boolean description: "Indicates whether an appointment is required for a COVID-19 test.\n\nFiltering Type: `boolean`\n\n```\nEligible For: \n * healthcareFacility\n * location\n```" covidTestingDriveThroughSite: type: boolean description: "Indicates whether location is a drive-through site for COVID-19 tests.\n\nFiltering Type: `boolean`\n\n```\nEligible For: \n * healthcareFacility\n * location\n```" covidTestingIsFree: type: boolean description: "Indicates whether location offers free COVID-19 testing.\n\nFiltering Type: `boolean`\n\n```\nEligible For: \n * healthcareFacility\n * location\n```" covidTestingPatientRestrictions: type: boolean description: "Indicates whether there are patient restrictions for COVID-19 testing.\n\nFiltering Type: `boolean`\n\n```\nEligible For: \n * healthcareFacility\n * location\n```" covidTestingReferralRequired: type: boolean description: "Indicates whether a referral is required for COVID-19 testing.\n\nFiltering Type: `boolean`\n\n```\nEligible For: \n * healthcareFacility\n * location\n```" covidTestingSiteInstructions: minLength: 0 maxLength: 15000 type: string description: "Information or instructions for the COVID-19 testing site.\n\nFiltering Type: `text`\n\n```\nEligible For: \n * healthcareFacility\n * location\n```" covidVaccineAppointmentRequired: type: boolean description: "Indicates whether an appointment is required for a COVID-19 vaccine.\n\nFiltering Type: `boolean`\n\n```\nEligible For: \n * healthcareFacility\n * location\n```" covidVaccineDriveThroughSite: type: boolean description: "Indicates whether location is a drive-through site for COVID-19 vaccines.\n\nFiltering Type: `boolean`\n\n```\nEligible For: \n * healthcareFacility\n * location\n```" covidVaccineInformationUrl: minLength: 0 format: uri type: string description: "An information URL for more information about COVID-19 vaccines.\n\nFiltering Type: `text`\n\n```\nEligible For: \n * healthcareFacility\n * location\n```" covidVaccinePatientRestrictions: type: boolean description: "Indicates whether there are patient restrictions for a COVID-19 vaccine.\n\nFiltering Type: `boolean`\n\n```\nEligible For: \n * healthcareFacility\n * location\n```" covidVaccineReferralRequired: type: boolean description: "Indicates whether a referral is required for a COVID-19 vaccine.\n\nFiltering Type: `boolean`\n\n```\nEligible For: \n * healthcareFacility\n * location\n```" covidVaccineSiteInstructions: minLength: 0 maxLength: 15000 type: string description: "Information or instructions for the COVID-19 vaccination site.\n\nFiltering Type: `text`\n\n```\nEligible For: \n * healthcareFacility\n * location\n```" 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.\n\nFiltering Type: `list of option`\n\n```\nEligible For: \n * healthcareFacility\n * location\n```" currencyExchange: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: "Indicates whether the entity offers currency exchange services.\n\nFiltering Type: `option`\n\n```\nEligible For: \n * hotel\n```" customKeywords: description: "Additional keywords you would like us to use when tracking your search performance\n\n\nArray must be ordered.\n\nArray may have a maximum of 5 elements.\n\n\nFiltering Type: `list of text`\n\n```\nEligible For: \n * atm\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * organization\n * restaurant\n```" 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\n\nFiltering Type: `date`\n\n```\nEligible For: \n * job\n```" degrees: description: "A list of the degrees earned by the healthcare professional\n\n\nArray must be ordered.\n\n\nFiltering Type: `list of option`\n\n```\nEligible For: \n * healthcareProfessional\n```" 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.\n\nEach 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.\nSimilarly, holiday delivery hours are represented by the `holidayHours` sub-field.\nSetting the `reopenDate` sub-field indicates that the business is temporarily closed and will reopen on the specified date.\nSPECIAL CASES:\n* 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.\n* 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.\n* If you are providing `openIntervals`, you may not set `isClosed` to true for that day.\n\nFiltering Type: `hours`\n\n```\nEligible For: \n * location\n * restaurant\n```" description: minLength: 10 maxLength: 15000 type: string description: "A description of the entity\n\n\nCannot Include:\n* HTML markup\n\nFiltering Type: `text`\n\n```\nEligible For: \n * atm\n * contactCard\n * event\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * job\n * location\n * organization\n * restaurant\n```" 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\n\nFiltering Type: `object`\n\n```\nEligible For: \n * atm\n * event\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * job\n * location\n * restaurant\n```" doctorOnCall: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: "Indicates whether the entity has a doctor on premise or on call.\n\nFiltering Type: `option`\n\n```\nEligible For: \n * hotel\n```" dogsAllowed: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: "Indicates if the entity is dog friendly.\n\nFiltering Type: `option`\n\n```\nEligible For: \n * hotel\n```" 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.\n\nEach 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.\nSimilarly, holiday drive-through hours are represented by the `holidayHours` sub-field.\nSetting the `reopenDate` sub-field indicates that the business is temporarily closed and will reopen on the specified date.\nSPECIAL CASES:\n* 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.\n* 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.\n* If you are providing `openIntervals`, you may not set `isClosed` to true for that day.\n\nFiltering Type: `hours`\n\n```\nEligible For: \n * atm\n * location\n * restaurant\n```" 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\n\nFiltering Type: `object`\n\n```\nEligible For: \n * atm\n * event\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * restaurant\n```" educationList: description: "Information about the education or training completed by the healthcare professional\n\n\nArray must be ordered.\n\n\nFiltering Type: `list of object`\n\n```\nEligible For: \n * healthcareProfessional\n```" 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.\n\nFiltering Type: `option`\n\n```\nEligible For: \n * hotel\n```" elevator: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: "Indicates whether the entity has an elevator.\n\nFiltering Type: `option`\n\n```\nEligible For: \n * hotel\n```" ellipticalMachine: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: "Indicates whether the entity has an elliptical machine.\n\nFiltering Type: `option`\n\n```\nEligible For: \n * hotel\n```" emails: description: "Emails addresses for this entity's point of contact\n\nMust be valid email addresses\n\n\n\nArray must be ordered.\n\nArray may have a maximum of 5 elements.\n\n\nFiltering Type: `list of text`\n\n```\nEligible For: \n * contactCard\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * organization\n * restaurant\n```" 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.\n\nFiltering Type: `option`\n\n```\nEligible For: \n * job\n```" eventStatus: enum: - SCHEDULED - RESCHEDULED - POSTPONED - CANCELED - EVENT_MOVED_ONLINE type: string description: "Information on whether the event will take place as scheduled\n\nFiltering Type: `option`\n\n```\nEligible For: \n * event\n```" facebookAbout: minLength: 0 maxLength: 255 type: string description: "A description of the entity to be used in the \"About You\" section on Facebook\n\nFiltering Type: `text`\n\n```\nEligible For: \n * atm\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * restaurant\n```" 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\n\nValid contents of **`value`** depends on the Call-to-Action's **`type`**:\n* `NONE`: (optional)\n* `BOOK_NOW`: URL\n* `CALL_NOW`: Phone number\n* `CONTACT_US`: URL\n* `SEND_MESSAGE`: Any string\n* `USE_APP`: URL\n* `PLAY_GAME`: URL\n* `SHOP_NOW`: URL\n* `SIGN_UP`: URL\n* `WATCH_VIDEO`: URL\n* `SEND_EMAIL`: Email address\n* `LEARN_MORE`: URL\n* `PURCHASE_GIFT_CARDS`: URL\n* `ORDER_NOW`: URL\n* `FOLLOW_PAGE`: Any string\n\nFiltering Type: `object`\n\n```\nEligible For: \n * atm\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * restaurant\n```" facebookCoverPhoto: required: - url additionalProperties: false type: object description: "The cover photo for the entity's Facebook profile\n\nDisplayed as a 851 x 315 pixel image\n\nYou may need a cover photo in order for your listing to appear on Facebook. Please check your listings tab to learn more.\n\n\nImage must be at least 400 x 150 pixels\n\nImage area (width x height) may be no more than 41000000 pixels\n\nImage may be no more than 30000 x 30000 pixels\n\nSupported Aspect Ratios:\n* 1 x 1\n* 4 x 3\n* 3 x 2\n* 5 x 3\n* 16 x 9\n* 3 x 1\n* 2 x 3\n* 5 x 7\n* 4 x 5\n* 4 x 1\n\n**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.\n\n\nFiltering Type: `object`\n\n```\nEligible For: \n * atm\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * restaurant\n```" 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.\n\n\nCannot Include:\n* HTML markup\n\nFiltering Type: `text`\n\n```\nEligible For: \n * atm\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * restaurant\n```" 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.\n\nFiltering Type: `text`\n\n```\nEligible For: \n * atm\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * restaurant\n```" facebookOverrideCity: minLength: 0 type: string description: "The city to be displayed on this entity's Facebook profile\n\nFiltering Type: `text`\n\n```\nEligible For: \n * atm\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * restaurant\n```" facebookPageUrl: minLength: 0 type: string description: "URL for the entity's Facebook Page.\n\nValid formats:\n\n- facebook.com/profile.php?id=[numId]\n- facebook.com/group.php?gid=[numId]\n- facebook.com/groups/[numId]\n- facebook.com/[Name]\n- facebook.com/pages/[Name]/[numId]\n- facebook.com/people/[Name]/[numId]\n\nwhere [Name] is a String and [numId] is an Integer\nThe success response will contain a warning message explaining why the URL wasn't stored in the system.\n\nFiltering Type: `text`\n\n```\nEligible For: \n * atm\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * organization\n * restaurant\n```" 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\n\nFiltering Type: `text`\n\n```\nEligible For: \n * atm\n * brand\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * restaurant\n```" facebookProfilePhoto: required: - url additionalProperties: false type: object description: "The profile picture for the entity's Facebook profile\n\nYou must have a profile picture in order for your listing to appear on Facebook.\n\n\nImage must be at least 180 x 180 pixels\n\nImage area (width x height) may be no more than 41000000 pixels\n\nImage may be no more than 30000 x 30000 pixels\n\nSupported Aspect Ratios:\n* 1 x 1\n* 4 x 3\n* 3 x 2\n* 5 x 3\n* 16 x 9\n* 3 x 1\n* 2 x 3\n* 5 x 7\n* 4 x 5\n* 4 x 1\n\n**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.\n\n\nFiltering Type: `object`\n\n```\nEligible For: \n * atm\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * restaurant\n```" 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\n\nFiltering Type: `text`\n\n```\nEligible For: \n * atm\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * restaurant\n```" 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.\n\nFiltering Type: `text`\n\n```\nEligible For: \n * atm\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * restaurant\n```" 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).\n\nFiltering Type: `text`\n\n```\nEligible For: \n * atm\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * restaurant\n```" fax: minLength: 0 type: string description: "Must be a valid fax number.\n\nIf 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.\n\nFiltering Type: `text`\n\n```\nEligible For: \n * atm\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * restaurant\n```" 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\n\nFiltering Type: `object`\n\n```\nEligible For: \n * atm\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * restaurant\n```" firstName: minLength: 0 maxLength: 35 type: string description: "The first name of the healthcare professional\n\n\nCannot Include:\n* a URL or domain name\n* HTML markup\n\nFiltering Type: `text`\n\n```\nEligible For: \n * healthcareProfessional\n```" firstPartyReviewPage: minLength: 0 type: string description: "Link to the review-collection page, where consumers can leave first-party reviews\n\n```\nEligible For: \n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * restaurant\n```" fitnessCenter: enum: - FITNESS_CENTER_AVAILABLE - FITNESS_CENTER_AVAILABLE_FOR_FREE - NOT_APPLICABLE type: string description: "Indicates whether the entity has a fitness center.\n\nFiltering Type: `option`\n\n```\nEligible For: \n * hotel\n```" floorCount: multipleOf: 1 minimum: 0 type: number description: "The number of floors the entity has from ground floor to top floor.\n\nFiltering Type: `integer`\n\n```\nEligible For: \n * hotel\n```" freeWeights: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: "Indicates whether the entity has free weights.\n\nFiltering Type: `option`\n\n```\nEligible For: \n * hotel\n```" frequentlyAskedQuestions: description: "A list of questions that are frequently asked about this entity\n\n\nArray must be ordered.\n\nArray may have a maximum of 100 elements.\n\n\nFiltering Type: `list of object`\n\n```\nEligible For: \n * atm\n * event\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * restaurant\n```" 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.\n\nFiltering Type: `option`\n\n```\nEligible For: \n * hotel\n```" fullyVaccinatedStaff: type: boolean description: "Indicates whether the staff is vaccinated against COVID-19.\n\nFiltering Type: `boolean`\n\n```\nEligible For: \n * healthcareFacility\n * hotel\n * location\n * restaurant\n```" gameRoom: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: "Indicates whether the entity has a game room.\n\nFiltering Type: `option`\n\n```\nEligible For: \n * hotel\n```" gender: enum: - UNSPECIFIED - FEMALE - MALE - NONBINARY - TRANSGENDER_FEMALE - TRANSGENDER_MALE - OTHER - PREFER_NOT_TO_DISCLOSE type: string description: "The gender of the healthcare professional\n\nFiltering Type: `option`\n\n```\nEligible For: \n * healthcareProfessional\n```" geomodifier: minLength: 0 type: string description: "Provides additional information on where the entity can be found (e.g., `Times Square`, `Global Center Mall`)\n\nFiltering Type: `text`\n\n```\nEligible For: \n * atm\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * restaurant\n```" giftShop: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: "Indicates whether the entity has a gift shop.\n\nFiltering Type: `option`\n\n```\nEligible For: \n * hotel\n```" 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.\n\nFiltering Type: `option`\n\n```\nEligible For: \n * hotel\n```" 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.\n\nValid 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.\n\nKeyword 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`).\n\n* 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\" ] }]`)\n* 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\" ]}`)\n\n**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.\n\nFiltering Type: `object`\n\n```\nEligible For: \n * atm\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * restaurant\n```" googleCoverPhoto: required: - url additionalProperties: false type: object description: "The cover photo for the entity's Google profile\n\n\nImage must be at least 250 x 250 pixels\n\n\nFiltering Type: `object`\n\n```\nEligible For: \n * atm\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * restaurant\n```" 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.\nMust be a valid phone number.\nIf 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. \n\nFiltering 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.\n\nNOTE: 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.\n\nFiltering Type: `object`\n\n```\nEligible For: \n * atm\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * restaurant\n```" googleMyBusinessLabels: description: "Google Business Profile Labels help users organize their locations into groups within GBP.\n\n\nArray must be ordered.\n\nArray may have a maximum of 10 elements.\n\nArray item description:\n\n>Cannot Include:\n>* HTML markup\n\nFiltering Type: `list of text`\n\n```\nEligible For: \n * atm\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * restaurant\n```" 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.\n\nFiltering Type: `text`\n\n```\nEligible For: \n * atm\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * restaurant\n```" googleProfilePhoto: required: - url additionalProperties: false type: object description: "The profile photo for the entity's Google profile\n\n\nImage must be at least 250 x 250 pixels\n\nImage may be no more than 5000 x 5000 pixels\n\nSupported Aspect Ratios:\n* 1 x 1\n\n**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.\n\n\nFiltering Type: `object`\n\n```\nEligible For: \n * atm\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * restaurant\n```" 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).\n\nFor 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.\n\nFiltering Type: `text`\n\n```\nEligible For: \n * atm\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * restaurant\n```" 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.\n\nEach 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.\nSimilarly, holiday happy hours are represented by the `holidayHours` sub-field.\nSetting the `reopenDate` sub-field indicates that the business is temporarily closed and will reopen on the specified date.\nSPECIAL CASES:\n* 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.\n* 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.\n* If you are providing `openIntervals`, you may not set `isClosed` to true for that day.\n\nFiltering Type: `hours`\n\n```\nEligible For: \n * hotel\n * location\n * restaurant\n```" headshot: required: - url additionalProperties: false type: object description: "A portrait of the healthcare professional\n\nFiltering Type: `object`\n\n```\nEligible For: \n * contactCard\n * financialProfessional\n * healthcareProfessional\n```" 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\n\nFiltering Type: `text`\n\n```\nEligible For: \n * job\n```" holidayHoursConversationEnabled: type: boolean description: "Indicates whether holiday-hour confirmation alerts are enabled for the Yext Knowledge Assistant for this entity\n\nFiltering Type: `boolean`\n\n```\nEligible For: \n * atm\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * restaurant\n```" horsebackRiding: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: "Indicates whether the entity offers horseback riding.\n\nFiltering Type: `option`\n\n```\nEligible For: \n * hotel\n```" hotTub: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: "Indicates whether the entity has a hot tub.\n\nFiltering Type: `option`\n\n```\nEligible For: \n * hotel\n```" 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.\n\nEach 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.\nSimilarly, holiday hours are represented by the `holidayHours` sub-field.\nSetting the `reopenDate` sub-field indicates that the business is temporarily closed and will reopen on the specified date.\nSPECIAL CASES:\n* 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.\n* 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.\n* If you are providing `openIntervals`, you may not set `isClosed` to true for that day.\n\nFiltering Type: `hours`\n\n```\nEligible For: \n * atm\n * contactCard\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * restaurant\n```" housekeeping: enum: - HOUSEKEEPING_AVAILABLE - HOUSEKEEPING_AVAILABLE_DAILY - NOT_APPLICABLE type: string description: "Indicates whether the entity offers housekeeping services.\n\nFiltering Type: `option`\n\n```\nEligible For: \n * hotel\n```" 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.\n\nFiltering Type: `text`\n\n```\nEligible For: \n * atm\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * restaurant\n```" indoorPoolCount: multipleOf: 1 minimum: 0 type: number description: "A count of the number of indoor pools\n\nFiltering Type: `integer`\n\n```\nEligible For: \n * hotel\n```" instagramHandle: minLength: 0 maxLength: 30 type: string description: "Valid Instagram username for the entity without the leading \"@\" (e.g., `NewCityAuto`)\n\nFiltering Type: `text`\n\n```\nEligible For: \n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * organization\n * restaurant\n```" insuranceAccepted: description: "A list of insurance policies accepted by the healthcare provider\n\n\nArray must be ordered.\n\nArray may have a maximum of 100 elements.\n\nArray item description:\n\n>Cannot Include:\n>* HTML markup\n\nFiltering Type: `list of text`\n\n```\nEligible For: \n * healthcareFacility\n * healthcareProfessional\n```" 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\n\nFiltering Type: `text`\n\n```\nEligible For: \n * brand\n * financialProfessional\n * hotel\n * location\n * restaurant\n```" isClusterPrimary: type: boolean description: "Indicates whether the healthcare entity is the primary entity in its group\n\nFiltering Type: `boolean`\n\n```\nEligible For: \n * healthcareProfessional\n```" isFreeEvent: type: boolean description: "Indicates whether or not the event is free\n\nFiltering Type: `boolean`\n\n```\nEligible For: \n * event\n```" isoRegionCode: minLength: 0 type: string description: "The ISO 3166-2 region code for the entity\n\nYext 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.\n\nFiltering Type: `text`\n\n```\nEligible For: \n * atm\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * restaurant\n```" keywords: description: "Keywords that describe the entity.\n\nAll strings must be non-empty when trimmed of whitespace.\n\n\n\nArray must be ordered.\n\nArray may have a maximum of 100 elements.\n\nArray item description:\n\n>Cannot Include:\n>* HTML markup\n\nFiltering Type: `list of text`\n\n```\nEligible For: \n * atm\n * card\n * event\n * faq\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * helpArticle\n * hotel\n * job\n * location\n * product\n * restaurant\n```" 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.\n\nFiltering Type: `option`\n\n```\nEligible For: \n * hotel\n```" kidsClub: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: "Indicates if the property has a Kids Club.\n\nFiltering Type: `option`\n\n```\nEligible For: \n * hotel\n```" kidsStayFree: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: "Indicates whether the entity allows kids to stay free.\n\nFiltering Type: `option`\n\n```\nEligible For: \n * hotel\n```" 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.\n\nEach 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.\nSimilarly, holiday kitchen hours are represented by the `holidayHours` sub-field.\nSetting the `reopenDate` sub-field indicates that the business is temporarily closed and will reopen on the specified date.\nSPECIAL CASES:\n* 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.\n* 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.\n* If you are providing `openIntervals`, you may not set `isClosed` to true for that day.\n\nFiltering Type: `hours`\n\n```\nEligible For: \n * hotel\n * location\n * restaurant\n```" 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.\n\n**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.\n\nFiltering Type: `opaque`\n\n```\nEligible For: \n * atm\n * board\n * brand\n * card\n * contactCard\n * event\n * faq\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * helpArticle\n * hotel\n * hotelRoomType\n * job\n * location\n * organization\n * product\n * restaurant\n```" landingPageUrl: minLength: 0 format: uri type: string description: "The URL of this entity's Landing Page that was created with Yext Pages\n\nFiltering Type: `text`\n\n```\nEligible For: \n * atm\n * card\n * event\n * faq\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * helpArticle\n * hotel\n * job\n * location\n * product\n * restaurant\n```" languages: description: "The langauges in which consumers can commicate with this entity or its staff members\nAll strings must be non-empty when trimmed of whitespace.\n\n\n\nArray must be ordered.\n\nArray may have a maximum of 100 elements.\n\nArray item description:\n\n>Cannot Include:\n>* HTML markup\n\nFiltering Type: `list of text`\n\n```\nEligible For: \n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * restaurant\n```" 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\n\n\nCannot Include:\n* a URL or domain name\n* HTML markup\n\nFiltering Type: `text`\n\n```\nEligible For: \n * healthcareProfessional\n```" laundry: enum: - FULL_SERVICE - SELF_SERVICE - NOT_APPLICABLE type: string description: "Indicates whether the entity offers laundry services.\n\nFiltering Type: `option`\n\n```\nEligible For: \n * hotel\n```" lazyRiver: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: "Indicates if the property has a lazy river\n\nFiltering Type: `option`\n\n```\nEligible For: \n * hotel\n```" lifeguard: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: "Indicates if the property has a lifeguard on duty\n\nFiltering Type: `option`\n\n```\nEligible For: \n * hotel\n```" linkedInUrl: minLength: 0 format: uri type: string description: "URL for your LinkedIn account, format should be https://www.linkedin.com/in/yourUsername\n\nFiltering Type: `text`\n\n```\nEligible For: \n * contactCard\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * organization\n * restaurant\n```" linkedLocation: type: string description: "location ID of the event location, if the event is held at a location managed in the Yext Knowledge Manager\n\nFiltering Type: `entityId`\n\n```\nEligible For: \n * contactCard\n * event\n```" 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.\n\nFiltering Type: `text`\n\n```\nEligible For: \n * atm\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * restaurant\n```" localShuttle: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: "Indicates whether the entity offers local shuttle services.\n\nFiltering Type: `option`\n\n```\nEligible For: \n * hotel\n```" 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.\n\nFiltering Type: `entityId`\n\n```\nEligible For: \n * atm\n```" 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\n\nFiltering Type: `object`\n\n```\nEligible For: \n * job\n```" locationType: enum: - LOCATION - HEALTHCARE_FACILITY - HEALTHCARE_PROFESSIONAL - ATM - RESTAURANT - HOTEL type: string description: "Indicates the entity's type, if it is not an event\n\nFiltering Type: `option`\n\n```\nEligible For: \n * atm\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * restaurant\n```" logo: required: - image additionalProperties: false type: object description: "An image of the entity's logo\n\n\nSupported Aspect Ratios:\n* 1 x 1\n\n**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.\n\n\nFiltering Type: `object`\n\n```\nEligible For: \n * atm\n * contactCard\n * faq\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * job\n * location\n * organization\n * restaurant\n```" 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\n\nMust be a valid phone number.\n\nIf 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.\n\nFiltering Type: `text`\n\n```\nEligible For: \n * atm\n * contactCard\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * organization\n * restaurant\n```" massage: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: "Indicates whether the entity offers massage services.\n\nFiltering Type: `option`\n\n```\nEligible For: \n * hotel\n```" 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\n\nFiltering Type: `integer`\n\n```\nEligible For: \n * hotel\n```" 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\n\nFiltering Type: `integer`\n\n```\nEligible For: \n * hotel\n```" 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\n\nFiltering Type: `list of option`\n\n```\nEligible For: \n * restaurant\n```" meetingRoomCount: multipleOf: 1 minimum: 0 type: number description: "The number of meeting rooms the entity has.\n\nFiltering Type: `integer`\n\n```\nEligible For: \n * hotel\n```" 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\n\nFiltering Type: `object`\n\n```\nEligible For: \n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * restaurant\n```" 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\n\nFiltering Type: `object`\n\n```\nEligible For: \n * hotel\n * location\n * restaurant\n```" middleName: minLength: 0 maxLength: 35 type: string description: "The middle name of the healthcare professional\n\n\nCannot Include:\n* a URL or domain name\n* HTML markup\n\nFiltering Type: `text`\n\n```\nEligible For: \n * healthcareProfessional\n```" mobilePhone: minLength: 0 type: string description: "Must be a valid phone number.\n\nIf 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.\n\nFiltering Type: `text`\n\n```\nEligible For: \n * atm\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * restaurant\n```" mobilityAccessible: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: "Indicates whether the entity is mobility/wheelchair accessible\n\nFiltering Type: `option`\n\n```\nEligible For: \n * hotel\n```" nightclub: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: "Indicates whether the entity has a nightclub.\n\nFiltering Type: `option`\n\n```\nEligible For: \n * hotel\n```" npi: minLength: 0 type: string description: "The National Provider Identifier (NPI) of the healthcare provider\n\nFiltering Type: `text`\n\n```\nEligible For: \n * healthcareFacility\n * healthcareProfessional\n```" nudgeEnabled: type: boolean description: "Indicates whether Knowledge Nudge is enabled for the Yext Knowledge Assistant for this entity\n\nFiltering Type: `boolean`\n\n```\nEligible For: \n * atm\n * faq\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * helpArticle\n * hotel\n * job\n * location\n * organization\n * product\n * restaurant\n```" officeName: minLength: 0 type: string description: "The name of the office where the healthcare professional works, if different from **`name`**\n\nFiltering Type: `text`\n\n```\nEligible For: \n * healthcareProfessional\n```" 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.\n\nEach 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.\nSimilarly, holiday online service hours are represented by the `holidayHours` sub-field.\nSetting the `reopenDate` sub-field indicates that the business is temporarily closed and will reopen on the specified date.\nSPECIAL CASES:\n* 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.\n* 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.\n* If you are providing `openIntervals`, you may not set `isClosed` to true for that day.\n\nFiltering Type: `hours`\n\n```\nEligible For: \n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * location\n * restaurant\n```" openDate: format: date type: string description: "The date that the entity is set to open for the first time.\nMust be formatted in YYYY-MM-DD format.\n\nDate must be on or after 1970-01-01 Date must be before or on 2038-01-01\n\n\nFiltering Type: `date`\n\n```\nEligible For: \n * atm\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * restaurant\n```" 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\n\nFiltering Type: `list of option`\n\n```\nEligible For: \n * organization\n```" 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\n\nFiltering Type: `object`\n\n```\nEligible For: \n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * restaurant\n```" organizerEmail: minLength: 0 format: email type: string description: "Point of contact for the event organizer (not to be published publicly)\n\nFiltering Type: `text`\n\n```\nEligible For: \n * event\n```" organizerName: minLength: 0 type: string description: "Point of contact for the event organizer (not to be published publicly)\n\nFiltering Type: `text`\n\n```\nEligible For: \n * event\n```" organizerPhone: minLength: 0 type: string description: "Point of contact for the event organizer (not to be published publicly)\n\nFiltering Type: `text`\n\n```\nEligible For: \n * event\n```" outdoorPoolCount: multipleOf: 1 minimum: 0 type: number description: "The number of outdoor pools the entity has.\n\nFiltering Type: `integer`\n\n```\nEligible For: \n * hotel\n```" parking: enum: - PARKING_AVAILABLE - PARKING_AVAILABLE_FOR_FREE - NOT_APPLICABLE type: string description: "Indicates whether the entity offers parking services.\n\nFiltering Type: `option`\n\n```\nEligible For: \n * hotel\n```" 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\n\nValid elements depend on the entity's country.\n\n\nFiltering Type: `list of option`\n\n```\nEligible For: \n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * restaurant\n```" performers: description: "Performers at the event\n\n\nArray must be ordered.\n\nArray may have a maximum of 100 elements.\n\n\nFiltering Type: `list of text`\n\n```\nEligible For: \n * event\n```" 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.\n\nFiltering Type: `option`\n\n```\nEligible For: \n * hotel\n```" photoGallery: description: "\n**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.\n\n\n\nArray must be ordered.\n\nArray may have a maximum of 500 elements.\n\nArray item description:\n\n>Supported Aspect Ratios:\n>* 1 x 1\n>* 4 x 3\n>* 3 x 2\n>* 5 x 3\n>* 16 x 9\n>* 3 x 1\n>* 2 x 3\n>* 5 x 7\n>* 4 x 5\n>* 4 x 1\n>\n>**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.\n>\n\nFiltering Type: `list of object`\n\n```\nEligible For: \n * atm\n * event\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * hotelRoomType\n * location\n * organization\n * product\n * restaurant\n```" 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\n\nFiltering Type: `object`\n\n```\nEligible For: \n * atm\n * event\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * restaurant\n```" 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.\n\nEach 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.\nSimilarly, holiday pickup hours are represented by the `holidayHours` sub-field.\nSetting the `reopenDate` sub-field indicates that the business is temporarily closed and will reopen on the specified date.\nSPECIAL CASES:\n* 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.\n* 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.\n* If you are providing `openIntervals`, you may not set `isClosed` to true for that day.\n\nFiltering Type: `hours`\n\n```\nEligible For: \n * healthcareFacility\n * location\n * restaurant\n```" pinterestUrl: minLength: 0 format: uri type: string description: "URL for your Pinterest account, format should be https://www.pinterest.com/yourUsername\n\nFiltering Type: `text`\n\n```\nEligible For: \n * contactCard\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * organization\n * restaurant\n```" 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)\n\nFiltering Type: `option`\n\n```\nEligible For: \n * atm\n * healthcareFacility\n * healthcareProfessional\n * location\n * restaurant\n```" primaryConversationContact: minLength: 0 type: string description: "ID of the user who is the primary Knowledge Assistant contact for the entity\n\nFiltering Type: `option`\n\n```\nEligible For: \n * atm\n * faq\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * helpArticle\n * hotel\n * job\n * location\n * organization\n * product\n * restaurant\n```" privateBeach: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: "Indicates whether the entity has access to a private beach.\n\nFiltering Type: `option`\n\n```\nEligible For: \n * hotel\n```" privateCarService: enum: - PRIVATE_CAR_SERVICE - PRIVATE_CAR_SERVICE_FOR_FREE - NOT_APPLICABLE type: string description: "Indicates whether the entity offers private car services.\n\nFiltering Type: `option`\n\n```\nEligible For: \n * hotel\n```" 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\n\nFiltering Type: `object`\n\n```\nEligible For: \n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * restaurant\n```" products: description: "Products sold by this entity\n\nAll strings must be non-empty when trimmed of whitespace.\n\n\n\nArray must be ordered.\n\nArray may have a maximum of 100 elements.\n\nArray item description:\n\n>Cannot Include:\n>* HTML markup\n\nFiltering Type: `list of text`\n\n```\nEligible For: \n * financialProfessional\n * location\n```" 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\n\nFiltering Type: `boolean`\n\n```\nEligible For: \n * atm\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * organization\n * restaurant\n```" rankTrackingCompetitors: description: "Information about the competitors whose search performance you would like to compare to your own\n\n\nArray must be ordered.\n\nArray may have a maximum of 5 elements.\n\n\nFiltering Type: `list of object`\n\n```\nEligible For: \n * atm\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * organization\n * restaurant\n```" 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\n\nFiltering Type: `boolean`\n\n```\nEligible For: \n * atm\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * organization\n * restaurant\n```" rankTrackingFrequency: enum: - WEEKLY - MONTHLY - QUARTERLY type: string description: "How often we send search queries to track your search performance\n\nFiltering Type: `option`\n\n```\nEligible For: \n * atm\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * organization\n * restaurant\n```" rankTrackingQueryTemplates: description: "The ways in which your keywords will be arranged in the search queries we use to track your performance\n\n\nArray must have a minimum of 2 elements.\n\nArray may have a maximum of 4 elements.\n\n\nFiltering Type: `list of option`\n\n```\nEligible For: \n * atm\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * organization\n * restaurant\n```" 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\n\nFiltering Type: `list of option`\n\n```\nEligible For: \n * atm\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * organization\n * restaurant\n```" 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\n\nFiltering Type: `object`\n\n```\nEligible For: \n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * restaurant\n```" restaurantCount: multipleOf: 1 minimum: 0 type: number description: "The number of restaurants the entity has.\n\nFiltering Type: `integer`\n\n```\nEligible For: \n * hotel\n```" reviewGenerationUrl: minLength: 0 type: string description: "The URL given Review Invitation emails where consumers can leave a review about the entity\n\n```\nEligible For: \n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * restaurant\n```" reviewResponseConversationEnabled: type: boolean description: "Indicates whether Yext Knowledge Assistant review-response conversations are enabled for this entity\n\nFiltering Type: `boolean`\n\n```\nEligible For: \n * atm\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * restaurant\n```" roomCount: multipleOf: 1 minimum: 0 type: number description: "The number of rooms the entity has.\n\nFiltering Type: `integer`\n\n```\nEligible For: \n * hotel\n```" roomService: enum: - ROOM_SERVICE_AVAILABLE - ROOM_SERVICE_AVAILABLE_24_HOURS - NOT_APPLICABLE type: string description: "Indicates whether the entity offers room service.\n\nFiltering Type: `option`\n\n```\nEligible For: \n * hotel\n```" 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\n\nFiltering Type: `object`\n\n```\nEligible For: \n * atm\n * event\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * restaurant\n```" salon: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: "Indicates whether the entity has a salon.\n\nFiltering Type: `option`\n\n```\nEligible For: \n * hotel\n```" sauna: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: "Indicates whether the entity has a sauna.\n\nFiltering Type: `option`\n\n```\nEligible For: \n * hotel\n```" scuba: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: "Indicates whether the entity offers scuba diving.\n\nFiltering Type: `option`\n\n```\nEligible For: \n * hotel\n```" selfParking: enum: - SELF_PARKING_AVAILABLE - SELF_PARKING_AVAILABLE_FOR_FREE - NOT_APPLICABLE type: string description: "Indicates whether the entity offers self parking services.\n\nFiltering Type: `option`\n\n```\nEligible For: \n * hotel\n```" 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.\n\nEach 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.\nSimilarly, holiday senior hours are represented by the `holidayHours` sub-field.\nSetting the `reopenDate` sub-field indicates that the business is temporarily closed and will reopen on the specified date.\nSPECIAL CASES:\n* 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.\n* 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.\n* If you are providing `openIntervals`, you may not set `isClosed` to true for that day.\n\nFiltering Type: `hours`\n\n```\nEligible For: \n * location\n * restaurant\n```" serviceArea: additionalProperties: false type: object properties: places: description: "A list of places served by the entity, where each place is either:\n - a postal code, or\n - the name of a city.\n\n\n\nArray must be ordered.\n\nArray may have a maximum of 200 elements.\n\n\nFiltering 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.\n\n**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.\n\nFiltering Type: `object`\n\n```\nEligible For: \n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * restaurant\n```" 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.\n**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.\n\n\nArray may have a maximum of 200 elements.\n\n\nFiltering Type: `list of object`\n\n```\nEligible For: \n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * restaurant\n```" 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\n\nAll strings must be non-empty when trimmed of whitespace.\n\n\n\nArray must be ordered.\n\nArray may have a maximum of 100 elements.\n\nArray item description:\n\n>Cannot Include:\n>* HTML markup\n\nFiltering Type: `list of text`\n\n```\nEligible For: \n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * restaurant\n```" 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.\n\nFiltering Type: `option`\n\n```\nEligible For: \n * hotel\n```" snorkeling: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: "Indicates whether the entity offers snorkeling.\n\nFiltering Type: `option`\n\n```\nEligible For: \n * hotel\n```" socialHour: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: "Indicates whether the entity offers a social hour.\n\nFiltering Type: `option`\n\n```\nEligible For: \n * hotel\n```" spa: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: "Indicates whether the entity has a spa.\n\nFiltering Type: `option`\n\n```\nEligible For: \n * hotel\n```" specialities: description: "Up to 100 of this entity's specialities (e.g., for food and dining: `Chicago style`)\n\nAll strings must be non-empty when trimmed of whitespace.\n\n\n\nArray must be ordered.\n\nArray may have a maximum of 100 elements.\n\nArray item description:\n\n>Cannot Include:\n>* HTML markup\n\nFiltering Type: `list of text`\n\n```\nEligible For: \n * financialProfessional\n * location\n * restaurant\n```" 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.\n\nFiltering Type: `option`\n\n```\nEligible For: \n * hotel\n```" 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.\n\nEach 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.\nSimilarly, holiday takeout hours are represented by the `holidayHours` sub-field.\nSetting the `reopenDate` sub-field indicates that the business is temporarily closed and will reopen on the specified date.\nSPECIAL CASES:\n* 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.\n* 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.\n* If you are providing `openIntervals`, you may not set `isClosed` to true for that day.\n\nFiltering Type: `hours`\n\n```\nEligible For: \n * location\n * restaurant\n```" tennis: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: "Indicates whether the entity has tennis courts.\n\nFiltering Type: `option`\n\n```\nEligible For: \n * hotel\n```" thermalPool: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: "Indicates whether the entity has a thermal pool.\n\nFiltering Type: `option`\n\n```\nEligible For: \n * hotel\n```" ticketAvailability: enum: - IN_STOCK - SOLD_OUT - PRE_ORDER - UNSPECIFIED type: string description: "Information about the availability of tickets for the event\n\nFiltering Type: `option`\n\n```\nEligible For: \n * event\n```" 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\n\nFiltering Type: `object`\n\n```\nEligible For: \n * event\n```" ticketSaleDateTime: format: date-time type: string description: "The date/time tickets are available for sale (local time)\n\nFiltering Type: `datetime`\n\n```\nEligible For: \n * event\n```" ticketUrl: minLength: 0 format: uri type: string description: "URL to purchase tickets for the event (if ticketed)\n\nFiltering Type: `text`\n\n```\nEligible For: \n * event\n```" tikTokUrl: minLength: 0 format: uri type: string description: "URL for your TikTok profile, format should be https://www.tiktok.com/yourUsername\n\nFiltering Type: `text`\n\n```\nEligible For: \n * contactCard\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * organization\n * restaurant\n```" 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\n\nFiltering Type: `object`\n\n```\nEligible For: \n * event\n```" timeZoneUtcOffset: minLength: 0 type: string description: "Represents the time zone offset of the entity from UTC, in `±hh:mm` format.\n\nFor example, if the entity is 4 hours ahead of UTC time, the offset will be `+04:00`.\n\nIf the entity is 15.5 hours behind UTC time, the offset will be `-15:30`.\n\nIf the entity is in UTC time, the offset will be `+00:00`.\n\n\n```\nEligible For: \n * atm\n * event\n * faq\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * job\n * location\n * restaurant\n```" 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\"`\n\nFiltering Type: `option`\n\n```\nEligible For: \n * atm\n * board\n * card\n * contactCard\n * event\n * faq\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * helpArticle\n * hotel\n * hotelRoomType\n * job\n * location\n * organization\n * product\n * restaurant\n```" tollFreePhone: minLength: 0 type: string description: "Must be a valid phone number.\n\nIf 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.\n\nFiltering Type: `text`\n\n```\nEligible For: \n * atm\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * restaurant\n```" treadmill: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: "Indicates whether the entity has a treadmill.\n\nFiltering Type: `option`\n\n```\nEligible For: \n * hotel\n```" ttyPhone: minLength: 0 type: string description: "Must be a valid phone number.\n\nIf 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.\n\nFiltering Type: `text`\n\n```\nEligible For: \n * atm\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * restaurant\n```" turndownService: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: "Indicates whether the entity offers turndown service.\n\nFiltering Type: `option`\n\n```\nEligible For: \n * hotel\n```" twitterHandle: minLength: 0 maxLength: 15 type: string description: "Valid Twitter handle for the entity without the leading \"@\" (e.g., `JohnSmith`)\n\nIf 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.\n\nFiltering Type: `text`\n\n```\nEligible For: \n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * organization\n * restaurant\n```" 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\n\nFiltering Type: `object`\n\n```\nEligible For: \n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * restaurant\n```" 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\n\nFiltering Type: `object`\n\n```\nEligible For: \n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * restaurant\n```" valetParking: enum: - VALET_PARKING_AVAILABLE - VALET_PARKING_AVAILABLE_FOR_FREE - NOT_APPLICABLE type: string description: "Indicates whether the entity offers valet parking services.\n\nFiltering Type: `option`\n\n```\nEligible For: \n * hotel\n```" validThrough: format: date-time type: string description: "The date this entity is valid through.\n\nFiltering Type: `datetime`\n\n```\nEligible For: \n * job\n```" vendingMachine: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: "Indicates whether the entity has a vending machine.\n\nFiltering Type: `option`\n\n```\nEligible For: \n * hotel\n```" venueName: minLength: 0 type: string description: "Name of the venue where the event is being held\n\nFiltering Type: `text`\n\n```\nEligible For: \n * event\n```" videos: description: "Valid YouTube URLs for embedding a video on some publisher sites\n\n**NOTE:** Currently, only the first URL in the Array appears in your listings.\n\n\n\nArray must be ordered.\n\n\nFiltering Type: `list of object`\n\n```\nEligible For: \n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * hotelRoomType\n * location\n * organization\n * product\n * restaurant\n```" 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.\n\nFiltering Type: `option`\n\n```\nEligible For: \n * hotel\n```" wakeUpCalls: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: "Indicates whether the entity offers wake up call services.\n\nFiltering Type: `option`\n\n```\nEligible For: \n * hotel\n```" 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\n\nFiltering Type: `object`\n\n```\nEligible For: \n * atm\n * event\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * restaurant\n```" waterPark: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: "Indicates whether the entity has a water park.\n\nFiltering Type: `option`\n\n```\nEligible For: \n * hotel\n```" waterSkiing: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: "Indicates whether the entity offers water skiing.\n\nFiltering Type: `option`\n\n```\nEligible For: \n * hotel\n```" watercraft: enum: - WATERCRAFT_RENTALS - WATERCRAFT_RENTALS_FOR_FREE - NOT_APPLICABLE type: string description: "Indicates whether the entity offers any kind of watercrafts.\n\nFiltering Type: `option`\n\n```\nEligible For: \n * hotel\n```" waterslide: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: "Indicates whether the entity has a water slide.\n\nFiltering Type: `option`\n\n```\nEligible For: \n * hotel\n```" wavePool: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: "Indicates whether the entity has a wave pool.\n\nFiltering Type: `option`\n\n```\nEligible For: \n * hotel\n```" 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\n\nFiltering Type: `object`\n\n```\nEligible For: \n * atm\n * contactCard\n * event\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * organization\n * restaurant\n```" weightMachine: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: "Indicates whether the entity has a weight machine.\n\nFiltering Type: `option`\n\n```\nEligible For: \n * hotel\n```" wheelchairAccessible: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: "Indicates if the entity is wheelchair accessible.\n\nFiltering Type: `option`\n\n```\nEligible For: \n * hotel\n```" wifiAvailable: enum: - WIFI_AVAILABLE - WIFI_AVAILABLE_FOR_FREE - NOT_APPLICABLE type: string description: "Indicates whether the entity has WiFi available\n\nFiltering Type: `option`\n\n```\nEligible For: \n * hotel\n```" workRemote: type: boolean description: "Indicates whether the job is remote.\n\nFiltering Type: `boolean`\n\n```\nEligible For: \n * job\n```" yearEstablished: multipleOf: 1 minimum: 1000 maximum: 2028 type: number description: "The year the entity was established.\n\nFiltering Type: `integer`\n\n```\nEligible For: \n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * restaurant\n```" yearLastRenovated: multipleOf: 1 minimum: 1000 maximum: 2028 type: number description: "The most recent year the entity was partially or completely renovated.\n\nFiltering Type: `integer`\n\n```\nEligible For: \n * hotel\n```" 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\n\nFiltering Type: `object`\n\n```\nEligible For: \n * atm\n * event\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * job\n * location\n * restaurant\n```" 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\n\nFiltering Type: `object`\n\n```\nEligible For: \n * atm\n * event\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * restaurant\n```" 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\n\nFiltering Type: `object`\n\n```\nEligible For: \n * atm\n * event\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * restaurant\n```" 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\n\nFiltering Type: `object`\n\n```\nEligible For: \n * atm\n * event\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * restaurant\n```" 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\n\nFiltering Type: `object`\n\n```\nEligible For: \n * atm\n * event\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * restaurant\n```" youTubeChannelUrl: minLength: 0 format: uri type: string description: "URL for your YouTube channel, format should be https://www.youtube.com/c/yourUsername\n\nFiltering Type: `text`\n\n```\nEligible For: \n * contactCard\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * organization\n * restaurant\n```" headers: Update-Operation-Id: schema: minLength: 0 type: string description: The ID of the operation '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.\n - `false`: **Markdown** fields will be returned as JSON\n - `true`: **Markdown** fields will be returned as HTML\n" name: convertMarkdownToHTML in: query required: false - schema: minLength: 0 type: string description: "Optional parameter to return fields of type **Rich Text** as HTML.\n - `false`: **Rich Text** fields will be returned as JSON\n - `true`: **Rich Text** fields will be returned as HTML\n" 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**.\"\n\nValid values:\n * `markdown`\n * `html`\n * `none`\n" name: format in: query required: false - schema: type: boolean default: 'false' description: "Optional parameter to resolve all embedded fields in a Location object response.\n - `false`: Location object returns placeholder labels, e.g., \"Your [[CITY]] store\"\n - `true`: Location object returns placeholder values, e.g., \"Your Fairfax store\"\n" name: resolvePlaceholders in: query required: false tags: - Knowledge Manager summary: 'Entities: Get' description: 'Retrieve information for an Entity with a given ID **NOTE** * If the **`v`** parameter is `20240221` or later: returned entities replace the **`categoryIds`** field with the **`categories`** field. ' 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.\n\n```\nEligible For: \n * atm\n * event\n * faq\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * job\n * location\n * restaurant\n```" name: minLength: 0 maxLength: 5000 type: string description: "\n\n\nCannot Include:\n* HTML markup\n\nFiltering Type: `text`\n\n```\nEligible For: \n * atm\n * board\n * brand\n * card\n * contactCard\n * event\n * faq\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * helpArticle\n * hotel\n * hotelRoomType\n * job\n * location\n * organization\n * product\n * restaurant\n```" 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)\n\nMust be a valid address\nCannot be a P.O. Box\n\nIf the entity is an `event`, either an **`address`** value or a **`linkedLocation`** value can be provided.\n\nFiltering Type: `object`\n\n```\nEligible For: \n * atm\n * event\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * restaurant\n```" acceptingNewPatients: type: boolean description: "Indicates whether the healthcare provider is accepting new patients.\n\nFiltering Type: `boolean`\n\n```\nEligible For: \n * healthcareFacility\n * healthcareProfessional\n```" acceptsReservations: type: boolean description: "Indicates whether the entity accepts reservations.\n\nFiltering Type: `boolean`\n\n```\nEligible For: \n * restaurant\n```" 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.\n\nEach 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.\nSimilarly, holiday access hours are represented by the `holidayHours` sub-field.\nSetting the `reopenDate` sub-field indicates that the business is temporarily closed and will reopen on the specified date.\nSPECIAL CASES:\n* 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.\n* 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.\n* If you are providing `openIntervals`, you may not set `isClosed` to true for that day.\n\nFiltering Type: `hours`\n\n```\nEligible For: \n * atm\n * healthcareFacility\n * hotel\n * location\n * restaurant\n```" additionalHoursText: minLength: 0 maxLength: 255 type: string description: "Additional information about hours that does not fit in **`hours`** (e.g., `\"Closed during the winter\"`)\n\nFiltering Type: `text`\n\n```\nEligible For: \n * atm\n * contactCard\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * restaurant\n```" additionalPromotingLocations: description: "If other locations are promoting this event, a list of those locations' **`id`**s in the Yext Knowledge Manager\n\n\nArray must be ordered.\n\n\nFiltering Type: `list of entityId`\n\n```\nEligible For: \n * event\n```" 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`.\n\nFiltering Type: `boolean`\n\n```\nEligible For: \n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * restaurant\n```" admittingHospitals: description: "A list of hospitals where the healthcare professional admits patients\n\n\nArray must be ordered.\n\nArray may have a maximum of 100 elements.\n\nArray item description:\n\n>Cannot Include:\n>* HTML markup\n\nFiltering Type: `list of text`\n\n```\nEligible For: \n * healthcareProfessional\n```" 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.\n\nFiltering Type: `option`\n\n```\nEligible For: \n * hotel\n```" 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\n\nFiltering Type: `object`\n\n```\nEligible For: \n * event\n```" 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.\n\nFiltering Type: `option`\n\n```\nEligible For: \n * hotel\n```" 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.\n\nFiltering Type: `option`\n\n```\nEligible For: \n * hotel\n```" allInclusive: enum: - ALL_INCLUSIVE_RATES_AVAILABLE - ALL_INCLUSIVE_RATES_ONLY - NOT_APPLICABLE type: string description: "Indicates whether the entity offers all-inclusive rates.\n\nFiltering Type: `option`\n\n```\nEligible For: \n * hotel\n```" alternateNames: description: "Other names for your business that you would like us to use when tracking your search performance\n\n\nArray must be ordered.\n\nArray may have a maximum of 3 elements.\n\nArray item description:\n\n>Cannot Include:\n>* HTML markup\n\nFiltering Type: `list of text`\n\n```\nEligible For: \n * atm\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * organization\n * restaurant\n```" 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.\n\nIf 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.\n\nFiltering Type: `text`\n\n```\nEligible For: \n * atm\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * restaurant\n```" alternateWebsites: description: "Other websites for your business that we should search for when tracking your search performance\n\n\nArray must be ordered.\n\nArray may have a maximum of 3 elements.\n\nArray item description:\n\n>Cannot Include:\n>* common domain names, e.g., google.com, youtube.com, etc.\n\nFiltering Type: `list of text`\n\n```\nEligible For: \n * atm\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * organization\n * restaurant\n```" 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\n\nFiltering Type: `text`\n\n```\nEligible For: \n * brand\n * financialProfessional\n * hotel\n * location\n * restaurant\n```" answer: description: "The answer to the frequently asked question represented by this entity\n\n\nCharacter limit: 0 .. 15000\n\nSupported formats include:\n* BOLD\n* ITALICS\n* UNDERLINE\n* BULLETED_LIST\n* NUMBERED_LIST\n* HYPERLINK\n* IMAGE\n* CODE_SPAN\n* HEADINGS\n\n```\nEligible For: \n * faq\n```" type: string format: rich-text appleActionLinks: description: "Use this field to add action links to your Apple Listings.\n\nThe call to action category will be displayed on the action link button.\n\nThe App Store URL should contain a valid link to the landing page of an App in the Apple App Store.\n\nThe Quick Link URL is where a user is taken when an action link is clicked by a user.\n\nThe 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.\n\n\nArray must be ordered.\n\n\nFiltering Type: `list of object`\n\n```\nEligible For: \n * atm\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * restaurant\n```" 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\n\nFiltering Type: `text`\n\n```\nEligible For: \n * atm\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * restaurant\n```" appleBusinessId: minLength: 0 pattern: ^\d*\.?\d*$ type: string description: "The ID associated with an individual Business Folder in your Apple account\n\nFiltering Type: `text`\n\n```\nEligible For: \n * atm\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * restaurant\n```" appleCompanyId: minLength: 0 pattern: ^\d*\.?\d*$ type: string description: "The ID associated with your Apple account. Numerical values only\n\nFiltering Type: `text`\n\n```\nEligible For: \n * atm\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * restaurant\n```" appleCoverPhoto: required: - url additionalProperties: false type: object description: "The cover photo for the entity''s Apple profile\n\n\nImage must be at least 1600 x 1040 pixels\n\nImage may be no more than 4864 x 3163 pixels\n\nSupported Aspect Ratios:\n* 154 x 100\n\n**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.\n\n\nFiltering Type: `object`\n\n```\nEligible For: \n * atm\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * restaurant\n```" 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.\nNOTE: The names of Brands and their respective Locations within an Apple Business Connect Account must match identically.\nCannot Include:\nHTML markup \n\n\nCannot Include:\n* HTML markup\n\nFiltering Type: `text`\n\n```\nEligible For: \n * atm\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * restaurant\n```" applicationUrl: minLength: 0 format: uri type: string description: "The application URL\n\nFiltering Type: `text`\n\n```\nEligible For: \n * job\n```" associations: description: "Association memberships relevant to the entity (e.g., `\"New York Doctors Association\"`)\nAll strings must be non-empty when trimmed of whitespace.\n\n\n\nArray must be ordered.\n\nArray may have a maximum of 100 elements.\n\nArray item description:\n\n>Cannot Include:\n>* HTML markup\n\nFiltering Type: `list of text`\n\n```\nEligible For: \n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * restaurant\n```" 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.\nA `virtualLocationUrl` must be specified for online and mixed events.\n\nFiltering Type: `object`\n\n```\nEligible For: \n * event\n```" attire: enum: - UNSPECIFIED - DRESSY - CASUAL - FORMAL type: string description: "The formality of clothing typically worn at this restaurant\n\nFiltering Type: `option`\n\n```\nEligible For: \n * restaurant\n```" babysittingOffered: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: "Indicates whether the entity offers babysitting.\n\nFiltering Type: `option`\n\n```\nEligible For: \n * hotel\n```" baggageStorage: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: "Indicates whether the entity offers baggage storage pre check-in and post check-out.\n\nFiltering Type: `option`\n\n```\nEligible For: \n * hotel\n```" bar: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: "Indicates whether the entity has an indoor or outdoor bar onsite.\n\nFiltering Type: `option`\n\n```\nEligible For: \n * hotel\n```" beachAccess: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: "Indicates whether the entity has access to a beach.\n\nFiltering Type: `option`\n\n```\nEligible For: \n * hotel\n```" beachFrontProperty: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: "Indicates whether the entity is physically located next to a beach.\n\nFiltering Type: `option`\n\n```\nEligible For: \n * hotel\n```" bicycles: enum: - BICYCLE_RENTALS - BICYCLE_RENTALS_FOR_FREE - NOT_APPLICABLE type: string description: "Indicates whether the entity offers bicycles for rent or for free.\n\nFiltering Type: `option`\n\n```\nEligible For: \n * hotel\n```" 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\n\nFiltering Type: `object`\n\n```\nEligible For: \n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * organization\n * restaurant\n```" 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.\n\nFiltering Type: `option`\n\n```\nEligible For: \n * hotel\n```" brands: description: "Brands sold by this entity\nAll strings must be non-empty when trimmed of whitespace.\n\n\n\nArray must be ordered.\n\nArray may have a maximum of 100 elements.\n\nArray item description:\n\n>Cannot Include:\n>* HTML markup\n\nFiltering Type: `list of text`\n\n```\nEligible For: \n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * restaurant\n```" 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.\n\nFiltering Type: `option`\n\n```\nEligible For: \n * hotel\n```" 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.\n\nEach 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.\nSimilarly, holiday brunch hours are represented by the `holidayHours` sub-field.\nSetting the `reopenDate` sub-field indicates that the business is temporarily closed and will reopen on the specified date.\nSPECIAL CASES:\n* 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.\n* 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.\n* If you are providing `openIntervals`, you may not set `isClosed` to true for that day.\n\nFiltering Type: `hours`\n\n```\nEligible For: \n * hotel\n * location\n * restaurant\n```" businessCenter: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: "Indicates whether the entity has a business center.\n\nFiltering Type: `option`\n\n```\nEligible For: \n * hotel\n```" 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\n\nFiltering Type: `object`\n\n```\nEligible For: \n * financialProfessional\n * healthcareFacility\n * hotel\n * location\n * restaurant\n```" carRental: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: "Indicates whether the entity offers car rental.\n\nFiltering Type: `option`\n\n```\nEligible For: \n * hotel\n```" casino: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: "Indicates whether the entity has a casino on premise or nearby.\n\nFiltering Type: `option`\n\n```\nEligible For: \n * hotel\n```" categories: additionalProperties: false type: object properties: {} description: "Yext Categories. (Supported for versions > 20240220)\n\nA map of category list external IDs (i.e. \"yext\") to a list of category IDs.\n\nIDs must be valid and selectable (i.e., cannot be parent categories).\n\nPartial updates are accepted, meaning sending only the \"yext\" property will have no effect on any category list except the \"yext\" category. \n\nFiltering Type: `object`\n\n```\nEligible For: \n * atm\n * event\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * restaurant\n```" categoryIds: uniqueItems: false type: array items: minLength: 0 type: string description: 'Filtering Type: `text`' description: "Yext Category IDs. (Deprecated: For versions > 20240220)\n\nIDs must be valid and selectable (i.e., cannot be parent categories).\n\nNOTE: 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.\n\n\nFiltering Type: `list of text`\n\n```\nEligible For: \n * atm\n * event\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * restaurant\n```" catsAllowed: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: "Indicates if the entity is cat friendly.\n\nFiltering Type: `option`\n\n```\nEligible For: \n * hotel\n```" certifications: description: "A list of the certifications held by the healthcare professional\n**NOTE:** This field is only available to locations whose **`entityType`** is `healthcareProfessional`.\n\n\n\nArray must be ordered.\n\nArray may have a maximum of 100 elements.\n\nArray item description:\n\n>Cannot Include:\n>* HTML markup\n\nFiltering Type: `list of text`\n\n```\nEligible For: \n * financialProfessional\n * healthcareProfessional\n```" 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\n\nFiltering Type: `time`\n\n```\nEligible For: \n * hotel\n```" checkOutTime: format: time type: string description: "The check-out time\n\nFiltering Type: `time`\n\n```\nEligible For: \n * hotel\n```" classificationRating: pattern: ^\d*\.?\d*$ type: string description: "The 1 to 5 star rating of the entitiy based on its services and facilities.\n\nFiltering Type: `decimal`\n\n```\nEligible For: \n * hotel\n```" closed: type: boolean description: "Indicates whether the entity is closed\n\nFiltering Type: `boolean`\n\n```\nEligible For: \n * atm\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * restaurant\n```" concierge: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: "Indicates whether the entity offers concierge service.\n\nFiltering Type: `option`\n\n```\nEligible For: \n * hotel\n```" conditionsTreated: description: "A list of the conditions treated by the healthcare provider\n\n\nArray must be ordered.\n\nArray may have a maximum of 100 elements.\n\nArray item description:\n\n>Cannot Include:\n>* HTML markup\n\nFiltering Type: `list of text`\n\n```\nEligible For: \n * healthcareFacility\n * healthcareProfessional\n```" 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.\n\nFiltering Type: `option`\n\n```\nEligible For: \n * hotel\n```" covidMessaging: minLength: 0 maxLength: 15000 type: string description: "Information or messaging related to COVID-19.\n\nFiltering Type: `text`\n\n```\nEligible For: \n * healthcareFacility\n * healthcareProfessional\n * location\n```" covidTestAppointmentUrl: minLength: 0 format: uri type: string description: "An appointment URL for scheduling a COVID-19 test.\n\nFiltering Type: `text`\n\n```\nEligible For: \n * healthcareFacility\n * location\n```" covidTestingAppointmentRequired: type: boolean description: "Indicates whether an appointment is required for a COVID-19 test.\n\nFiltering Type: `boolean`\n\n```\nEligible For: \n * healthcareFacility\n * location\n```" covidTestingDriveThroughSite: type: boolean description: "Indicates whether location is a drive-through site for COVID-19 tests.\n\nFiltering Type: `boolean`\n\n```\nEligible For: \n * healthcareFacility\n * location\n```" covidTestingIsFree: type: boolean description: "Indicates whether location offers free COVID-19 testing.\n\nFiltering Type: `boolean`\n\n```\nEligible For: \n * healthcareFacility\n * location\n```" covidTestingPatientRestrictions: type: boolean description: "Indicates whether there are patient restrictions for COVID-19 testing.\n\nFiltering Type: `boolean`\n\n```\nEligible For: \n * healthcareFacility\n * location\n```" covidTestingReferralRequired: type: boolean description: "Indicates whether a referral is required for COVID-19 testing.\n\nFiltering Type: `boolean`\n\n```\nEligible For: \n * healthcareFacility\n * location\n```" covidTestingSiteInstructions: minLength: 0 maxLength: 15000 type: string description: "Information or instructions for the COVID-19 testing site.\n\nFiltering Type: `text`\n\n```\nEligible For: \n * healthcareFacility\n * location\n```" covidVaccineAppointmentRequired: type: boolean description: "Indicates whether an appointment is required for a COVID-19 vaccine.\n\nFiltering Type: `boolean`\n\n```\nEligible For: \n * healthcareFacility\n * location\n```" covidVaccineDriveThroughSite: type: boolean description: "Indicates whether location is a drive-through site for COVID-19 vaccines.\n\nFiltering Type: `boolean`\n\n```\nEligible For: \n * healthcareFacility\n * location\n```" covidVaccineInformationUrl: minLength: 0 format: uri type: string description: "An information URL for more information about COVID-19 vaccines.\n\nFiltering Type: `text`\n\n```\nEligible For: \n * healthcareFacility\n * location\n```" covidVaccinePatientRestrictions: type: boolean description: "Indicates whether there are patient restrictions for a COVID-19 vaccine.\n\nFiltering Type: `boolean`\n\n```\nEligible For: \n * healthcareFacility\n * location\n```" covidVaccineReferralRequired: type: boolean description: "Indicates whether a referral is required for a COVID-19 vaccine.\n\nFiltering Type: `boolean`\n\n```\nEligible For: \n * healthcareFacility\n * location\n```" covidVaccineSiteInstructions: minLength: 0 maxLength: 15000 type: string description: "Information or instructions for the COVID-19 vaccination site.\n\nFiltering Type: `text`\n\n```\nEligible For: \n * healthcareFacility\n * location\n```" 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.\n\nFiltering Type: `list of option`\n\n```\nEligible For: \n * healthcareFacility\n * location\n```" currencyExchange: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: "Indicates whether the entity offers currency exchange services.\n\nFiltering Type: `option`\n\n```\nEligible For: \n * hotel\n```" customKeywords: description: "Additional keywords you would like us to use when tracking your search performance\n\n\nArray must be ordered.\n\nArray may have a maximum of 5 elements.\n\n\nFiltering Type: `list of text`\n\n```\nEligible For: \n * atm\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * organization\n * restaurant\n```" 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\n\nFiltering Type: `date`\n\n```\nEligible For: \n * job\n```" degrees: description: "A list of the degrees earned by the healthcare professional\n\n\nArray must be ordered.\n\n\nFiltering Type: `list of option`\n\n```\nEligible For: \n * healthcareProfessional\n```" 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.\n\nEach 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.\nSimilarly, holiday delivery hours are represented by the `holidayHours` sub-field.\nSetting the `reopenDate` sub-field indicates that the business is temporarily closed and will reopen on the specified date.\nSPECIAL CASES:\n* 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.\n* 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.\n* If you are providing `openIntervals`, you may not set `isClosed` to true for that day.\n\nFiltering Type: `hours`\n\n```\nEligible For: \n * location\n * restaurant\n```" description: minLength: 10 maxLength: 15000 type: string description: "A description of the entity\n\n\nCannot Include:\n* HTML markup\n\nFiltering Type: `text`\n\n```\nEligible For: \n * atm\n * contactCard\n * event\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * job\n * location\n * organization\n * restaurant\n```" 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\n\nFiltering Type: `object`\n\n```\nEligible For: \n * atm\n * event\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * job\n * location\n * restaurant\n```" doctorOnCall: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: "Indicates whether the entity has a doctor on premise or on call.\n\nFiltering Type: `option`\n\n```\nEligible For: \n * hotel\n```" dogsAllowed: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: "Indicates if the entity is dog friendly.\n\nFiltering Type: `option`\n\n```\nEligible For: \n * hotel\n```" 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.\n\nEach 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.\nSimilarly, holiday drive-through hours are represented by the `holidayHours` sub-field.\nSetting the `reopenDate` sub-field indicates that the business is temporarily closed and will reopen on the specified date.\nSPECIAL CASES:\n* 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.\n* 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.\n* If you are providing `openIntervals`, you may not set `isClosed` to true for that day.\n\nFiltering Type: `hours`\n\n```\nEligible For: \n * atm\n * location\n * restaurant\n```" 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\n\nFiltering Type: `object`\n\n```\nEligible For: \n * atm\n * event\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * restaurant\n```" educationList: description: "Information about the education or training completed by the healthcare professional\n\n\nArray must be ordered.\n\n\nFiltering Type: `list of object`\n\n```\nEligible For: \n * healthcareProfessional\n```" 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.\n\nFiltering Type: `option`\n\n```\nEligible For: \n * hotel\n```" elevator: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: "Indicates whether the entity has an elevator.\n\nFiltering Type: `option`\n\n```\nEligible For: \n * hotel\n```" ellipticalMachine: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: "Indicates whether the entity has an elliptical machine.\n\nFiltering Type: `option`\n\n```\nEligible For: \n * hotel\n```" emails: description: "Emails addresses for this entity's point of contact\n\nMust be valid email addresses\n\n\n\nArray must be ordered.\n\nArray may have a maximum of 5 elements.\n\n\nFiltering Type: `list of text`\n\n```\nEligible For: \n * contactCard\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * organization\n * restaurant\n```" 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.\n\nFiltering Type: `option`\n\n```\nEligible For: \n * job\n```" eventStatus: enum: - SCHEDULED - RESCHEDULED - POSTPONED - CANCELED - EVENT_MOVED_ONLINE type: string description: "Information on whether the event will take place as scheduled\n\nFiltering Type: `option`\n\n```\nEligible For: \n * event\n```" facebookAbout: minLength: 0 maxLength: 255 type: string description: "A description of the entity to be used in the \"About You\" section on Facebook\n\nFiltering Type: `text`\n\n```\nEligible For: \n * atm\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * restaurant\n```" 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\n\nValid contents of **`value`** depends on the Call-to-Action's **`type`**:\n* `NONE`: (optional)\n* `BOOK_NOW`: URL\n* `CALL_NOW`: Phone number\n* `CONTACT_US`: URL\n* `SEND_MESSAGE`: Any string\n* `USE_APP`: URL\n* `PLAY_GAME`: URL\n* `SHOP_NOW`: URL\n* `SIGN_UP`: URL\n* `WATCH_VIDEO`: URL\n* `SEND_EMAIL`: Email address\n* `LEARN_MORE`: URL\n* `PURCHASE_GIFT_CARDS`: URL\n* `ORDER_NOW`: URL\n* `FOLLOW_PAGE`: Any string\n\nFiltering Type: `object`\n\n```\nEligible For: \n * atm\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * restaurant\n```" facebookCoverPhoto: required: - url additionalProperties: false type: object description: "The cover photo for the entity's Facebook profile\n\nDisplayed as a 851 x 315 pixel image\n\nYou may need a cover photo in order for your listing to appear on Facebook. Please check your listings tab to learn more.\n\n\nImage must be at least 400 x 150 pixels\n\nImage area (width x height) may be no more than 41000000 pixels\n\nImage may be no more than 30000 x 30000 pixels\n\nSupported Aspect Ratios:\n* 1 x 1\n* 4 x 3\n* 3 x 2\n* 5 x 3\n* 16 x 9\n* 3 x 1\n* 2 x 3\n* 5 x 7\n* 4 x 5\n* 4 x 1\n\n**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.\n\n\nFiltering Type: `object`\n\n```\nEligible For: \n * atm\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * restaurant\n```" 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.\n\n\nCannot Include:\n* HTML markup\n\nFiltering Type: `text`\n\n```\nEligible For: \n * atm\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * restaurant\n```" 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.\n\nFiltering Type: `text`\n\n```\nEligible For: \n * atm\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * restaurant\n```" facebookOverrideCity: minLength: 0 type: string description: "The city to be displayed on this entity's Facebook profile\n\nFiltering Type: `text`\n\n```\nEligible For: \n * atm\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * restaurant\n```" facebookPageUrl: minLength: 0 type: string description: "URL for the entity's Facebook Page.\n\nValid formats:\n\n- facebook.com/profile.php?id=[numId]\n- facebook.com/group.php?gid=[numId]\n- facebook.com/groups/[numId]\n- facebook.com/[Name]\n- facebook.com/pages/[Name]/[numId]\n- facebook.com/people/[Name]/[numId]\n\nwhere [Name] is a String and [numId] is an Integer\nThe success response will contain a warning message explaining why the URL wasn't stored in the system.\n\nFiltering Type: `text`\n\n```\nEligible For: \n * atm\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * organization\n * restaurant\n```" 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\n\nFiltering Type: `text`\n\n```\nEligible For: \n * atm\n * brand\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * restaurant\n```" facebookProfilePhoto: required: - url additionalProperties: false type: object description: "The profile picture for the entity's Facebook profile\n\nYou must have a profile picture in order for your listing to appear on Facebook.\n\n\nImage must be at least 180 x 180 pixels\n\nImage area (width x height) may be no more than 41000000 pixels\n\nImage may be no more than 30000 x 30000 pixels\n\nSupported Aspect Ratios:\n* 1 x 1\n* 4 x 3\n* 3 x 2\n* 5 x 3\n* 16 x 9\n* 3 x 1\n* 2 x 3\n* 5 x 7\n* 4 x 5\n* 4 x 1\n\n**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.\n\n\nFiltering Type: `object`\n\n```\nEligible For: \n * atm\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * restaurant\n```" 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\n\nFiltering Type: `text`\n\n```\nEligible For: \n * atm\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * restaurant\n```" 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.\n\nFiltering Type: `text`\n\n```\nEligible For: \n * atm\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * restaurant\n```" 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).\n\nFiltering Type: `text`\n\n```\nEligible For: \n * atm\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * restaurant\n```" fax: minLength: 0 type: string description: "Must be a valid fax number.\n\nIf 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.\n\nFiltering Type: `text`\n\n```\nEligible For: \n * atm\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * restaurant\n```" 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\n\nFiltering Type: `object`\n\n```\nEligible For: \n * atm\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * restaurant\n```" firstName: minLength: 0 maxLength: 35 type: string description: "The first name of the healthcare professional\n\n\nCannot Include:\n* a URL or domain name\n* HTML markup\n\nFiltering Type: `text`\n\n```\nEligible For: \n * healthcareProfessional\n```" firstPartyReviewPage: minLength: 0 type: string description: "Link to the review-collection page, where consumers can leave first-party reviews\n\n```\nEligible For: \n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * restaurant\n```" fitnessCenter: enum: - FITNESS_CENTER_AVAILABLE - FITNESS_CENTER_AVAILABLE_FOR_FREE - NOT_APPLICABLE type: string description: "Indicates whether the entity has a fitness center.\n\nFiltering Type: `option`\n\n```\nEligible For: \n * hotel\n```" floorCount: multipleOf: 1 minimum: 0 type: number description: "The number of floors the entity has from ground floor to top floor.\n\nFiltering Type: `integer`\n\n```\nEligible For: \n * hotel\n```" freeWeights: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: "Indicates whether the entity has free weights.\n\nFiltering Type: `option`\n\n```\nEligible For: \n * hotel\n```" frequentlyAskedQuestions: description: "A list of questions that are frequently asked about this entity\n\n\nArray must be ordered.\n\nArray may have a maximum of 100 elements.\n\n\nFiltering Type: `list of object`\n\n```\nEligible For: \n * atm\n * event\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * restaurant\n```" 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.\n\nFiltering Type: `option`\n\n```\nEligible For: \n * hotel\n```" fullyVaccinatedStaff: type: boolean description: "Indicates whether the staff is vaccinated against COVID-19.\n\nFiltering Type: `boolean`\n\n```\nEligible For: \n * healthcareFacility\n * hotel\n * location\n * restaurant\n```" gameRoom: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: "Indicates whether the entity has a game room.\n\nFiltering Type: `option`\n\n```\nEligible For: \n * hotel\n```" gender: enum: - UNSPECIFIED - FEMALE - MALE - NONBINARY - TRANSGENDER_FEMALE - TRANSGENDER_MALE - OTHER - PREFER_NOT_TO_DISCLOSE type: string description: "The gender of the healthcare professional\n\nFiltering Type: `option`\n\n```\nEligible For: \n * healthcareProfessional\n```" geomodifier: minLength: 0 type: string description: "Provides additional information on where the entity can be found (e.g., `Times Square`, `Global Center Mall`)\n\nFiltering Type: `text`\n\n```\nEligible For: \n * atm\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * restaurant\n```" giftShop: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: "Indicates whether the entity has a gift shop.\n\nFiltering Type: `option`\n\n```\nEligible For: \n * hotel\n```" 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.\n\nFiltering Type: `option`\n\n```\nEligible For: \n * hotel\n```" 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.\n\nValid 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.\n\nKeyword 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`).\n\n* 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\" ] }]`)\n* 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\" ]}`)\n\n**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.\n\nFiltering Type: `object`\n\n```\nEligible For: \n * atm\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * restaurant\n```" googleCoverPhoto: required: - url additionalProperties: false type: object description: "The cover photo for the entity's Google profile\n\n\nImage must be at least 250 x 250 pixels\n\n\nFiltering Type: `object`\n\n```\nEligible For: \n * atm\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * restaurant\n```" 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.\nMust be a valid phone number.\nIf 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. \n\nFiltering 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.\n\nNOTE: 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.\n\nFiltering Type: `object`\n\n```\nEligible For: \n * atm\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * restaurant\n```" googleMyBusinessLabels: description: "Google Business Profile Labels help users organize their locations into groups within GBP.\n\n\nArray must be ordered.\n\nArray may have a maximum of 10 elements.\n\nArray item description:\n\n>Cannot Include:\n>* HTML markup\n\nFiltering Type: `list of text`\n\n```\nEligible For: \n * atm\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * restaurant\n```" 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.\n\nFiltering Type: `text`\n\n```\nEligible For: \n * atm\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * restaurant\n```" googleProfilePhoto: required: - url additionalProperties: false type: object description: "The profile photo for the entity's Google profile\n\n\nImage must be at least 250 x 250 pixels\n\nImage may be no more than 5000 x 5000 pixels\n\nSupported Aspect Ratios:\n* 1 x 1\n\n**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.\n\n\nFiltering Type: `object`\n\n```\nEligible For: \n * atm\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * restaurant\n```" 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).\n\nFor 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.\n\nFiltering Type: `text`\n\n```\nEligible For: \n * atm\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * restaurant\n```" 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.\n\nEach 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.\nSimilarly, holiday happy hours are represented by the `holidayHours` sub-field.\nSetting the `reopenDate` sub-field indicates that the business is temporarily closed and will reopen on the specified date.\nSPECIAL CASES:\n* 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.\n* 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.\n* If you are providing `openIntervals`, you may not set `isClosed` to true for that day.\n\nFiltering Type: `hours`\n\n```\nEligible For: \n * hotel\n * location\n * restaurant\n```" headshot: required: - url additionalProperties: false type: object description: "A portrait of the healthcare professional\n\nFiltering Type: `object`\n\n```\nEligible For: \n * contactCard\n * financialProfessional\n * healthcareProfessional\n```" 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\n\nFiltering Type: `text`\n\n```\nEligible For: \n * job\n```" holidayHoursConversationEnabled: type: boolean description: "Indicates whether holiday-hour confirmation alerts are enabled for the Yext Knowledge Assistant for this entity\n\nFiltering Type: `boolean`\n\n```\nEligible For: \n * atm\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * restaurant\n```" horsebackRiding: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: "Indicates whether the entity offers horseback riding.\n\nFiltering Type: `option`\n\n```\nEligible For: \n * hotel\n```" hotTub: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: "Indicates whether the entity has a hot tub.\n\nFiltering Type: `option`\n\n```\nEligible For: \n * hotel\n```" 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.\n\nEach 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.\nSimilarly, holiday hours are represented by the `holidayHours` sub-field.\nSetting the `reopenDate` sub-field indicates that the business is temporarily closed and will reopen on the specified date.\nSPECIAL CASES:\n* 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.\n* 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.\n* If you are providing `openIntervals`, you may not set `isClosed` to true for that day.\n\nFiltering Type: `hours`\n\n```\nEligible For: \n * atm\n * contactCard\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * restaurant\n```" housekeeping: enum: - HOUSEKEEPING_AVAILABLE - HOUSEKEEPING_AVAILABLE_DAILY - NOT_APPLICABLE type: string description: "Indicates whether the entity offers housekeeping services.\n\nFiltering Type: `option`\n\n```\nEligible For: \n * hotel\n```" 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.\n\nFiltering Type: `text`\n\n```\nEligible For: \n * atm\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * restaurant\n```" indoorPoolCount: multipleOf: 1 minimum: 0 type: number description: "A count of the number of indoor pools\n\nFiltering Type: `integer`\n\n```\nEligible For: \n * hotel\n```" instagramHandle: minLength: 0 maxLength: 30 type: string description: "Valid Instagram username for the entity without the leading \"@\" (e.g., `NewCityAuto`)\n\nFiltering Type: `text`\n\n```\nEligible For: \n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * organization\n * restaurant\n```" insuranceAccepted: description: "A list of insurance policies accepted by the healthcare provider\n\n\nArray must be ordered.\n\nArray may have a maximum of 100 elements.\n\nArray item description:\n\n>Cannot Include:\n>* HTML markup\n\nFiltering Type: `list of text`\n\n```\nEligible For: \n * healthcareFacility\n * healthcareProfessional\n```" 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\n\nFiltering Type: `text`\n\n```\nEligible For: \n * brand\n * financialProfessional\n * hotel\n * location\n * restaurant\n```" isClusterPrimary: type: boolean description: "Indicates whether the healthcare entity is the primary entity in its group\n\nFiltering Type: `boolean`\n\n```\nEligible For: \n * healthcareProfessional\n```" isFreeEvent: type: boolean description: "Indicates whether or not the event is free\n\nFiltering Type: `boolean`\n\n```\nEligible For: \n * event\n```" isoRegionCode: minLength: 0 type: string description: "The ISO 3166-2 region code for the entity\n\nYext 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.\n\nFiltering Type: `text`\n\n```\nEligible For: \n * atm\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * restaurant\n```" keywords: description: "Keywords that describe the entity.\n\nAll strings must be non-empty when trimmed of whitespace.\n\n\n\nArray must be ordered.\n\nArray may have a maximum of 100 elements.\n\nArray item description:\n\n>Cannot Include:\n>* HTML markup\n\nFiltering Type: `list of text`\n\n```\nEligible For: \n * atm\n * card\n * event\n * faq\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * helpArticle\n * hotel\n * job\n * location\n * product\n * restaurant\n```" 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.\n\nFiltering Type: `option`\n\n```\nEligible For: \n * hotel\n```" kidsClub: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: "Indicates if the property has a Kids Club.\n\nFiltering Type: `option`\n\n```\nEligible For: \n * hotel\n```" kidsStayFree: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: "Indicates whether the entity allows kids to stay free.\n\nFiltering Type: `option`\n\n```\nEligible For: \n * hotel\n```" 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.\n\nEach 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.\nSimilarly, holiday kitchen hours are represented by the `holidayHours` sub-field.\nSetting the `reopenDate` sub-field indicates that the business is temporarily closed and will reopen on the specified date.\nSPECIAL CASES:\n* 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.\n* 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.\n* If you are providing `openIntervals`, you may not set `isClosed` to true for that day.\n\nFiltering Type: `hours`\n\n```\nEligible For: \n * hotel\n * location\n * restaurant\n```" 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.\n\n**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.\n\nFiltering Type: `opaque`\n\n```\nEligible For: \n * atm\n * board\n * brand\n * card\n * contactCard\n * event\n * faq\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * helpArticle\n * hotel\n * hotelRoomType\n * job\n * location\n * organization\n * product\n * restaurant\n```" landingPageUrl: minLength: 0 format: uri type: string description: "The URL of this entity's Landing Page that was created with Yext Pages\n\nFiltering Type: `text`\n\n```\nEligible For: \n * atm\n * card\n * event\n * faq\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * helpArticle\n * hotel\n * job\n * location\n * product\n * restaurant\n```" languages: description: "The langauges in which consumers can commicate with this entity or its staff members\nAll strings must be non-empty when trimmed of whitespace.\n\n\n\nArray must be ordered.\n\nArray may have a maximum of 100 elements.\n\nArray item description:\n\n>Cannot Include:\n>* HTML markup\n\nFiltering Type: `list of text`\n\n```\nEligible For: \n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * restaurant\n```" 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\n\n\nCannot Include:\n* a URL or domain name\n* HTML markup\n\nFiltering Type: `text`\n\n```\nEligible For: \n * healthcareProfessional\n```" laundry: enum: - FULL_SERVICE - SELF_SERVICE - NOT_APPLICABLE type: string description: "Indicates whether the entity offers laundry services.\n\nFiltering Type: `option`\n\n```\nEligible For: \n * hotel\n```" lazyRiver: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: "Indicates if the property has a lazy river\n\nFiltering Type: `option`\n\n```\nEligible For: \n * hotel\n```" lifeguard: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: "Indicates if the property has a lifeguard on duty\n\nFiltering Type: `option`\n\n```\nEligible For: \n * hotel\n```" linkedInUrl: minLength: 0 format: uri type: string description: "URL for your LinkedIn account, format should be https://www.linkedin.com/in/yourUsername\n\nFiltering Type: `text`\n\n```\nEligible For: \n * contactCard\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * organization\n * restaurant\n```" linkedLocation: type: string description: "location ID of the event location, if the event is held at a location managed in the Yext Knowledge Manager\n\nFiltering Type: `entityId`\n\n```\nEligible For: \n * contactCard\n * event\n```" 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.\n\nFiltering Type: `text`\n\n```\nEligible For: \n * atm\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * restaurant\n```" localShuttle: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: "Indicates whether the entity offers local shuttle services.\n\nFiltering Type: `option`\n\n```\nEligible For: \n * hotel\n```" 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.\n\nFiltering Type: `entityId`\n\n```\nEligible For: \n * atm\n```" 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\n\nFiltering Type: `object`\n\n```\nEligible For: \n * job\n```" locationType: enum: - LOCATION - HEALTHCARE_FACILITY - HEALTHCARE_PROFESSIONAL - ATM - RESTAURANT - HOTEL type: string description: "Indicates the entity's type, if it is not an event\n\nFiltering Type: `option`\n\n```\nEligible For: \n * atm\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * restaurant\n```" logo: required: - image additionalProperties: false type: object description: "An image of the entity's logo\n\n\nSupported Aspect Ratios:\n* 1 x 1\n\n**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.\n\n\nFiltering Type: `object`\n\n```\nEligible For: \n * atm\n * contactCard\n * faq\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * job\n * location\n * organization\n * restaurant\n```" 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\n\nMust be a valid phone number.\n\nIf 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.\n\nFiltering Type: `text`\n\n```\nEligible For: \n * atm\n * contactCard\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * organization\n * restaurant\n```" massage: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: "Indicates whether the entity offers massage services.\n\nFiltering Type: `option`\n\n```\nEligible For: \n * hotel\n```" 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\n\nFiltering Type: `integer`\n\n```\nEligible For: \n * hotel\n```" 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\n\nFiltering Type: `integer`\n\n```\nEligible For: \n * hotel\n```" 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\n\nFiltering Type: `list of option`\n\n```\nEligible For: \n * restaurant\n```" meetingRoomCount: multipleOf: 1 minimum: 0 type: number description: "The number of meeting rooms the entity has.\n\nFiltering Type: `integer`\n\n```\nEligible For: \n * hotel\n```" 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\n\nFiltering Type: `object`\n\n```\nEligible For: \n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * restaurant\n```" 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\n\nFiltering Type: `object`\n\n```\nEligible For: \n * hotel\n * location\n * restaurant\n```" middleName: minLength: 0 maxLength: 35 type: string description: "The middle name of the healthcare professional\n\n\nCannot Include:\n* a URL or domain name\n* HTML markup\n\nFiltering Type: `text`\n\n```\nEligible For: \n * healthcareProfessional\n```" mobilePhone: minLength: 0 type: string description: "Must be a valid phone number.\n\nIf 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.\n\nFiltering Type: `text`\n\n```\nEligible For: \n * atm\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * restaurant\n```" mobilityAccessible: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: "Indicates whether the entity is mobility/wheelchair accessible\n\nFiltering Type: `option`\n\n```\nEligible For: \n * hotel\n```" nightclub: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: "Indicates whether the entity has a nightclub.\n\nFiltering Type: `option`\n\n```\nEligible For: \n * hotel\n```" npi: minLength: 0 type: string description: "The National Provider Identifier (NPI) of the healthcare provider\n\nFiltering Type: `text`\n\n```\nEligible For: \n * healthcareFacility\n * healthcareProfessional\n```" nudgeEnabled: type: boolean description: "Indicates whether Knowledge Nudge is enabled for the Yext Knowledge Assistant for this entity\n\nFiltering Type: `boolean`\n\n```\nEligible For: \n * atm\n * faq\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * helpArticle\n * hotel\n * job\n * location\n * organization\n * product\n * restaurant\n```" officeName: minLength: 0 type: string description: "The name of the office where the healthcare professional works, if different from **`name`**\n\nFiltering Type: `text`\n\n```\nEligible For: \n * healthcareProfessional\n```" 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.\n\nEach 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.\nSimilarly, holiday online service hours are represented by the `holidayHours` sub-field.\nSetting the `reopenDate` sub-field indicates that the business is temporarily closed and will reopen on the specified date.\nSPECIAL CASES:\n* 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.\n* 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.\n* If you are providing `openIntervals`, you may not set `isClosed` to true for that day.\n\nFiltering Type: `hours`\n\n```\nEligible For: \n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * location\n * restaurant\n```" openDate: format: date type: string description: "The date that the entity is set to open for the first time.\nMust be formatted in YYYY-MM-DD format.\n\nDate must be on or after 1970-01-01 Date must be before or on 2038-01-01\n\n\nFiltering Type: `date`\n\n```\nEligible For: \n * atm\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * restaurant\n```" 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\n\nFiltering Type: `list of option`\n\n```\nEligible For: \n * organization\n```" 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\n\nFiltering Type: `object`\n\n```\nEligible For: \n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * restaurant\n```" organizerEmail: minLength: 0 format: email type: string description: "Point of contact for the event organizer (not to be published publicly)\n\nFiltering Type: `text`\n\n```\nEligible For: \n * event\n```" organizerName: minLength: 0 type: string description: "Point of contact for the event organizer (not to be published publicly)\n\nFiltering Type: `text`\n\n```\nEligible For: \n * event\n```" organizerPhone: minLength: 0 type: string description: "Point of contact for the event organizer (not to be published publicly)\n\nFiltering Type: `text`\n\n```\nEligible For: \n * event\n```" outdoorPoolCount: multipleOf: 1 minimum: 0 type: number description: "The number of outdoor pools the entity has.\n\nFiltering Type: `integer`\n\n```\nEligible For: \n * hotel\n```" parking: enum: - PARKING_AVAILABLE - PARKING_AVAILABLE_FOR_FREE - NOT_APPLICABLE type: string description: "Indicates whether the entity offers parking services.\n\nFiltering Type: `option`\n\n```\nEligible For: \n * hotel\n```" 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\n\nValid elements depend on the entity's country.\n\n\nFiltering Type: `list of option`\n\n```\nEligible For: \n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * restaurant\n```" performers: description: "Performers at the event\n\n\nArray must be ordered.\n\nArray may have a maximum of 100 elements.\n\n\nFiltering Type: `list of text`\n\n```\nEligible For: \n * event\n```" 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.\n\nFiltering Type: `option`\n\n```\nEligible For: \n * hotel\n```" photoGallery: description: "\n**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.\n\n\n\nArray must be ordered.\n\nArray may have a maximum of 500 elements.\n\nArray item description:\n\n>Supported Aspect Ratios:\n>* 1 x 1\n>* 4 x 3\n>* 3 x 2\n>* 5 x 3\n>* 16 x 9\n>* 3 x 1\n>* 2 x 3\n>* 5 x 7\n>* 4 x 5\n>* 4 x 1\n>\n>**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.\n>\n\nFiltering Type: `list of object`\n\n```\nEligible For: \n * atm\n * event\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * hotelRoomType\n * location\n * organization\n * product\n * restaurant\n```" 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\n\nFiltering Type: `object`\n\n```\nEligible For: \n * atm\n * event\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * restaurant\n```" 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.\n\nEach 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.\nSimilarly, holiday pickup hours are represented by the `holidayHours` sub-field.\nSetting the `reopenDate` sub-field indicates that the business is temporarily closed and will reopen on the specified date.\nSPECIAL CASES:\n* 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.\n* 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.\n* If you are providing `openIntervals`, you may not set `isClosed` to true for that day.\n\nFiltering Type: `hours`\n\n```\nEligible For: \n * healthcareFacility\n * location\n * restaurant\n```" pinterestUrl: minLength: 0 format: uri type: string description: "URL for your Pinterest account, format should be https://www.pinterest.com/yourUsername\n\nFiltering Type: `text`\n\n```\nEligible For: \n * contactCard\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * organization\n * restaurant\n```" 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)\n\nFiltering Type: `option`\n\n```\nEligible For: \n * atm\n * healthcareFacility\n * healthcareProfessional\n * location\n * restaurant\n```" primaryConversationContact: minLength: 0 type: string description: "ID of the user who is the primary Knowledge Assistant contact for the entity\n\nFiltering Type: `option`\n\n```\nEligible For: \n * atm\n * faq\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * helpArticle\n * hotel\n * job\n * location\n * organization\n * product\n * restaurant\n```" privateBeach: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: "Indicates whether the entity has access to a private beach.\n\nFiltering Type: `option`\n\n```\nEligible For: \n * hotel\n```" privateCarService: enum: - PRIVATE_CAR_SERVICE - PRIVATE_CAR_SERVICE_FOR_FREE - NOT_APPLICABLE type: string description: "Indicates whether the entity offers private car services.\n\nFiltering Type: `option`\n\n```\nEligible For: \n * hotel\n```" 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\n\nFiltering Type: `object`\n\n```\nEligible For: \n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * restaurant\n```" products: description: "Products sold by this entity\n\nAll strings must be non-empty when trimmed of whitespace.\n\n\n\nArray must be ordered.\n\nArray may have a maximum of 100 elements.\n\nArray item description:\n\n>Cannot Include:\n>* HTML markup\n\nFiltering Type: `list of text`\n\n```\nEligible For: \n * financialProfessional\n * location\n```" 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\n\nFiltering Type: `boolean`\n\n```\nEligible For: \n * atm\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * organization\n * restaurant\n```" rankTrackingCompetitors: description: "Information about the competitors whose search performance you would like to compare to your own\n\n\nArray must be ordered.\n\nArray may have a maximum of 5 elements.\n\n\nFiltering Type: `list of object`\n\n```\nEligible For: \n * atm\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * organization\n * restaurant\n```" 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\n\nFiltering Type: `boolean`\n\n```\nEligible For: \n * atm\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * organization\n * restaurant\n```" rankTrackingFrequency: enum: - WEEKLY - MONTHLY - QUARTERLY type: string description: "How often we send search queries to track your search performance\n\nFiltering Type: `option`\n\n```\nEligible For: \n * atm\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * organization\n * restaurant\n```" rankTrackingQueryTemplates: description: "The ways in which your keywords will be arranged in the search queries we use to track your performance\n\n\nArray must have a minimum of 2 elements.\n\nArray may have a maximum of 4 elements.\n\n\nFiltering Type: `list of option`\n\n```\nEligible For: \n * atm\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * organization\n * restaurant\n```" 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\n\nFiltering Type: `list of option`\n\n```\nEligible For: \n * atm\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * organization\n * restaurant\n```" 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\n\nFiltering Type: `object`\n\n```\nEligible For: \n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * restaurant\n```" restaurantCount: multipleOf: 1 minimum: 0 type: number description: "The number of restaurants the entity has.\n\nFiltering Type: `integer`\n\n```\nEligible For: \n * hotel\n```" reviewGenerationUrl: minLength: 0 type: string description: "The URL given Review Invitation emails where consumers can leave a review about the entity\n\n```\nEligible For: \n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * restaurant\n```" reviewResponseConversationEnabled: type: boolean description: "Indicates whether Yext Knowledge Assistant review-response conversations are enabled for this entity\n\nFiltering Type: `boolean`\n\n```\nEligible For: \n * atm\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * restaurant\n```" roomCount: multipleOf: 1 minimum: 0 type: number description: "The number of rooms the entity has.\n\nFiltering Type: `integer`\n\n```\nEligible For: \n * hotel\n```" roomService: enum: - ROOM_SERVICE_AVAILABLE - ROOM_SERVICE_AVAILABLE_24_HOURS - NOT_APPLICABLE type: string description: "Indicates whether the entity offers room service.\n\nFiltering Type: `option`\n\n```\nEligible For: \n * hotel\n```" 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\n\nFiltering Type: `object`\n\n```\nEligible For: \n * atm\n * event\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * restaurant\n```" salon: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: "Indicates whether the entity has a salon.\n\nFiltering Type: `option`\n\n```\nEligible For: \n * hotel\n```" sauna: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: "Indicates whether the entity has a sauna.\n\nFiltering Type: `option`\n\n```\nEligible For: \n * hotel\n```" scuba: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: "Indicates whether the entity offers scuba diving.\n\nFiltering Type: `option`\n\n```\nEligible For: \n * hotel\n```" selfParking: enum: - SELF_PARKING_AVAILABLE - SELF_PARKING_AVAILABLE_FOR_FREE - NOT_APPLICABLE type: string description: "Indicates whether the entity offers self parking services.\n\nFiltering Type: `option`\n\n```\nEligible For: \n * hotel\n```" 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.\n\nEach 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.\nSimilarly, holiday senior hours are represented by the `holidayHours` sub-field.\nSetting the `reopenDate` sub-field indicates that the business is temporarily closed and will reopen on the specified date.\nSPECIAL CASES:\n* 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.\n* 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.\n* If you are providing `openIntervals`, you may not set `isClosed` to true for that day.\n\nFiltering Type: `hours`\n\n```\nEligible For: \n * location\n * restaurant\n```" serviceArea: additionalProperties: false type: object properties: places: description: "A list of places served by the entity, where each place is either:\n - a postal code, or\n - the name of a city.\n\n\n\nArray must be ordered.\n\nArray may have a maximum of 200 elements.\n\n\nFiltering 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.\n\n**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.\n\nFiltering Type: `object`\n\n```\nEligible For: \n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * restaurant\n```" 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.\n**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.\n\n\nArray may have a maximum of 200 elements.\n\n\nFiltering Type: `list of object`\n\n```\nEligible For: \n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * restaurant\n```" 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\n\nAll strings must be non-empty when trimmed of whitespace.\n\n\n\nArray must be ordered.\n\nArray may have a maximum of 100 elements.\n\nArray item description:\n\n>Cannot Include:\n>* HTML markup\n\nFiltering Type: `list of text`\n\n```\nEligible For: \n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * restaurant\n```" 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.\n\nFiltering Type: `option`\n\n```\nEligible For: \n * hotel\n```" snorkeling: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: "Indicates whether the entity offers snorkeling.\n\nFiltering Type: `option`\n\n```\nEligible For: \n * hotel\n```" socialHour: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: "Indicates whether the entity offers a social hour.\n\nFiltering Type: `option`\n\n```\nEligible For: \n * hotel\n```" spa: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: "Indicates whether the entity has a spa.\n\nFiltering Type: `option`\n\n```\nEligible For: \n * hotel\n```" specialities: description: "Up to 100 of this entity's specialities (e.g., for food and dining: `Chicago style`)\n\nAll strings must be non-empty when trimmed of whitespace.\n\n\n\nArray must be ordered.\n\nArray may have a maximum of 100 elements.\n\nArray item description:\n\n>Cannot Include:\n>* HTML markup\n\nFiltering Type: `list of text`\n\n```\nEligible For: \n * financialProfessional\n * location\n * restaurant\n```" 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.\n\nFiltering Type: `option`\n\n```\nEligible For: \n * hotel\n```" 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.\n\nEach 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.\nSimilarly, holiday takeout hours are represented by the `holidayHours` sub-field.\nSetting the `reopenDate` sub-field indicates that the business is temporarily closed and will reopen on the specified date.\nSPECIAL CASES:\n* 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.\n* 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.\n* If you are providing `openIntervals`, you may not set `isClosed` to true for that day.\n\nFiltering Type: `hours`\n\n```\nEligible For: \n * location\n * restaurant\n```" tennis: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: "Indicates whether the entity has tennis courts.\n\nFiltering Type: `option`\n\n```\nEligible For: \n * hotel\n```" thermalPool: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: "Indicates whether the entity has a thermal pool.\n\nFiltering Type: `option`\n\n```\nEligible For: \n * hotel\n```" ticketAvailability: enum: - IN_STOCK - SOLD_OUT - PRE_ORDER - UNSPECIFIED type: string description: "Information about the availability of tickets for the event\n\nFiltering Type: `option`\n\n```\nEligible For: \n * event\n```" 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\n\nFiltering Type: `object`\n\n```\nEligible For: \n * event\n```" ticketSaleDateTime: format: date-time type: string description: "The date/time tickets are available for sale (local time)\n\nFiltering Type: `datetime`\n\n```\nEligible For: \n * event\n```" ticketUrl: minLength: 0 format: uri type: string description: "URL to purchase tickets for the event (if ticketed)\n\nFiltering Type: `text`\n\n```\nEligible For: \n * event\n```" tikTokUrl: minLength: 0 format: uri type: string description: "URL for your TikTok profile, format should be https://www.tiktok.com/yourUsername\n\nFiltering Type: `text`\n\n```\nEligible For: \n * contactCard\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * organization\n * restaurant\n```" 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\n\nFiltering Type: `object`\n\n```\nEligible For: \n * event\n```" timeZoneUtcOffset: minLength: 0 type: string description: "Represents the time zone offset of the entity from UTC, in `±hh:mm` format.\n\nFor example, if the entity is 4 hours ahead of UTC time, the offset will be `+04:00`.\n\nIf the entity is 15.5 hours behind UTC time, the offset will be `-15:30`.\n\nIf the entity is in UTC time, the offset will be `+00:00`.\n\n\n```\nEligible For: \n * atm\n * event\n * faq\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * job\n * location\n * restaurant\n```" 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\"`\n\nFiltering Type: `option`\n\n```\nEligible For: \n * atm\n * board\n * card\n * contactCard\n * event\n * faq\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * helpArticle\n * hotel\n * hotelRoomType\n * job\n * location\n * organization\n * product\n * restaurant\n```" tollFreePhone: minLength: 0 type: string description: "Must be a valid phone number.\n\nIf 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.\n\nFiltering Type: `text`\n\n```\nEligible For: \n * atm\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * restaurant\n```" treadmill: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: "Indicates whether the entity has a treadmill.\n\nFiltering Type: `option`\n\n```\nEligible For: \n * hotel\n```" ttyPhone: minLength: 0 type: string description: "Must be a valid phone number.\n\nIf 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.\n\nFiltering Type: `text`\n\n```\nEligible For: \n * atm\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * restaurant\n```" turndownService: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: "Indicates whether the entity offers turndown service.\n\nFiltering Type: `option`\n\n```\nEligible For: \n * hotel\n```" twitterHandle: minLength: 0 maxLength: 15 type: string description: "Valid Twitter handle for the entity without the leading \"@\" (e.g., `JohnSmith`)\n\nIf 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.\n\nFiltering Type: `text`\n\n```\nEligible For: \n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * organization\n * restaurant\n```" 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\n\nFiltering Type: `object`\n\n```\nEligible For: \n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * restaurant\n```" 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\n\nFiltering Type: `object`\n\n```\nEligible For: \n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * restaurant\n```" valetParking: enum: - VALET_PARKING_AVAILABLE - VALET_PARKING_AVAILABLE_FOR_FREE - NOT_APPLICABLE type: string description: "Indicates whether the entity offers valet parking services.\n\nFiltering Type: `option`\n\n```\nEligible For: \n * hotel\n```" validThrough: format: date-time type: string description: "The date this entity is valid through.\n\nFiltering Type: `datetime`\n\n```\nEligible For: \n * job\n```" vendingMachine: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: "Indicates whether the entity has a vending machine.\n\nFiltering Type: `option`\n\n```\nEligible For: \n * hotel\n```" venueName: minLength: 0 type: string description: "Name of the venue where the event is being held\n\nFiltering Type: `text`\n\n```\nEligible For: \n * event\n```" videos: description: "Valid YouTube URLs for embedding a video on some publisher sites\n\n**NOTE:** Currently, only the first URL in the Array appears in your listings.\n\n\n\nArray must be ordered.\n\n\nFiltering Type: `list of object`\n\n```\nEligible For: \n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * hotelRoomType\n * location\n * organization\n * product\n * restaurant\n```" 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.\n\nFiltering Type: `option`\n\n```\nEligible For: \n * hotel\n```" wakeUpCalls: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: "Indicates whether the entity offers wake up call services.\n\nFiltering Type: `option`\n\n```\nEligible For: \n * hotel\n```" 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\n\nFiltering Type: `object`\n\n```\nEligible For: \n * atm\n * event\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * restaurant\n```" waterPark: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: "Indicates whether the entity has a water park.\n\nFiltering Type: `option`\n\n```\nEligible For: \n * hotel\n```" waterSkiing: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: "Indicates whether the entity offers water skiing.\n\nFiltering Type: `option`\n\n```\nEligible For: \n * hotel\n```" watercraft: enum: - WATERCRAFT_RENTALS - WATERCRAFT_RENTALS_FOR_FREE - NOT_APPLICABLE type: string description: "Indicates whether the entity offers any kind of watercrafts.\n\nFiltering Type: `option`\n\n```\nEligible For: \n * hotel\n```" waterslide: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: "Indicates whether the entity has a water slide.\n\nFiltering Type: `option`\n\n```\nEligible For: \n * hotel\n```" wavePool: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: "Indicates whether the entity has a wave pool.\n\nFiltering Type: `option`\n\n```\nEligible For: \n * hotel\n```" 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\n\nFiltering Type: `object`\n\n```\nEligible For: \n * atm\n * contactCard\n * event\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * organization\n * restaurant\n```" weightMachine: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: "Indicates whether the entity has a weight machine.\n\nFiltering Type: `option`\n\n```\nEligible For: \n * hotel\n```" wheelchairAccessible: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: "Indicates if the entity is wheelchair accessible.\n\nFiltering Type: `option`\n\n```\nEligible For: \n * hotel\n```" wifiAvailable: enum: - WIFI_AVAILABLE - WIFI_AVAILABLE_FOR_FREE - NOT_APPLICABLE type: string description: "Indicates whether the entity has WiFi available\n\nFiltering Type: `option`\n\n```\nEligible For: \n * hotel\n```" workRemote: type: boolean description: "Indicates whether the job is remote.\n\nFiltering Type: `boolean`\n\n```\nEligible For: \n * job\n```" yearEstablished: multipleOf: 1 minimum: 1000 maximum: 2028 type: number description: "The year the entity was established.\n\nFiltering Type: `integer`\n\n```\nEligible For: \n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * restaurant\n```" yearLastRenovated: multipleOf: 1 minimum: 1000 maximum: 2028 type: number description: "The most recent year the entity was partially or completely renovated.\n\nFiltering Type: `integer`\n\n```\nEligible For: \n * hotel\n```" 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\n\nFiltering Type: `object`\n\n```\nEligible For: \n * atm\n * event\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * job\n * location\n * restaurant\n```" 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\n\nFiltering Type: `object`\n\n```\nEligible For: \n * atm\n * event\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * restaurant\n```" 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\n\nFiltering Type: `object`\n\n```\nEligible For: \n * atm\n * event\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * restaurant\n```" 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\n\nFiltering Type: `object`\n\n```\nEligible For: \n * atm\n * event\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * restaurant\n```" 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\n\nFiltering Type: `object`\n\n```\nEligible For: \n * atm\n * event\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * restaurant\n```" youTubeChannelUrl: minLength: 0 format: uri type: string description: "URL for your YouTube channel, format should be https://www.youtube.com/c/yourUsername\n\nFiltering Type: `text`\n\n```\nEligible For: \n * contactCard\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * organization\n * restaurant\n```" 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: {} put: operationId: updateEntity requestBody: description: Information to update on the entity required: true content: application/json: schema: $ref: '#/components/schemas/EntityWrite' 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: 'The ID of the operation. Leave this blank to create a new operation or supply an ID to continue an existing operation ' name: Update-Operation-Id in: header required: false - schema: minLength: 0 type: string default: markdown description: "The formatting language used to parse rich text field values. Present and **required** if an only if the request contains a field with type \"**Rich Text**.\"\n\nValid values:\n * `markdown`\n * `html`\n" name: format in: query required: false - schema: type: boolean description: 'Optional parameter to strip unsupported formats in rich text fields. When this parameter is included, the unsupported formats in rich text fields will be stripped and saved as plain text; otherwise if this parameter is not included, unsupported formats will return an error. ' name: stripUnsupportedFormats in: query required: false - schema: minLength: 0 type: string description: 'Comma-separated list of top-level fields to apply from the template. If provided, only the fields specified will be applied to the entity. Ignored if **`templateId`** is not provided. ' name: templateFields in: query required: false - schema: minLength: 0 type: string description: 'The external ID of the template to apply to the entity **NOTE:** Some fields that are part of the provided template but not present in the API will be applied - e.g. Linked Accounts ' name: templateId in: query required: false tags: - Knowledge Manager summary: 'Entities: Update' description: 'Update the Entity with the given ID **NOTE** * If the **`v`** parameter is `20240221` or later: returned Entity replaces the **`categoryIds`** field with the **`categories`** field. ' 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.\n\n```\nEligible For: \n * atm\n * event\n * faq\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * job\n * location\n * restaurant\n```" name: minLength: 0 maxLength: 5000 type: string description: "\n\n\nCannot Include:\n* HTML markup\n\nFiltering Type: `text`\n\n```\nEligible For: \n * atm\n * board\n * brand\n * card\n * contactCard\n * event\n * faq\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * helpArticle\n * hotel\n * hotelRoomType\n * job\n * location\n * organization\n * product\n * restaurant\n```" 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)\n\nMust be a valid address\nCannot be a P.O. Box\n\nIf the entity is an `event`, either an **`address`** value or a **`linkedLocation`** value can be provided.\n\nFiltering Type: `object`\n\n```\nEligible For: \n * atm\n * event\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * restaurant\n```" acceptingNewPatients: type: boolean description: "Indicates whether the healthcare provider is accepting new patients.\n\nFiltering Type: `boolean`\n\n```\nEligible For: \n * healthcareFacility\n * healthcareProfessional\n```" acceptsReservations: type: boolean description: "Indicates whether the entity accepts reservations.\n\nFiltering Type: `boolean`\n\n```\nEligible For: \n * restaurant\n```" 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.\n\nEach 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.\nSimilarly, holiday access hours are represented by the `holidayHours` sub-field.\nSetting the `reopenDate` sub-field indicates that the business is temporarily closed and will reopen on the specified date.\nSPECIAL CASES:\n* 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.\n* 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.\n* If you are providing `openIntervals`, you may not set `isClosed` to true for that day.\n\nFiltering Type: `hours`\n\n```\nEligible For: \n * atm\n * healthcareFacility\n * hotel\n * location\n * restaurant\n```" additionalHoursText: minLength: 0 maxLength: 255 type: string description: "Additional information about hours that does not fit in **`hours`** (e.g., `\"Closed during the winter\"`)\n\nFiltering Type: `text`\n\n```\nEligible For: \n * atm\n * contactCard\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * restaurant\n```" additionalPromotingLocations: description: "If other locations are promoting this event, a list of those locations' **`id`**s in the Yext Knowledge Manager\n\n\nArray must be ordered.\n\n\nFiltering Type: `list of entityId`\n\n```\nEligible For: \n * event\n```" 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`.\n\nFiltering Type: `boolean`\n\n```\nEligible For: \n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * restaurant\n```" admittingHospitals: description: "A list of hospitals where the healthcare professional admits patients\n\n\nArray must be ordered.\n\nArray may have a maximum of 100 elements.\n\nArray item description:\n\n>Cannot Include:\n>* HTML markup\n\nFiltering Type: `list of text`\n\n```\nEligible For: \n * healthcareProfessional\n```" 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.\n\nFiltering Type: `option`\n\n```\nEligible For: \n * hotel\n```" 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\n\nFiltering Type: `object`\n\n```\nEligible For: \n * event\n```" 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.\n\nFiltering Type: `option`\n\n```\nEligible For: \n * hotel\n```" 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.\n\nFiltering Type: `option`\n\n```\nEligible For: \n * hotel\n```" allInclusive: enum: - ALL_INCLUSIVE_RATES_AVAILABLE - ALL_INCLUSIVE_RATES_ONLY - NOT_APPLICABLE type: string description: "Indicates whether the entity offers all-inclusive rates.\n\nFiltering Type: `option`\n\n```\nEligible For: \n * hotel\n```" alternateNames: description: "Other names for your business that you would like us to use when tracking your search performance\n\n\nArray must be ordered.\n\nArray may have a maximum of 3 elements.\n\nArray item description:\n\n>Cannot Include:\n>* HTML markup\n\nFiltering Type: `list of text`\n\n```\nEligible For: \n * atm\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * organization\n * restaurant\n```" 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.\n\nIf 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.\n\nFiltering Type: `text`\n\n```\nEligible For: \n * atm\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * restaurant\n```" alternateWebsites: description: "Other websites for your business that we should search for when tracking your search performance\n\n\nArray must be ordered.\n\nArray may have a maximum of 3 elements.\n\nArray item description:\n\n>Cannot Include:\n>* common domain names, e.g., google.com, youtube.com, etc.\n\nFiltering Type: `list of text`\n\n```\nEligible For: \n * atm\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * organization\n * restaurant\n```" 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\n\nFiltering Type: `text`\n\n```\nEligible For: \n * brand\n * financialProfessional\n * hotel\n * location\n * restaurant\n```" answer: description: "The answer to the frequently asked question represented by this entity\n\n\nCharacter limit: 0 .. 15000\n\nSupported formats include:\n* BOLD\n* ITALICS\n* UNDERLINE\n* BULLETED_LIST\n* NUMBERED_LIST\n* HYPERLINK\n* IMAGE\n* CODE_SPAN\n* HEADINGS\n\n```\nEligible For: \n * faq\n```" type: string format: rich-text appleActionLinks: description: "Use this field to add action links to your Apple Listings.\n\nThe call to action category will be displayed on the action link button.\n\nThe App Store URL should contain a valid link to the landing page of an App in the Apple App Store.\n\nThe Quick Link URL is where a user is taken when an action link is clicked by a user.\n\nThe 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.\n\n\nArray must be ordered.\n\n\nFiltering Type: `list of object`\n\n```\nEligible For: \n * atm\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * restaurant\n```" 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\n\nFiltering Type: `text`\n\n```\nEligible For: \n * atm\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * restaurant\n```" appleBusinessId: minLength: 0 pattern: ^\d*\.?\d*$ type: string description: "The ID associated with an individual Business Folder in your Apple account\n\nFiltering Type: `text`\n\n```\nEligible For: \n * atm\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * restaurant\n```" appleCompanyId: minLength: 0 pattern: ^\d*\.?\d*$ type: string description: "The ID associated with your Apple account. Numerical values only\n\nFiltering Type: `text`\n\n```\nEligible For: \n * atm\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * restaurant\n```" appleCoverPhoto: required: - url additionalProperties: false type: object description: "The cover photo for the entity''s Apple profile\n\n\nImage must be at least 1600 x 1040 pixels\n\nImage may be no more than 4864 x 3163 pixels\n\nSupported Aspect Ratios:\n* 154 x 100\n\n**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.\n\n\nFiltering Type: `object`\n\n```\nEligible For: \n * atm\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * restaurant\n```" 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.\nNOTE: The names of Brands and their respective Locations within an Apple Business Connect Account must match identically.\nCannot Include:\nHTML markup \n\n\nCannot Include:\n* HTML markup\n\nFiltering Type: `text`\n\n```\nEligible For: \n * atm\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * restaurant\n```" applicationUrl: minLength: 0 format: uri type: string description: "The application URL\n\nFiltering Type: `text`\n\n```\nEligible For: \n * job\n```" associations: description: "Association memberships relevant to the entity (e.g., `\"New York Doctors Association\"`)\nAll strings must be non-empty when trimmed of whitespace.\n\n\n\nArray must be ordered.\n\nArray may have a maximum of 100 elements.\n\nArray item description:\n\n>Cannot Include:\n>* HTML markup\n\nFiltering Type: `list of text`\n\n```\nEligible For: \n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * restaurant\n```" 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.\nA `virtualLocationUrl` must be specified for online and mixed events.\n\nFiltering Type: `object`\n\n```\nEligible For: \n * event\n```" attire: enum: - UNSPECIFIED - DRESSY - CASUAL - FORMAL type: string description: "The formality of clothing typically worn at this restaurant\n\nFiltering Type: `option`\n\n```\nEligible For: \n * restaurant\n```" babysittingOffered: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: "Indicates whether the entity offers babysitting.\n\nFiltering Type: `option`\n\n```\nEligible For: \n * hotel\n```" baggageStorage: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: "Indicates whether the entity offers baggage storage pre check-in and post check-out.\n\nFiltering Type: `option`\n\n```\nEligible For: \n * hotel\n```" bar: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: "Indicates whether the entity has an indoor or outdoor bar onsite.\n\nFiltering Type: `option`\n\n```\nEligible For: \n * hotel\n```" beachAccess: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: "Indicates whether the entity has access to a beach.\n\nFiltering Type: `option`\n\n```\nEligible For: \n * hotel\n```" beachFrontProperty: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: "Indicates whether the entity is physically located next to a beach.\n\nFiltering Type: `option`\n\n```\nEligible For: \n * hotel\n```" bicycles: enum: - BICYCLE_RENTALS - BICYCLE_RENTALS_FOR_FREE - NOT_APPLICABLE type: string description: "Indicates whether the entity offers bicycles for rent or for free.\n\nFiltering Type: `option`\n\n```\nEligible For: \n * hotel\n```" 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\n\nFiltering Type: `object`\n\n```\nEligible For: \n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * organization\n * restaurant\n```" 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.\n\nFiltering Type: `option`\n\n```\nEligible For: \n * hotel\n```" brands: description: "Brands sold by this entity\nAll strings must be non-empty when trimmed of whitespace.\n\n\n\nArray must be ordered.\n\nArray may have a maximum of 100 elements.\n\nArray item description:\n\n>Cannot Include:\n>* HTML markup\n\nFiltering Type: `list of text`\n\n```\nEligible For: \n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * restaurant\n```" 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.\n\nFiltering Type: `option`\n\n```\nEligible For: \n * hotel\n```" 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.\n\nEach 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.\nSimilarly, holiday brunch hours are represented by the `holidayHours` sub-field.\nSetting the `reopenDate` sub-field indicates that the business is temporarily closed and will reopen on the specified date.\nSPECIAL CASES:\n* 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.\n* 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.\n* If you are providing `openIntervals`, you may not set `isClosed` to true for that day.\n\nFiltering Type: `hours`\n\n```\nEligible For: \n * hotel\n * location\n * restaurant\n```" businessCenter: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: "Indicates whether the entity has a business center.\n\nFiltering Type: `option`\n\n```\nEligible For: \n * hotel\n```" 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\n\nFiltering Type: `object`\n\n```\nEligible For: \n * financialProfessional\n * healthcareFacility\n * hotel\n * location\n * restaurant\n```" carRental: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: "Indicates whether the entity offers car rental.\n\nFiltering Type: `option`\n\n```\nEligible For: \n * hotel\n```" casino: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: "Indicates whether the entity has a casino on premise or nearby.\n\nFiltering Type: `option`\n\n```\nEligible For: \n * hotel\n```" categories: additionalProperties: false type: object properties: {} description: "Yext Categories. (Supported for versions > 20240220)\n\nA map of category list external IDs (i.e. \"yext\") to a list of category IDs.\n\nIDs must be valid and selectable (i.e., cannot be parent categories).\n\nPartial updates are accepted, meaning sending only the \"yext\" property will have no effect on any category list except the \"yext\" category. \n\nFiltering Type: `object`\n\n```\nEligible For: \n * atm\n * event\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * restaurant\n```" categoryIds: uniqueItems: false type: array items: minLength: 0 type: string description: 'Filtering Type: `text`' description: "Yext Category IDs. (Deprecated: For versions > 20240220)\n\nIDs must be valid and selectable (i.e., cannot be parent categories).\n\nNOTE: 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.\n\n\nFiltering Type: `list of text`\n\n```\nEligible For: \n * atm\n * event\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * restaurant\n```" catsAllowed: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: "Indicates if the entity is cat friendly.\n\nFiltering Type: `option`\n\n```\nEligible For: \n * hotel\n```" certifications: description: "A list of the certifications held by the healthcare professional\n**NOTE:** This field is only available to locations whose **`entityType`** is `healthcareProfessional`.\n\n\n\nArray must be ordered.\n\nArray may have a maximum of 100 elements.\n\nArray item description:\n\n>Cannot Include:\n>* HTML markup\n\nFiltering Type: `list of text`\n\n```\nEligible For: \n * financialProfessional\n * healthcareProfessional\n```" 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\n\nFiltering Type: `time`\n\n```\nEligible For: \n * hotel\n```" checkOutTime: format: time type: string description: "The check-out time\n\nFiltering Type: `time`\n\n```\nEligible For: \n * hotel\n```" classificationRating: pattern: ^\d*\.?\d*$ type: string description: "The 1 to 5 star rating of the entitiy based on its services and facilities.\n\nFiltering Type: `decimal`\n\n```\nEligible For: \n * hotel\n```" closed: type: boolean description: "Indicates whether the entity is closed\n\nFiltering Type: `boolean`\n\n```\nEligible For: \n * atm\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * restaurant\n```" concierge: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: "Indicates whether the entity offers concierge service.\n\nFiltering Type: `option`\n\n```\nEligible For: \n * hotel\n```" conditionsTreated: description: "A list of the conditions treated by the healthcare provider\n\n\nArray must be ordered.\n\nArray may have a maximum of 100 elements.\n\nArray item description:\n\n>Cannot Include:\n>* HTML markup\n\nFiltering Type: `list of text`\n\n```\nEligible For: \n * healthcareFacility\n * healthcareProfessional\n```" 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.\n\nFiltering Type: `option`\n\n```\nEligible For: \n * hotel\n```" covidMessaging: minLength: 0 maxLength: 15000 type: string description: "Information or messaging related to COVID-19.\n\nFiltering Type: `text`\n\n```\nEligible For: \n * healthcareFacility\n * healthcareProfessional\n * location\n```" covidTestAppointmentUrl: minLength: 0 format: uri type: string description: "An appointment URL for scheduling a COVID-19 test.\n\nFiltering Type: `text`\n\n```\nEligible For: \n * healthcareFacility\n * location\n```" covidTestingAppointmentRequired: type: boolean description: "Indicates whether an appointment is required for a COVID-19 test.\n\nFiltering Type: `boolean`\n\n```\nEligible For: \n * healthcareFacility\n * location\n```" covidTestingDriveThroughSite: type: boolean description: "Indicates whether location is a drive-through site for COVID-19 tests.\n\nFiltering Type: `boolean`\n\n```\nEligible For: \n * healthcareFacility\n * location\n```" covidTestingIsFree: type: boolean description: "Indicates whether location offers free COVID-19 testing.\n\nFiltering Type: `boolean`\n\n```\nEligible For: \n * healthcareFacility\n * location\n```" covidTestingPatientRestrictions: type: boolean description: "Indicates whether there are patient restrictions for COVID-19 testing.\n\nFiltering Type: `boolean`\n\n```\nEligible For: \n * healthcareFacility\n * location\n```" covidTestingReferralRequired: type: boolean description: "Indicates whether a referral is required for COVID-19 testing.\n\nFiltering Type: `boolean`\n\n```\nEligible For: \n * healthcareFacility\n * location\n```" covidTestingSiteInstructions: minLength: 0 maxLength: 15000 type: string description: "Information or instructions for the COVID-19 testing site.\n\nFiltering Type: `text`\n\n```\nEligible For: \n * healthcareFacility\n * location\n```" covidVaccineAppointmentRequired: type: boolean description: "Indicates whether an appointment is required for a COVID-19 vaccine.\n\nFiltering Type: `boolean`\n\n```\nEligible For: \n * healthcareFacility\n * location\n```" covidVaccineDriveThroughSite: type: boolean description: "Indicates whether location is a drive-through site for COVID-19 vaccines.\n\nFiltering Type: `boolean`\n\n```\nEligible For: \n * healthcareFacility\n * location\n```" covidVaccineInformationUrl: minLength: 0 format: uri type: string description: "An information URL for more information about COVID-19 vaccines.\n\nFiltering Type: `text`\n\n```\nEligible For: \n * healthcareFacility\n * location\n```" covidVaccinePatientRestrictions: type: boolean description: "Indicates whether there are patient restrictions for a COVID-19 vaccine.\n\nFiltering Type: `boolean`\n\n```\nEligible For: \n * healthcareFacility\n * location\n```" covidVaccineReferralRequired: type: boolean description: "Indicates whether a referral is required for a COVID-19 vaccine.\n\nFiltering Type: `boolean`\n\n```\nEligible For: \n * healthcareFacility\n * location\n```" covidVaccineSiteInstructions: minLength: 0 maxLength: 15000 type: string description: "Information or instructions for the COVID-19 vaccination site.\n\nFiltering Type: `text`\n\n```\nEligible For: \n * healthcareFacility\n * location\n```" 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.\n\nFiltering Type: `list of option`\n\n```\nEligible For: \n * healthcareFacility\n * location\n```" currencyExchange: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: "Indicates whether the entity offers currency exchange services.\n\nFiltering Type: `option`\n\n```\nEligible For: \n * hotel\n```" customKeywords: description: "Additional keywords you would like us to use when tracking your search performance\n\n\nArray must be ordered.\n\nArray may have a maximum of 5 elements.\n\n\nFiltering Type: `list of text`\n\n```\nEligible For: \n * atm\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * organization\n * restaurant\n```" 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\n\nFiltering Type: `date`\n\n```\nEligible For: \n * job\n```" degrees: description: "A list of the degrees earned by the healthcare professional\n\n\nArray must be ordered.\n\n\nFiltering Type: `list of option`\n\n```\nEligible For: \n * healthcareProfessional\n```" 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.\n\nEach 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.\nSimilarly, holiday delivery hours are represented by the `holidayHours` sub-field.\nSetting the `reopenDate` sub-field indicates that the business is temporarily closed and will reopen on the specified date.\nSPECIAL CASES:\n* 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.\n* 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.\n* If you are providing `openIntervals`, you may not set `isClosed` to true for that day.\n\nFiltering Type: `hours`\n\n```\nEligible For: \n * location\n * restaurant\n```" description: minLength: 10 maxLength: 15000 type: string description: "A description of the entity\n\n\nCannot Include:\n* HTML markup\n\nFiltering Type: `text`\n\n```\nEligible For: \n * atm\n * contactCard\n * event\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * job\n * location\n * organization\n * restaurant\n```" 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\n\nFiltering Type: `object`\n\n```\nEligible For: \n * atm\n * event\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * job\n * location\n * restaurant\n```" doctorOnCall: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: "Indicates whether the entity has a doctor on premise or on call.\n\nFiltering Type: `option`\n\n```\nEligible For: \n * hotel\n```" dogsAllowed: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: "Indicates if the entity is dog friendly.\n\nFiltering Type: `option`\n\n```\nEligible For: \n * hotel\n```" 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.\n\nEach 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.\nSimilarly, holiday drive-through hours are represented by the `holidayHours` sub-field.\nSetting the `reopenDate` sub-field indicates that the business is temporarily closed and will reopen on the specified date.\nSPECIAL CASES:\n* 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.\n* 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.\n* If you are providing `openIntervals`, you may not set `isClosed` to true for that day.\n\nFiltering Type: `hours`\n\n```\nEligible For: \n * atm\n * location\n * restaurant\n```" 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\n\nFiltering Type: `object`\n\n```\nEligible For: \n * atm\n * event\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * restaurant\n```" educationList: description: "Information about the education or training completed by the healthcare professional\n\n\nArray must be ordered.\n\n\nFiltering Type: `list of object`\n\n```\nEligible For: \n * healthcareProfessional\n```" 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.\n\nFiltering Type: `option`\n\n```\nEligible For: \n * hotel\n```" elevator: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: "Indicates whether the entity has an elevator.\n\nFiltering Type: `option`\n\n```\nEligible For: \n * hotel\n```" ellipticalMachine: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: "Indicates whether the entity has an elliptical machine.\n\nFiltering Type: `option`\n\n```\nEligible For: \n * hotel\n```" emails: description: "Emails addresses for this entity's point of contact\n\nMust be valid email addresses\n\n\n\nArray must be ordered.\n\nArray may have a maximum of 5 elements.\n\n\nFiltering Type: `list of text`\n\n```\nEligible For: \n * contactCard\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * organization\n * restaurant\n```" 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.\n\nFiltering Type: `option`\n\n```\nEligible For: \n * job\n```" eventStatus: enum: - SCHEDULED - RESCHEDULED - POSTPONED - CANCELED - EVENT_MOVED_ONLINE type: string description: "Information on whether the event will take place as scheduled\n\nFiltering Type: `option`\n\n```\nEligible For: \n * event\n```" facebookAbout: minLength: 0 maxLength: 255 type: string description: "A description of the entity to be used in the \"About You\" section on Facebook\n\nFiltering Type: `text`\n\n```\nEligible For: \n * atm\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * restaurant\n```" 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\n\nValid contents of **`value`** depends on the Call-to-Action's **`type`**:\n* `NONE`: (optional)\n* `BOOK_NOW`: URL\n* `CALL_NOW`: Phone number\n* `CONTACT_US`: URL\n* `SEND_MESSAGE`: Any string\n* `USE_APP`: URL\n* `PLAY_GAME`: URL\n* `SHOP_NOW`: URL\n* `SIGN_UP`: URL\n* `WATCH_VIDEO`: URL\n* `SEND_EMAIL`: Email address\n* `LEARN_MORE`: URL\n* `PURCHASE_GIFT_CARDS`: URL\n* `ORDER_NOW`: URL\n* `FOLLOW_PAGE`: Any string\n\nFiltering Type: `object`\n\n```\nEligible For: \n * atm\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * restaurant\n```" facebookCoverPhoto: required: - url additionalProperties: false type: object description: "The cover photo for the entity's Facebook profile\n\nDisplayed as a 851 x 315 pixel image\n\nYou may need a cover photo in order for your listing to appear on Facebook. Please check your listings tab to learn more.\n\n\nImage must be at least 400 x 150 pixels\n\nImage area (width x height) may be no more than 41000000 pixels\n\nImage may be no more than 30000 x 30000 pixels\n\nSupported Aspect Ratios:\n* 1 x 1\n* 4 x 3\n* 3 x 2\n* 5 x 3\n* 16 x 9\n* 3 x 1\n* 2 x 3\n* 5 x 7\n* 4 x 5\n* 4 x 1\n\n**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.\n\n\nFiltering Type: `object`\n\n```\nEligible For: \n * atm\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * restaurant\n```" 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.\n\n\nCannot Include:\n* HTML markup\n\nFiltering Type: `text`\n\n```\nEligible For: \n * atm\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * restaurant\n```" 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.\n\nFiltering Type: `text`\n\n```\nEligible For: \n * atm\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * restaurant\n```" facebookOverrideCity: minLength: 0 type: string description: "The city to be displayed on this entity's Facebook profile\n\nFiltering Type: `text`\n\n```\nEligible For: \n * atm\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * restaurant\n```" facebookPageUrl: minLength: 0 type: string description: "URL for the entity's Facebook Page.\n\nValid formats:\n\n- facebook.com/profile.php?id=[numId]\n- facebook.com/group.php?gid=[numId]\n- facebook.com/groups/[numId]\n- facebook.com/[Name]\n- facebook.com/pages/[Name]/[numId]\n- facebook.com/people/[Name]/[numId]\n\nwhere [Name] is a String and [numId] is an Integer\nThe success response will contain a warning message explaining why the URL wasn't stored in the system.\n\nFiltering Type: `text`\n\n```\nEligible For: \n * atm\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * organization\n * restaurant\n```" 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\n\nFiltering Type: `text`\n\n```\nEligible For: \n * atm\n * brand\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * restaurant\n```" facebookProfilePhoto: required: - url additionalProperties: false type: object description: "The profile picture for the entity's Facebook profile\n\nYou must have a profile picture in order for your listing to appear on Facebook.\n\n\nImage must be at least 180 x 180 pixels\n\nImage area (width x height) may be no more than 41000000 pixels\n\nImage may be no more than 30000 x 30000 pixels\n\nSupported Aspect Ratios:\n* 1 x 1\n* 4 x 3\n* 3 x 2\n* 5 x 3\n* 16 x 9\n* 3 x 1\n* 2 x 3\n* 5 x 7\n* 4 x 5\n* 4 x 1\n\n**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.\n\n\nFiltering Type: `object`\n\n```\nEligible For: \n * atm\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * restaurant\n```" 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\n\nFiltering Type: `text`\n\n```\nEligible For: \n * atm\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * restaurant\n```" 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.\n\nFiltering Type: `text`\n\n```\nEligible For: \n * atm\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * restaurant\n```" 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).\n\nFiltering Type: `text`\n\n```\nEligible For: \n * atm\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * restaurant\n```" fax: minLength: 0 type: string description: "Must be a valid fax number.\n\nIf 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.\n\nFiltering Type: `text`\n\n```\nEligible For: \n * atm\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * restaurant\n```" 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\n\nFiltering Type: `object`\n\n```\nEligible For: \n * atm\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * restaurant\n```" firstName: minLength: 0 maxLength: 35 type: string description: "The first name of the healthcare professional\n\n\nCannot Include:\n* a URL or domain name\n* HTML markup\n\nFiltering Type: `text`\n\n```\nEligible For: \n * healthcareProfessional\n```" firstPartyReviewPage: minLength: 0 type: string description: "Link to the review-collection page, where consumers can leave first-party reviews\n\n```\nEligible For: \n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * restaurant\n```" fitnessCenter: enum: - FITNESS_CENTER_AVAILABLE - FITNESS_CENTER_AVAILABLE_FOR_FREE - NOT_APPLICABLE type: string description: "Indicates whether the entity has a fitness center.\n\nFiltering Type: `option`\n\n```\nEligible For: \n * hotel\n```" floorCount: multipleOf: 1 minimum: 0 type: number description: "The number of floors the entity has from ground floor to top floor.\n\nFiltering Type: `integer`\n\n```\nEligible For: \n * hotel\n```" freeWeights: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: "Indicates whether the entity has free weights.\n\nFiltering Type: `option`\n\n```\nEligible For: \n * hotel\n```" frequentlyAskedQuestions: description: "A list of questions that are frequently asked about this entity\n\n\nArray must be ordered.\n\nArray may have a maximum of 100 elements.\n\n\nFiltering Type: `list of object`\n\n```\nEligible For: \n * atm\n * event\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * restaurant\n```" 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.\n\nFiltering Type: `option`\n\n```\nEligible For: \n * hotel\n```" fullyVaccinatedStaff: type: boolean description: "Indicates whether the staff is vaccinated against COVID-19.\n\nFiltering Type: `boolean`\n\n```\nEligible For: \n * healthcareFacility\n * hotel\n * location\n * restaurant\n```" gameRoom: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: "Indicates whether the entity has a game room.\n\nFiltering Type: `option`\n\n```\nEligible For: \n * hotel\n```" gender: enum: - UNSPECIFIED - FEMALE - MALE - NONBINARY - TRANSGENDER_FEMALE - TRANSGENDER_MALE - OTHER - PREFER_NOT_TO_DISCLOSE type: string description: "The gender of the healthcare professional\n\nFiltering Type: `option`\n\n```\nEligible For: \n * healthcareProfessional\n```" geomodifier: minLength: 0 type: string description: "Provides additional information on where the entity can be found (e.g., `Times Square`, `Global Center Mall`)\n\nFiltering Type: `text`\n\n```\nEligible For: \n * atm\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * restaurant\n```" giftShop: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: "Indicates whether the entity has a gift shop.\n\nFiltering Type: `option`\n\n```\nEligible For: \n * hotel\n```" 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.\n\nFiltering Type: `option`\n\n```\nEligible For: \n * hotel\n```" 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.\n\nValid 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.\n\nKeyword 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`).\n\n* 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\" ] }]`)\n* 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\" ]}`)\n\n**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.\n\nFiltering Type: `object`\n\n```\nEligible For: \n * atm\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * restaurant\n```" googleCoverPhoto: required: - url additionalProperties: false type: object description: "The cover photo for the entity's Google profile\n\n\nImage must be at least 250 x 250 pixels\n\n\nFiltering Type: `object`\n\n```\nEligible For: \n * atm\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * restaurant\n```" 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.\nMust be a valid phone number.\nIf 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. \n\nFiltering 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.\n\nNOTE: 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.\n\nFiltering Type: `object`\n\n```\nEligible For: \n * atm\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * restaurant\n```" googleMyBusinessLabels: description: "Google Business Profile Labels help users organize their locations into groups within GBP.\n\n\nArray must be ordered.\n\nArray may have a maximum of 10 elements.\n\nArray item description:\n\n>Cannot Include:\n>* HTML markup\n\nFiltering Type: `list of text`\n\n```\nEligible For: \n * atm\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * restaurant\n```" 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.\n\nFiltering Type: `text`\n\n```\nEligible For: \n * atm\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * restaurant\n```" googleProfilePhoto: required: - url additionalProperties: false type: object description: "The profile photo for the entity's Google profile\n\n\nImage must be at least 250 x 250 pixels\n\nImage may be no more than 5000 x 5000 pixels\n\nSupported Aspect Ratios:\n* 1 x 1\n\n**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.\n\n\nFiltering Type: `object`\n\n```\nEligible For: \n * atm\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * restaurant\n```" 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).\n\nFor 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.\n\nFiltering Type: `text`\n\n```\nEligible For: \n * atm\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * restaurant\n```" 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.\n\nEach 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.\nSimilarly, holiday happy hours are represented by the `holidayHours` sub-field.\nSetting the `reopenDate` sub-field indicates that the business is temporarily closed and will reopen on the specified date.\nSPECIAL CASES:\n* 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.\n* 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.\n* If you are providing `openIntervals`, you may not set `isClosed` to true for that day.\n\nFiltering Type: `hours`\n\n```\nEligible For: \n * hotel\n * location\n * restaurant\n```" headshot: required: - url additionalProperties: false type: object description: "A portrait of the healthcare professional\n\nFiltering Type: `object`\n\n```\nEligible For: \n * contactCard\n * financialProfessional\n * healthcareProfessional\n```" 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\n\nFiltering Type: `text`\n\n```\nEligible For: \n * job\n```" holidayHoursConversationEnabled: type: boolean description: "Indicates whether holiday-hour confirmation alerts are enabled for the Yext Knowledge Assistant for this entity\n\nFiltering Type: `boolean`\n\n```\nEligible For: \n * atm\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * restaurant\n```" horsebackRiding: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: "Indicates whether the entity offers horseback riding.\n\nFiltering Type: `option`\n\n```\nEligible For: \n * hotel\n```" hotTub: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: "Indicates whether the entity has a hot tub.\n\nFiltering Type: `option`\n\n```\nEligible For: \n * hotel\n```" 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.\n\nEach 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.\nSimilarly, holiday hours are represented by the `holidayHours` sub-field.\nSetting the `reopenDate` sub-field indicates that the business is temporarily closed and will reopen on the specified date.\nSPECIAL CASES:\n* 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.\n* 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.\n* If you are providing `openIntervals`, you may not set `isClosed` to true for that day.\n\nFiltering Type: `hours`\n\n```\nEligible For: \n * atm\n * contactCard\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * restaurant\n```" housekeeping: enum: - HOUSEKEEPING_AVAILABLE - HOUSEKEEPING_AVAILABLE_DAILY - NOT_APPLICABLE type: string description: "Indicates whether the entity offers housekeeping services.\n\nFiltering Type: `option`\n\n```\nEligible For: \n * hotel\n```" 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.\n\nFiltering Type: `text`\n\n```\nEligible For: \n * atm\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * restaurant\n```" indoorPoolCount: multipleOf: 1 minimum: 0 type: number description: "A count of the number of indoor pools\n\nFiltering Type: `integer`\n\n```\nEligible For: \n * hotel\n```" instagramHandle: minLength: 0 maxLength: 30 type: string description: "Valid Instagram username for the entity without the leading \"@\" (e.g., `NewCityAuto`)\n\nFiltering Type: `text`\n\n```\nEligible For: \n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * organization\n * restaurant\n```" insuranceAccepted: description: "A list of insurance policies accepted by the healthcare provider\n\n\nArray must be ordered.\n\nArray may have a maximum of 100 elements.\n\nArray item description:\n\n>Cannot Include:\n>* HTML markup\n\nFiltering Type: `list of text`\n\n```\nEligible For: \n * healthcareFacility\n * healthcareProfessional\n```" 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\n\nFiltering Type: `text`\n\n```\nEligible For: \n * brand\n * financialProfessional\n * hotel\n * location\n * restaurant\n```" isClusterPrimary: type: boolean description: "Indicates whether the healthcare entity is the primary entity in its group\n\nFiltering Type: `boolean`\n\n```\nEligible For: \n * healthcareProfessional\n```" isFreeEvent: type: boolean description: "Indicates whether or not the event is free\n\nFiltering Type: `boolean`\n\n```\nEligible For: \n * event\n```" isoRegionCode: minLength: 0 type: string description: "The ISO 3166-2 region code for the entity\n\nYext 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.\n\nFiltering Type: `text`\n\n```\nEligible For: \n * atm\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * restaurant\n```" keywords: description: "Keywords that describe the entity.\n\nAll strings must be non-empty when trimmed of whitespace.\n\n\n\nArray must be ordered.\n\nArray may have a maximum of 100 elements.\n\nArray item description:\n\n>Cannot Include:\n>* HTML markup\n\nFiltering Type: `list of text`\n\n```\nEligible For: \n * atm\n * card\n * event\n * faq\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * helpArticle\n * hotel\n * job\n * location\n * product\n * restaurant\n```" 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.\n\nFiltering Type: `option`\n\n```\nEligible For: \n * hotel\n```" kidsClub: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: "Indicates if the property has a Kids Club.\n\nFiltering Type: `option`\n\n```\nEligible For: \n * hotel\n```" kidsStayFree: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: "Indicates whether the entity allows kids to stay free.\n\nFiltering Type: `option`\n\n```\nEligible For: \n * hotel\n```" 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.\n\nEach 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.\nSimilarly, holiday kitchen hours are represented by the `holidayHours` sub-field.\nSetting the `reopenDate` sub-field indicates that the business is temporarily closed and will reopen on the specified date.\nSPECIAL CASES:\n* 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.\n* 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.\n* If you are providing `openIntervals`, you may not set `isClosed` to true for that day.\n\nFiltering Type: `hours`\n\n```\nEligible For: \n * hotel\n * location\n * restaurant\n```" 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.\n\n**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.\n\nFiltering Type: `opaque`\n\n```\nEligible For: \n * atm\n * board\n * brand\n * card\n * contactCard\n * event\n * faq\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * helpArticle\n * hotel\n * hotelRoomType\n * job\n * location\n * organization\n * product\n * restaurant\n```" landingPageUrl: minLength: 0 format: uri type: string description: "The URL of this entity's Landing Page that was created with Yext Pages\n\nFiltering Type: `text`\n\n```\nEligible For: \n * atm\n * card\n * event\n * faq\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * helpArticle\n * hotel\n * job\n * location\n * product\n * restaurant\n```" languages: description: "The langauges in which consumers can commicate with this entity or its staff members\nAll strings must be non-empty when trimmed of whitespace.\n\n\n\nArray must be ordered.\n\nArray may have a maximum of 100 elements.\n\nArray item description:\n\n>Cannot Include:\n>* HTML markup\n\nFiltering Type: `list of text`\n\n```\nEligible For: \n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * restaurant\n```" 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\n\n\nCannot Include:\n* a URL or domain name\n* HTML markup\n\nFiltering Type: `text`\n\n```\nEligible For: \n * healthcareProfessional\n```" laundry: enum: - FULL_SERVICE - SELF_SERVICE - NOT_APPLICABLE type: string description: "Indicates whether the entity offers laundry services.\n\nFiltering Type: `option`\n\n```\nEligible For: \n * hotel\n```" lazyRiver: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: "Indicates if the property has a lazy river\n\nFiltering Type: `option`\n\n```\nEligible For: \n * hotel\n```" lifeguard: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: "Indicates if the property has a lifeguard on duty\n\nFiltering Type: `option`\n\n```\nEligible For: \n * hotel\n```" linkedInUrl: minLength: 0 format: uri type: string description: "URL for your LinkedIn account, format should be https://www.linkedin.com/in/yourUsername\n\nFiltering Type: `text`\n\n```\nEligible For: \n * contactCard\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * organization\n * restaurant\n```" linkedLocation: type: string description: "location ID of the event location, if the event is held at a location managed in the Yext Knowledge Manager\n\nFiltering Type: `entityId`\n\n```\nEligible For: \n * contactCard\n * event\n```" 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.\n\nFiltering Type: `text`\n\n```\nEligible For: \n * atm\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * restaurant\n```" localShuttle: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: "Indicates whether the entity offers local shuttle services.\n\nFiltering Type: `option`\n\n```\nEligible For: \n * hotel\n```" 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.\n\nFiltering Type: `entityId`\n\n```\nEligible For: \n * atm\n```" 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\n\nFiltering Type: `object`\n\n```\nEligible For: \n * job\n```" locationType: enum: - LOCATION - HEALTHCARE_FACILITY - HEALTHCARE_PROFESSIONAL - ATM - RESTAURANT - HOTEL type: string description: "Indicates the entity's type, if it is not an event\n\nFiltering Type: `option`\n\n```\nEligible For: \n * atm\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * restaurant\n```" logo: required: - image additionalProperties: false type: object description: "An image of the entity's logo\n\n\nSupported Aspect Ratios:\n* 1 x 1\n\n**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.\n\n\nFiltering Type: `object`\n\n```\nEligible For: \n * atm\n * contactCard\n * faq\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * job\n * location\n * organization\n * restaurant\n```" 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\n\nMust be a valid phone number.\n\nIf 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.\n\nFiltering Type: `text`\n\n```\nEligible For: \n * atm\n * contactCard\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * organization\n * restaurant\n```" massage: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: "Indicates whether the entity offers massage services.\n\nFiltering Type: `option`\n\n```\nEligible For: \n * hotel\n```" 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\n\nFiltering Type: `integer`\n\n```\nEligible For: \n * hotel\n```" 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\n\nFiltering Type: `integer`\n\n```\nEligible For: \n * hotel\n```" 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\n\nFiltering Type: `list of option`\n\n```\nEligible For: \n * restaurant\n```" meetingRoomCount: multipleOf: 1 minimum: 0 type: number description: "The number of meeting rooms the entity has.\n\nFiltering Type: `integer`\n\n```\nEligible For: \n * hotel\n```" 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\n\nFiltering Type: `object`\n\n```\nEligible For: \n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * restaurant\n```" 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\n\nFiltering Type: `object`\n\n```\nEligible For: \n * hotel\n * location\n * restaurant\n```" middleName: minLength: 0 maxLength: 35 type: string description: "The middle name of the healthcare professional\n\n\nCannot Include:\n* a URL or domain name\n* HTML markup\n\nFiltering Type: `text`\n\n```\nEligible For: \n * healthcareProfessional\n```" mobilePhone: minLength: 0 type: string description: "Must be a valid phone number.\n\nIf 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.\n\nFiltering Type: `text`\n\n```\nEligible For: \n * atm\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * restaurant\n```" mobilityAccessible: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: "Indicates whether the entity is mobility/wheelchair accessible\n\nFiltering Type: `option`\n\n```\nEligible For: \n * hotel\n```" nightclub: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: "Indicates whether the entity has a nightclub.\n\nFiltering Type: `option`\n\n```\nEligible For: \n * hotel\n```" npi: minLength: 0 type: string description: "The National Provider Identifier (NPI) of the healthcare provider\n\nFiltering Type: `text`\n\n```\nEligible For: \n * healthcareFacility\n * healthcareProfessional\n```" nudgeEnabled: type: boolean description: "Indicates whether Knowledge Nudge is enabled for the Yext Knowledge Assistant for this entity\n\nFiltering Type: `boolean`\n\n```\nEligible For: \n * atm\n * faq\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * helpArticle\n * hotel\n * job\n * location\n * organization\n * product\n * restaurant\n```" officeName: minLength: 0 type: string description: "The name of the office where the healthcare professional works, if different from **`name`**\n\nFiltering Type: `text`\n\n```\nEligible For: \n * healthcareProfessional\n```" 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.\n\nEach 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.\nSimilarly, holiday online service hours are represented by the `holidayHours` sub-field.\nSetting the `reopenDate` sub-field indicates that the business is temporarily closed and will reopen on the specified date.\nSPECIAL CASES:\n* 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.\n* 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.\n* If you are providing `openIntervals`, you may not set `isClosed` to true for that day.\n\nFiltering Type: `hours`\n\n```\nEligible For: \n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * location\n * restaurant\n```" openDate: format: date type: string description: "The date that the entity is set to open for the first time.\nMust be formatted in YYYY-MM-DD format.\n\nDate must be on or after 1970-01-01 Date must be before or on 2038-01-01\n\n\nFiltering Type: `date`\n\n```\nEligible For: \n * atm\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * restaurant\n```" 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\n\nFiltering Type: `list of option`\n\n```\nEligible For: \n * organization\n```" 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\n\nFiltering Type: `object`\n\n```\nEligible For: \n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * restaurant\n```" organizerEmail: minLength: 0 format: email type: string description: "Point of contact for the event organizer (not to be published publicly)\n\nFiltering Type: `text`\n\n```\nEligible For: \n * event\n```" organizerName: minLength: 0 type: string description: "Point of contact for the event organizer (not to be published publicly)\n\nFiltering Type: `text`\n\n```\nEligible For: \n * event\n```" organizerPhone: minLength: 0 type: string description: "Point of contact for the event organizer (not to be published publicly)\n\nFiltering Type: `text`\n\n```\nEligible For: \n * event\n```" outdoorPoolCount: multipleOf: 1 minimum: 0 type: number description: "The number of outdoor pools the entity has.\n\nFiltering Type: `integer`\n\n```\nEligible For: \n * hotel\n```" parking: enum: - PARKING_AVAILABLE - PARKING_AVAILABLE_FOR_FREE - NOT_APPLICABLE type: string description: "Indicates whether the entity offers parking services.\n\nFiltering Type: `option`\n\n```\nEligible For: \n * hotel\n```" 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\n\nValid elements depend on the entity's country.\n\n\nFiltering Type: `list of option`\n\n```\nEligible For: \n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * restaurant\n```" performers: description: "Performers at the event\n\n\nArray must be ordered.\n\nArray may have a maximum of 100 elements.\n\n\nFiltering Type: `list of text`\n\n```\nEligible For: \n * event\n```" 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.\n\nFiltering Type: `option`\n\n```\nEligible For: \n * hotel\n```" photoGallery: description: "\n**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.\n\n\n\nArray must be ordered.\n\nArray may have a maximum of 500 elements.\n\nArray item description:\n\n>Supported Aspect Ratios:\n>* 1 x 1\n>* 4 x 3\n>* 3 x 2\n>* 5 x 3\n>* 16 x 9\n>* 3 x 1\n>* 2 x 3\n>* 5 x 7\n>* 4 x 5\n>* 4 x 1\n>\n>**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.\n>\n\nFiltering Type: `list of object`\n\n```\nEligible For: \n * atm\n * event\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * hotelRoomType\n * location\n * organization\n * product\n * restaurant\n```" 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\n\nFiltering Type: `object`\n\n```\nEligible For: \n * atm\n * event\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * restaurant\n```" 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.\n\nEach 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.\nSimilarly, holiday pickup hours are represented by the `holidayHours` sub-field.\nSetting the `reopenDate` sub-field indicates that the business is temporarily closed and will reopen on the specified date.\nSPECIAL CASES:\n* 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.\n* 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.\n* If you are providing `openIntervals`, you may not set `isClosed` to true for that day.\n\nFiltering Type: `hours`\n\n```\nEligible For: \n * healthcareFacility\n * location\n * restaurant\n```" pinterestUrl: minLength: 0 format: uri type: string description: "URL for your Pinterest account, format should be https://www.pinterest.com/yourUsername\n\nFiltering Type: `text`\n\n```\nEligible For: \n * contactCard\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * organization\n * restaurant\n```" 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)\n\nFiltering Type: `option`\n\n```\nEligible For: \n * atm\n * healthcareFacility\n * healthcareProfessional\n * location\n * restaurant\n```" primaryConversationContact: minLength: 0 type: string description: "ID of the user who is the primary Knowledge Assistant contact for the entity\n\nFiltering Type: `option`\n\n```\nEligible For: \n * atm\n * faq\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * helpArticle\n * hotel\n * job\n * location\n * organization\n * product\n * restaurant\n```" privateBeach: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: "Indicates whether the entity has access to a private beach.\n\nFiltering Type: `option`\n\n```\nEligible For: \n * hotel\n```" privateCarService: enum: - PRIVATE_CAR_SERVICE - PRIVATE_CAR_SERVICE_FOR_FREE - NOT_APPLICABLE type: string description: "Indicates whether the entity offers private car services.\n\nFiltering Type: `option`\n\n```\nEligible For: \n * hotel\n```" 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\n\nFiltering Type: `object`\n\n```\nEligible For: \n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * restaurant\n```" products: description: "Products sold by this entity\n\nAll strings must be non-empty when trimmed of whitespace.\n\n\n\nArray must be ordered.\n\nArray may have a maximum of 100 elements.\n\nArray item description:\n\n>Cannot Include:\n>* HTML markup\n\nFiltering Type: `list of text`\n\n```\nEligible For: \n * financialProfessional\n * location\n```" 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\n\nFiltering Type: `boolean`\n\n```\nEligible For: \n * atm\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * organization\n * restaurant\n```" rankTrackingCompetitors: description: "Information about the competitors whose search performance you would like to compare to your own\n\n\nArray must be ordered.\n\nArray may have a maximum of 5 elements.\n\n\nFiltering Type: `list of object`\n\n```\nEligible For: \n * atm\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * organization\n * restaurant\n```" 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\n\nFiltering Type: `boolean`\n\n```\nEligible For: \n * atm\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * organization\n * restaurant\n```" rankTrackingFrequency: enum: - WEEKLY - MONTHLY - QUARTERLY type: string description: "How often we send search queries to track your search performance\n\nFiltering Type: `option`\n\n```\nEligible For: \n * atm\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * organization\n * restaurant\n```" rankTrackingQueryTemplates: description: "The ways in which your keywords will be arranged in the search queries we use to track your performance\n\n\nArray must have a minimum of 2 elements.\n\nArray may have a maximum of 4 elements.\n\n\nFiltering Type: `list of option`\n\n```\nEligible For: \n * atm\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * organization\n * restaurant\n```" 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\n\nFiltering Type: `list of option`\n\n```\nEligible For: \n * atm\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * organization\n * restaurant\n```" 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\n\nFiltering Type: `object`\n\n```\nEligible For: \n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * restaurant\n```" restaurantCount: multipleOf: 1 minimum: 0 type: number description: "The number of restaurants the entity has.\n\nFiltering Type: `integer`\n\n```\nEligible For: \n * hotel\n```" reviewGenerationUrl: minLength: 0 type: string description: "The URL given Review Invitation emails where consumers can leave a review about the entity\n\n```\nEligible For: \n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * restaurant\n```" reviewResponseConversationEnabled: type: boolean description: "Indicates whether Yext Knowledge Assistant review-response conversations are enabled for this entity\n\nFiltering Type: `boolean`\n\n```\nEligible For: \n * atm\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * restaurant\n```" roomCount: multipleOf: 1 minimum: 0 type: number description: "The number of rooms the entity has.\n\nFiltering Type: `integer`\n\n```\nEligible For: \n * hotel\n```" roomService: enum: - ROOM_SERVICE_AVAILABLE - ROOM_SERVICE_AVAILABLE_24_HOURS - NOT_APPLICABLE type: string description: "Indicates whether the entity offers room service.\n\nFiltering Type: `option`\n\n```\nEligible For: \n * hotel\n```" 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\n\nFiltering Type: `object`\n\n```\nEligible For: \n * atm\n * event\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * restaurant\n```" salon: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: "Indicates whether the entity has a salon.\n\nFiltering Type: `option`\n\n```\nEligible For: \n * hotel\n```" sauna: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: "Indicates whether the entity has a sauna.\n\nFiltering Type: `option`\n\n```\nEligible For: \n * hotel\n```" scuba: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: "Indicates whether the entity offers scuba diving.\n\nFiltering Type: `option`\n\n```\nEligible For: \n * hotel\n```" selfParking: enum: - SELF_PARKING_AVAILABLE - SELF_PARKING_AVAILABLE_FOR_FREE - NOT_APPLICABLE type: string description: "Indicates whether the entity offers self parking services.\n\nFiltering Type: `option`\n\n```\nEligible For: \n * hotel\n```" 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.\n\nEach 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.\nSimilarly, holiday senior hours are represented by the `holidayHours` sub-field.\nSetting the `reopenDate` sub-field indicates that the business is temporarily closed and will reopen on the specified date.\nSPECIAL CASES:\n* 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.\n* 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.\n* If you are providing `openIntervals`, you may not set `isClosed` to true for that day.\n\nFiltering Type: `hours`\n\n```\nEligible For: \n * location\n * restaurant\n```" serviceArea: additionalProperties: false type: object properties: places: description: "A list of places served by the entity, where each place is either:\n - a postal code, or\n - the name of a city.\n\n\n\nArray must be ordered.\n\nArray may have a maximum of 200 elements.\n\n\nFiltering 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.\n\n**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.\n\nFiltering Type: `object`\n\n```\nEligible For: \n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * restaurant\n```" 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.\n**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.\n\n\nArray may have a maximum of 200 elements.\n\n\nFiltering Type: `list of object`\n\n```\nEligible For: \n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * restaurant\n```" 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\n\nAll strings must be non-empty when trimmed of whitespace.\n\n\n\nArray must be ordered.\n\nArray may have a maximum of 100 elements.\n\nArray item description:\n\n>Cannot Include:\n>* HTML markup\n\nFiltering Type: `list of text`\n\n```\nEligible For: \n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * restaurant\n```" 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.\n\nFiltering Type: `option`\n\n```\nEligible For: \n * hotel\n```" snorkeling: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: "Indicates whether the entity offers snorkeling.\n\nFiltering Type: `option`\n\n```\nEligible For: \n * hotel\n```" socialHour: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: "Indicates whether the entity offers a social hour.\n\nFiltering Type: `option`\n\n```\nEligible For: \n * hotel\n```" spa: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: "Indicates whether the entity has a spa.\n\nFiltering Type: `option`\n\n```\nEligible For: \n * hotel\n```" specialities: description: "Up to 100 of this entity's specialities (e.g., for food and dining: `Chicago style`)\n\nAll strings must be non-empty when trimmed of whitespace.\n\n\n\nArray must be ordered.\n\nArray may have a maximum of 100 elements.\n\nArray item description:\n\n>Cannot Include:\n>* HTML markup\n\nFiltering Type: `list of text`\n\n```\nEligible For: \n * financialProfessional\n * location\n * restaurant\n```" 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.\n\nFiltering Type: `option`\n\n```\nEligible For: \n * hotel\n```" 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.\n\nEach 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.\nSimilarly, holiday takeout hours are represented by the `holidayHours` sub-field.\nSetting the `reopenDate` sub-field indicates that the business is temporarily closed and will reopen on the specified date.\nSPECIAL CASES:\n* 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.\n* 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.\n* If you are providing `openIntervals`, you may not set `isClosed` to true for that day.\n\nFiltering Type: `hours`\n\n```\nEligible For: \n * location\n * restaurant\n```" tennis: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: "Indicates whether the entity has tennis courts.\n\nFiltering Type: `option`\n\n```\nEligible For: \n * hotel\n```" thermalPool: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: "Indicates whether the entity has a thermal pool.\n\nFiltering Type: `option`\n\n```\nEligible For: \n * hotel\n```" ticketAvailability: enum: - IN_STOCK - SOLD_OUT - PRE_ORDER - UNSPECIFIED type: string description: "Information about the availability of tickets for the event\n\nFiltering Type: `option`\n\n```\nEligible For: \n * event\n```" 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\n\nFiltering Type: `object`\n\n```\nEligible For: \n * event\n```" ticketSaleDateTime: format: date-time type: string description: "The date/time tickets are available for sale (local time)\n\nFiltering Type: `datetime`\n\n```\nEligible For: \n * event\n```" ticketUrl: minLength: 0 format: uri type: string description: "URL to purchase tickets for the event (if ticketed)\n\nFiltering Type: `text`\n\n```\nEligible For: \n * event\n```" tikTokUrl: minLength: 0 format: uri type: string description: "URL for your TikTok profile, format should be https://www.tiktok.com/yourUsername\n\nFiltering Type: `text`\n\n```\nEligible For: \n * contactCard\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * organization\n * restaurant\n```" 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\n\nFiltering Type: `object`\n\n```\nEligible For: \n * event\n```" timeZoneUtcOffset: minLength: 0 type: string description: "Represents the time zone offset of the entity from UTC, in `±hh:mm` format.\n\nFor example, if the entity is 4 hours ahead of UTC time, the offset will be `+04:00`.\n\nIf the entity is 15.5 hours behind UTC time, the offset will be `-15:30`.\n\nIf the entity is in UTC time, the offset will be `+00:00`.\n\n\n```\nEligible For: \n * atm\n * event\n * faq\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * job\n * location\n * restaurant\n```" 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\"`\n\nFiltering Type: `option`\n\n```\nEligible For: \n * atm\n * board\n * card\n * contactCard\n * event\n * faq\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * helpArticle\n * hotel\n * hotelRoomType\n * job\n * location\n * organization\n * product\n * restaurant\n```" tollFreePhone: minLength: 0 type: string description: "Must be a valid phone number.\n\nIf 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.\n\nFiltering Type: `text`\n\n```\nEligible For: \n * atm\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * restaurant\n```" treadmill: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: "Indicates whether the entity has a treadmill.\n\nFiltering Type: `option`\n\n```\nEligible For: \n * hotel\n```" ttyPhone: minLength: 0 type: string description: "Must be a valid phone number.\n\nIf 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.\n\nFiltering Type: `text`\n\n```\nEligible For: \n * atm\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * restaurant\n```" turndownService: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: "Indicates whether the entity offers turndown service.\n\nFiltering Type: `option`\n\n```\nEligible For: \n * hotel\n```" twitterHandle: minLength: 0 maxLength: 15 type: string description: "Valid Twitter handle for the entity without the leading \"@\" (e.g., `JohnSmith`)\n\nIf 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.\n\nFiltering Type: `text`\n\n```\nEligible For: \n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * organization\n * restaurant\n```" 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\n\nFiltering Type: `object`\n\n```\nEligible For: \n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * restaurant\n```" 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\n\nFiltering Type: `object`\n\n```\nEligible For: \n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * restaurant\n```" valetParking: enum: - VALET_PARKING_AVAILABLE - VALET_PARKING_AVAILABLE_FOR_FREE - NOT_APPLICABLE type: string description: "Indicates whether the entity offers valet parking services.\n\nFiltering Type: `option`\n\n```\nEligible For: \n * hotel\n```" validThrough: format: date-time type: string description: "The date this entity is valid through.\n\nFiltering Type: `datetime`\n\n```\nEligible For: \n * job\n```" vendingMachine: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: "Indicates whether the entity has a vending machine.\n\nFiltering Type: `option`\n\n```\nEligible For: \n * hotel\n```" venueName: minLength: 0 type: string description: "Name of the venue where the event is being held\n\nFiltering Type: `text`\n\n```\nEligible For: \n * event\n```" videos: description: "Valid YouTube URLs for embedding a video on some publisher sites\n\n**NOTE:** Currently, only the first URL in the Array appears in your listings.\n\n\n\nArray must be ordered.\n\n\nFiltering Type: `list of object`\n\n```\nEligible For: \n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * hotelRoomType\n * location\n * organization\n * product\n * restaurant\n```" 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.\n\nFiltering Type: `option`\n\n```\nEligible For: \n * hotel\n```" wakeUpCalls: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: "Indicates whether the entity offers wake up call services.\n\nFiltering Type: `option`\n\n```\nEligible For: \n * hotel\n```" 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\n\nFiltering Type: `object`\n\n```\nEligible For: \n * atm\n * event\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * restaurant\n```" waterPark: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: "Indicates whether the entity has a water park.\n\nFiltering Type: `option`\n\n```\nEligible For: \n * hotel\n```" waterSkiing: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: "Indicates whether the entity offers water skiing.\n\nFiltering Type: `option`\n\n```\nEligible For: \n * hotel\n```" watercraft: enum: - WATERCRAFT_RENTALS - WATERCRAFT_RENTALS_FOR_FREE - NOT_APPLICABLE type: string description: "Indicates whether the entity offers any kind of watercrafts.\n\nFiltering Type: `option`\n\n```\nEligible For: \n * hotel\n```" waterslide: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: "Indicates whether the entity has a water slide.\n\nFiltering Type: `option`\n\n```\nEligible For: \n * hotel\n```" wavePool: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: "Indicates whether the entity has a wave pool.\n\nFiltering Type: `option`\n\n```\nEligible For: \n * hotel\n```" 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\n\nFiltering Type: `object`\n\n```\nEligible For: \n * atm\n * contactCard\n * event\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * organization\n * restaurant\n```" weightMachine: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: "Indicates whether the entity has a weight machine.\n\nFiltering Type: `option`\n\n```\nEligible For: \n * hotel\n```" wheelchairAccessible: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: "Indicates if the entity is wheelchair accessible.\n\nFiltering Type: `option`\n\n```\nEligible For: \n * hotel\n```" wifiAvailable: enum: - WIFI_AVAILABLE - WIFI_AVAILABLE_FOR_FREE - NOT_APPLICABLE type: string description: "Indicates whether the entity has WiFi available\n\nFiltering Type: `option`\n\n```\nEligible For: \n * hotel\n```" workRemote: type: boolean description: "Indicates whether the job is remote.\n\nFiltering Type: `boolean`\n\n```\nEligible For: \n * job\n```" yearEstablished: multipleOf: 1 minimum: 1000 maximum: 2028 type: number description: "The year the entity was established.\n\nFiltering Type: `integer`\n\n```\nEligible For: \n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * restaurant\n```" yearLastRenovated: multipleOf: 1 minimum: 1000 maximum: 2028 type: number description: "The most recent year the entity was partially or completely renovated.\n\nFiltering Type: `integer`\n\n```\nEligible For: \n * hotel\n```" 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\n\nFiltering Type: `object`\n\n```\nEligible For: \n * atm\n * event\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * job\n * location\n * restaurant\n```" 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\n\nFiltering Type: `object`\n\n```\nEligible For: \n * atm\n * event\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * restaurant\n```" 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\n\nFiltering Type: `object`\n\n```\nEligible For: \n * atm\n * event\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * restaurant\n```" 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\n\nFiltering Type: `object`\n\n```\nEligible For: \n * atm\n * event\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * restaurant\n```" 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\n\nFiltering Type: `object`\n\n```\nEligible For: \n * atm\n * event\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * restaurant\n```" youTubeChannelUrl: minLength: 0 format: uri type: string description: "URL for your YouTube channel, format should be https://www.youtube.com/c/yourUsername\n\nFiltering Type: `text`\n\n```\nEligible For: \n * contactCard\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * organization\n * restaurant\n```" headers: Update-Operation-Id: schema: minLength: 0 type: string description: The ID of the operation '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: {} delete: operationId: deleteEntity 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: 'The ID of the operation. Leave this blank to create a new operation or supply an ID to continue an existing operation ' name: Update-Operation-Id in: header required: false tags: - Knowledge Manager summary: 'Entities: Delete' description: Delete the Entity with the given ID 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. id: minLength: 0 type: string description: The ID of the deleted Entity headers: Update-Operation-Id: schema: minLength: 0 type: string description: The ID of the operation '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.\n - `false`: **Markdown** fields will be returned as JSON\n - `true`: **Markdown** fields will be returned as HTML\n" name: convertMarkdownToHTML in: query required: false - schema: minLength: 0 type: string description: "Optional parameter to return fields of type **Rich Text** as HTML.\n - `false`: **Rich Text** fields will be returned as JSON\n - `true`: **Rich Text** fields will be returned as HTML\n" name: convertRichTextToHTML in: query required: false - schema: minLength: 0 type: string description: "Comma-separated list of Entity types to filter on. Example: `\"location,event\"`\n\nShould be from the following types:\n * `atm`\n * `event`\n * `faq`\n * `financialProfessional`\n * `healthcareFacility`\n * `healthcareProfessional`\n * `hotel`\n * `hotelRoomType`\n * `job`\n * `location`\n * `organization`\n * `product`\n * `restaurant`\n\nOR the API name of a custom entity type.\n" 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**.\"\n\nValid values:\n * `markdown`\n * `html`\n * `none`\n" 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: minLength: 0 type: string default: 'false' description: '- `false`: The response will only contain overridable or language-specific fields for the requested language. - `true`: The response will contain the full location profile in the requested language, including data that remains the same across languages. ' name: rendered in: query required: false tags: - Knowledge Manager summary: 'Entity Language Profiles: List' description: 'Retrieve Language Profiles for an Entity * If the **`v`** parameter is before `20190103`: by default, returned alternate Language Profiles include **`googleAttributes`** and **`categoryIds`** fields * If the **`v`** parameter is `20190103` or later: by default, returned alternate Language Profiles do not include **`googleAttributes`** and **`categoryIds`** fields. However, these fields can still be retrieved if the **`rendered`** parameter in the request is set to `true`. * If the **`v`** parameter is `20240221` or later: returned alternate Language Profiles replace the **`categoryIds`** field with the **`categories`** field. ' 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.\n\n```\nEligible For: \n * atm\n * event\n * faq\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * job\n * location\n * restaurant\n```" name: minLength: 0 maxLength: 5000 type: string description: "\n\n\nCannot Include:\n* HTML markup\n\nFiltering Type: `text`\n\n```\nEligible For: \n * atm\n * board\n * brand\n * card\n * contactCard\n * event\n * faq\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * helpArticle\n * hotel\n * hotelRoomType\n * job\n * location\n * organization\n * product\n * restaurant\n```" 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)\n\nMust be a valid address\nCannot be a P.O. Box\n\nIf the entity is an `event`, either an **`address`** value or a **`linkedLocation`** value can be provided.\n\nFiltering Type: `object`\n\n```\nEligible For: \n * atm\n * event\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * restaurant\n```" acceptingNewPatients: type: boolean description: "Indicates whether the healthcare provider is accepting new patients.\n\nFiltering Type: `boolean`\n\n```\nEligible For: \n * healthcareFacility\n * healthcareProfessional\n```" acceptsReservations: type: boolean description: "Indicates whether the entity accepts reservations.\n\nFiltering Type: `boolean`\n\n```\nEligible For: \n * restaurant\n```" 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.\n\nEach 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.\nSimilarly, holiday access hours are represented by the `holidayHours` sub-field.\nSetting the `reopenDate` sub-field indicates that the business is temporarily closed and will reopen on the specified date.\nSPECIAL CASES:\n* 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.\n* 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.\n* If you are providing `openIntervals`, you may not set `isClosed` to true for that day.\n\nFiltering Type: `hours`\n\n```\nEligible For: \n * atm\n * healthcareFacility\n * hotel\n * location\n * restaurant\n```" additionalHoursText: minLength: 0 maxLength: 255 type: string description: "Additional information about hours that does not fit in **`hours`** (e.g., `\"Closed during the winter\"`)\n\nFiltering Type: `text`\n\n```\nEligible For: \n * atm\n * contactCard\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * restaurant\n```" additionalPromotingLocations: description: "If other locations are promoting this event, a list of those locations' **`id`**s in the Yext Knowledge Manager\n\n\nArray must be ordered.\n\n\nFiltering Type: `list of entityId`\n\n```\nEligible For: \n * event\n```" 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`.\n\nFiltering Type: `boolean`\n\n```\nEligible For: \n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * restaurant\n```" admittingHospitals: description: "A list of hospitals where the healthcare professional admits patients\n\n\nArray must be ordered.\n\nArray may have a maximum of 100 elements.\n\nArray item description:\n\n>Cannot Include:\n>* HTML markup\n\nFiltering Type: `list of text`\n\n```\nEligible For: \n * healthcareProfessional\n```" 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.\n\nFiltering Type: `option`\n\n```\nEligible For: \n * hotel\n```" 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\n\nFiltering Type: `object`\n\n```\nEligible For: \n * event\n```" 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.\n\nFiltering Type: `option`\n\n```\nEligible For: \n * hotel\n```" 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.\n\nFiltering Type: `option`\n\n```\nEligible For: \n * hotel\n```" allInclusive: enum: - ALL_INCLUSIVE_RATES_AVAILABLE - ALL_INCLUSIVE_RATES_ONLY - NOT_APPLICABLE type: string description: "Indicates whether the entity offers all-inclusive rates.\n\nFiltering Type: `option`\n\n```\nEligible For: \n * hotel\n```" alternateNames: description: "Other names for your business that you would like us to use when tracking your search performance\n\n\nArray must be ordered.\n\nArray may have a maximum of 3 elements.\n\nArray item description:\n\n>Cannot Include:\n>* HTML markup\n\nFiltering Type: `list of text`\n\n```\nEligible For: \n * atm\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * organization\n * restaurant\n```" 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.\n\nIf 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.\n\nFiltering Type: `text`\n\n```\nEligible For: \n * atm\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * restaurant\n```" alternateWebsites: description: "Other websites for your business that we should search for when tracking your search performance\n\n\nArray must be ordered.\n\nArray may have a maximum of 3 elements.\n\nArray item description:\n\n>Cannot Include:\n>* common domain names, e.g., google.com, youtube.com, etc.\n\nFiltering Type: `list of text`\n\n```\nEligible For: \n * atm\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * organization\n * restaurant\n```" 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\n\nFiltering Type: `text`\n\n```\nEligible For: \n * brand\n * financialProfessional\n * hotel\n * location\n * restaurant\n```" answer: description: "The answer to the frequently asked question represented by this entity\n\n\nCharacter limit: 0 .. 15000\n\nSupported formats include:\n* BOLD\n* ITALICS\n* UNDERLINE\n* BULLETED_LIST\n* NUMBERED_LIST\n* HYPERLINK\n* IMAGE\n* CODE_SPAN\n* HEADINGS\n\n```\nEligible For: \n * faq\n```" type: string format: rich-text appleActionLinks: description: "Use this field to add action links to your Apple Listings.\n\nThe call to action category will be displayed on the action link button.\n\nThe App Store URL should contain a valid link to the landing page of an App in the Apple App Store.\n\nThe Quick Link URL is where a user is taken when an action link is clicked by a user.\n\nThe 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.\n\n\nArray must be ordered.\n\n\nFiltering Type: `list of object`\n\n```\nEligible For: \n * atm\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * restaurant\n```" 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\n\nFiltering Type: `text`\n\n```\nEligible For: \n * atm\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * restaurant\n```" appleBusinessId: minLength: 0 pattern: ^\d*\.?\d*$ type: string description: "The ID associated with an individual Business Folder in your Apple account\n\nFiltering Type: `text`\n\n```\nEligible For: \n * atm\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * restaurant\n```" appleCompanyId: minLength: 0 pattern: ^\d*\.?\d*$ type: string description: "The ID associated with your Apple account. Numerical values only\n\nFiltering Type: `text`\n\n```\nEligible For: \n * atm\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * restaurant\n```" appleCoverPhoto: required: - url additionalProperties: false type: object description: "The cover photo for the entity''s Apple profile\n\n\nImage must be at least 1600 x 1040 pixels\n\nImage may be no more than 4864 x 3163 pixels\n\nSupported Aspect Ratios:\n* 154 x 100\n\n**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.\n\n\nFiltering Type: `object`\n\n```\nEligible For: \n * atm\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * restaurant\n```" 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.\nNOTE: The names of Brands and their respective Locations within an Apple Business Connect Account must match identically.\nCannot Include:\nHTML markup \n\n\nCannot Include:\n* HTML markup\n\nFiltering Type: `text`\n\n```\nEligible For: \n * atm\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * restaurant\n```" applicationUrl: minLength: 0 format: uri type: string description: "The application URL\n\nFiltering Type: `text`\n\n```\nEligible For: \n * job\n```" associations: description: "Association memberships relevant to the entity (e.g., `\"New York Doctors Association\"`)\nAll strings must be non-empty when trimmed of whitespace.\n\n\n\nArray must be ordered.\n\nArray may have a maximum of 100 elements.\n\nArray item description:\n\n>Cannot Include:\n>* HTML markup\n\nFiltering Type: `list of text`\n\n```\nEligible For: \n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * restaurant\n```" 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.\nA `virtualLocationUrl` must be specified for online and mixed events.\n\nFiltering Type: `object`\n\n```\nEligible For: \n * event\n```" attire: enum: - UNSPECIFIED - DRESSY - CASUAL - FORMAL type: string description: "The formality of clothing typically worn at this restaurant\n\nFiltering Type: `option`\n\n```\nEligible For: \n * restaurant\n```" babysittingOffered: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: "Indicates whether the entity offers babysitting.\n\nFiltering Type: `option`\n\n```\nEligible For: \n * hotel\n```" baggageStorage: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: "Indicates whether the entity offers baggage storage pre check-in and post check-out.\n\nFiltering Type: `option`\n\n```\nEligible For: \n * hotel\n```" bar: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: "Indicates whether the entity has an indoor or outdoor bar onsite.\n\nFiltering Type: `option`\n\n```\nEligible For: \n * hotel\n```" beachAccess: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: "Indicates whether the entity has access to a beach.\n\nFiltering Type: `option`\n\n```\nEligible For: \n * hotel\n```" beachFrontProperty: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: "Indicates whether the entity is physically located next to a beach.\n\nFiltering Type: `option`\n\n```\nEligible For: \n * hotel\n```" bicycles: enum: - BICYCLE_RENTALS - BICYCLE_RENTALS_FOR_FREE - NOT_APPLICABLE type: string description: "Indicates whether the entity offers bicycles for rent or for free.\n\nFiltering Type: `option`\n\n```\nEligible For: \n * hotel\n```" 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\n\nFiltering Type: `object`\n\n```\nEligible For: \n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * organization\n * restaurant\n```" 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.\n\nFiltering Type: `option`\n\n```\nEligible For: \n * hotel\n```" brands: description: "Brands sold by this entity\nAll strings must be non-empty when trimmed of whitespace.\n\n\n\nArray must be ordered.\n\nArray may have a maximum of 100 elements.\n\nArray item description:\n\n>Cannot Include:\n>* HTML markup\n\nFiltering Type: `list of text`\n\n```\nEligible For: \n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * restaurant\n```" 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.\n\nFiltering Type: `option`\n\n```\nEligible For: \n * hotel\n```" 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.\n\nEach 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.\nSimilarly, holiday brunch hours are represented by the `holidayHours` sub-field.\nSetting the `reopenDate` sub-field indicates that the business is temporarily closed and will reopen on the specified date.\nSPECIAL CASES:\n* 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.\n* 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.\n* If you are providing `openIntervals`, you may not set `isClosed` to true for that day.\n\nFiltering Type: `hours`\n\n```\nEligible For: \n * hotel\n * location\n * restaurant\n```" businessCenter: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: "Indicates whether the entity has a business center.\n\nFiltering Type: `option`\n\n```\nEligible For: \n * hotel\n```" 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\n\nFiltering Type: `object`\n\n```\nEligible For: \n * financialProfessional\n * healthcareFacility\n * hotel\n * location\n * restaurant\n```" carRental: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: "Indicates whether the entity offers car rental.\n\nFiltering Type: `option`\n\n```\nEligible For: \n * hotel\n```" casino: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: "Indicates whether the entity has a casino on premise or nearby.\n\nFiltering Type: `option`\n\n```\nEligible For: \n * hotel\n```" categories: additionalProperties: false type: object properties: {} description: "Yext Categories. (Supported for versions > 20240220)\n\nA map of category list external IDs (i.e. \"yext\") to a list of category IDs.\n\nIDs must be valid and selectable (i.e., cannot be parent categories).\n\nPartial updates are accepted, meaning sending only the \"yext\" property will have no effect on any category list except the \"yext\" category. \n\nFiltering Type: `object`\n\n```\nEligible For: \n * atm\n * event\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * restaurant\n```" categoryIds: uniqueItems: false type: array items: minLength: 0 type: string description: 'Filtering Type: `text`' description: "Yext Category IDs. (Deprecated: For versions > 20240220)\n\nIDs must be valid and selectable (i.e., cannot be parent categories).\n\nNOTE: 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.\n\n\nFiltering Type: `list of text`\n\n```\nEligible For: \n * atm\n * event\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * restaurant\n```" catsAllowed: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: "Indicates if the entity is cat friendly.\n\nFiltering Type: `option`\n\n```\nEligible For: \n * hotel\n```" certifications: description: "A list of the certifications held by the healthcare professional\n**NOTE:** This field is only available to locations whose **`entityType`** is `healthcareProfessional`.\n\n\n\nArray must be ordered.\n\nArray may have a maximum of 100 elements.\n\nArray item description:\n\n>Cannot Include:\n>* HTML markup\n\nFiltering Type: `list of text`\n\n```\nEligible For: \n * financialProfessional\n * healthcareProfessional\n```" 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\n\nFiltering Type: `time`\n\n```\nEligible For: \n * hotel\n```" checkOutTime: format: time type: string description: "The check-out time\n\nFiltering Type: `time`\n\n```\nEligible For: \n * hotel\n```" classificationRating: pattern: ^\d*\.?\d*$ type: string description: "The 1 to 5 star rating of the entitiy based on its services and facilities.\n\nFiltering Type: `decimal`\n\n```\nEligible For: \n * hotel\n```" closed: type: boolean description: "Indicates whether the entity is closed\n\nFiltering Type: `boolean`\n\n```\nEligible For: \n * atm\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * restaurant\n```" concierge: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: "Indicates whether the entity offers concierge service.\n\nFiltering Type: `option`\n\n```\nEligible For: \n * hotel\n```" conditionsTreated: description: "A list of the conditions treated by the healthcare provider\n\n\nArray must be ordered.\n\nArray may have a maximum of 100 elements.\n\nArray item description:\n\n>Cannot Include:\n>* HTML markup\n\nFiltering Type: `list of text`\n\n```\nEligible For: \n * healthcareFacility\n * healthcareProfessional\n```" 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.\n\nFiltering Type: `option`\n\n```\nEligible For: \n * hotel\n```" covidMessaging: minLength: 0 maxLength: 15000 type: string description: "Information or messaging related to COVID-19.\n\nFiltering Type: `text`\n\n```\nEligible For: \n * healthcareFacility\n * healthcareProfessional\n * location\n```" covidTestAppointmentUrl: minLength: 0 format: uri type: string description: "An appointment URL for scheduling a COVID-19 test.\n\nFiltering Type: `text`\n\n```\nEligible For: \n * healthcareFacility\n * location\n```" covidTestingAppointmentRequired: type: boolean description: "Indicates whether an appointment is required for a COVID-19 test.\n\nFiltering Type: `boolean`\n\n```\nEligible For: \n * healthcareFacility\n * location\n```" covidTestingDriveThroughSite: type: boolean description: "Indicates whether location is a drive-through site for COVID-19 tests.\n\nFiltering Type: `boolean`\n\n```\nEligible For: \n * healthcareFacility\n * location\n```" covidTestingIsFree: type: boolean description: "Indicates whether location offers free COVID-19 testing.\n\nFiltering Type: `boolean`\n\n```\nEligible For: \n * healthcareFacility\n * location\n```" covidTestingPatientRestrictions: type: boolean description: "Indicates whether there are patient restrictions for COVID-19 testing.\n\nFiltering Type: `boolean`\n\n```\nEligible For: \n * healthcareFacility\n * location\n```" covidTestingReferralRequired: type: boolean description: "Indicates whether a referral is required for COVID-19 testing.\n\nFiltering Type: `boolean`\n\n```\nEligible For: \n * healthcareFacility\n * location\n```" covidTestingSiteInstructions: minLength: 0 maxLength: 15000 type: string description: "Information or instructions for the COVID-19 testing site.\n\nFiltering Type: `text`\n\n```\nEligible For: \n * healthcareFacility\n * location\n```" covidVaccineAppointmentRequired: type: boolean description: "Indicates whether an appointment is required for a COVID-19 vaccine.\n\nFiltering Type: `boolean`\n\n```\nEligible For: \n * healthcareFacility\n * location\n```" covidVaccineDriveThroughSite: type: boolean description: "Indicates whether location is a drive-through site for COVID-19 vaccines.\n\nFiltering Type: `boolean`\n\n```\nEligible For: \n * healthcareFacility\n * location\n```" covidVaccineInformationUrl: minLength: 0 format: uri type: string description: "An information URL for more information about COVID-19 vaccines.\n\nFiltering Type: `text`\n\n```\nEligible For: \n * healthcareFacility\n * location\n```" covidVaccinePatientRestrictions: type: boolean description: "Indicates whether there are patient restrictions for a COVID-19 vaccine.\n\nFiltering Type: `boolean`\n\n```\nEligible For: \n * healthcareFacility\n * location\n```" covidVaccineReferralRequired: type: boolean description: "Indicates whether a referral is required for a COVID-19 vaccine.\n\nFiltering Type: `boolean`\n\n```\nEligible For: \n * healthcareFacility\n * location\n```" covidVaccineSiteInstructions: minLength: 0 maxLength: 15000 type: string description: "Information or instructions for the COVID-19 vaccination site.\n\nFiltering Type: `text`\n\n```\nEligible For: \n * healthcareFacility\n * location\n```" 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.\n\nFiltering Type: `list of option`\n\n```\nEligible For: \n * healthcareFacility\n * location\n```" currencyExchange: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: "Indicates whether the entity offers currency exchange services.\n\nFiltering Type: `option`\n\n```\nEligible For: \n * hotel\n```" customKeywords: description: "Additional keywords you would like us to use when tracking your search performance\n\n\nArray must be ordered.\n\nArray may have a maximum of 5 elements.\n\n\nFiltering Type: `list of text`\n\n```\nEligible For: \n * atm\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * organization\n * restaurant\n```" 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\n\nFiltering Type: `date`\n\n```\nEligible For: \n * job\n```" degrees: description: "A list of the degrees earned by the healthcare professional\n\n\nArray must be ordered.\n\n\nFiltering Type: `list of option`\n\n```\nEligible For: \n * healthcareProfessional\n```" 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.\n\nEach 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.\nSimilarly, holiday delivery hours are represented by the `holidayHours` sub-field.\nSetting the `reopenDate` sub-field indicates that the business is temporarily closed and will reopen on the specified date.\nSPECIAL CASES:\n* 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.\n* 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.\n* If you are providing `openIntervals`, you may not set `isClosed` to true for that day.\n\nFiltering Type: `hours`\n\n```\nEligible For: \n * location\n * restaurant\n```" description: minLength: 10 maxLength: 15000 type: string description: "A description of the entity\n\n\nCannot Include:\n* HTML markup\n\nFiltering Type: `text`\n\n```\nEligible For: \n * atm\n * contactCard\n * event\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * job\n * location\n * organization\n * restaurant\n```" 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\n\nFiltering Type: `object`\n\n```\nEligible For: \n * atm\n * event\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * job\n * location\n * restaurant\n```" doctorOnCall: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: "Indicates whether the entity has a doctor on premise or on call.\n\nFiltering Type: `option`\n\n```\nEligible For: \n * hotel\n```" dogsAllowed: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: "Indicates if the entity is dog friendly.\n\nFiltering Type: `option`\n\n```\nEligible For: \n * hotel\n```" 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.\n\nEach 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.\nSimilarly, holiday drive-through hours are represented by the `holidayHours` sub-field.\nSetting the `reopenDate` sub-field indicates that the business is temporarily closed and will reopen on the specified date.\nSPECIAL CASES:\n* 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.\n* 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.\n* If you are providing `openIntervals`, you may not set `isClosed` to true for that day.\n\nFiltering Type: `hours`\n\n```\nEligible For: \n * atm\n * location\n * restaurant\n```" 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\n\nFiltering Type: `object`\n\n```\nEligible For: \n * atm\n * event\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * restaurant\n```" educationList: description: "Information about the education or training completed by the healthcare professional\n\n\nArray must be ordered.\n\n\nFiltering Type: `list of object`\n\n```\nEligible For: \n * healthcareProfessional\n```" 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.\n\nFiltering Type: `option`\n\n```\nEligible For: \n * hotel\n```" elevator: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: "Indicates whether the entity has an elevator.\n\nFiltering Type: `option`\n\n```\nEligible For: \n * hotel\n```" ellipticalMachine: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: "Indicates whether the entity has an elliptical machine.\n\nFiltering Type: `option`\n\n```\nEligible For: \n * hotel\n```" emails: description: "Emails addresses for this entity's point of contact\n\nMust be valid email addresses\n\n\n\nArray must be ordered.\n\nArray may have a maximum of 5 elements.\n\n\nFiltering Type: `list of text`\n\n```\nEligible For: \n * contactCard\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * organization\n * restaurant\n```" 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.\n\nFiltering Type: `option`\n\n```\nEligible For: \n * job\n```" eventStatus: enum: - SCHEDULED - RESCHEDULED - POSTPONED - CANCELED - EVENT_MOVED_ONLINE type: string description: "Information on whether the event will take place as scheduled\n\nFiltering Type: `option`\n\n```\nEligible For: \n * event\n```" facebookAbout: minLength: 0 maxLength: 255 type: string description: "A description of the entity to be used in the \"About You\" section on Facebook\n\nFiltering Type: `text`\n\n```\nEligible For: \n * atm\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * restaurant\n```" 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\n\nValid contents of **`value`** depends on the Call-to-Action's **`type`**:\n* `NONE`: (optional)\n* `BOOK_NOW`: URL\n* `CALL_NOW`: Phone number\n* `CONTACT_US`: URL\n* `SEND_MESSAGE`: Any string\n* `USE_APP`: URL\n* `PLAY_GAME`: URL\n* `SHOP_NOW`: URL\n* `SIGN_UP`: URL\n* `WATCH_VIDEO`: URL\n* `SEND_EMAIL`: Email address\n* `LEARN_MORE`: URL\n* `PURCHASE_GIFT_CARDS`: URL\n* `ORDER_NOW`: URL\n* `FOLLOW_PAGE`: Any string\n\nFiltering Type: `object`\n\n```\nEligible For: \n * atm\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * restaurant\n```" facebookCoverPhoto: required: - url additionalProperties: false type: object description: "The cover photo for the entity's Facebook profile\n\nDisplayed as a 851 x 315 pixel image\n\nYou may need a cover photo in order for your listing to appear on Facebook. Please check your listings tab to learn more.\n\n\nImage must be at least 400 x 150 pixels\n\nImage area (width x height) may be no more than 41000000 pixels\n\nImage may be no more than 30000 x 30000 pixels\n\nSupported Aspect Ratios:\n* 1 x 1\n* 4 x 3\n* 3 x 2\n* 5 x 3\n* 16 x 9\n* 3 x 1\n* 2 x 3\n* 5 x 7\n* 4 x 5\n* 4 x 1\n\n**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.\n\n\nFiltering Type: `object`\n\n```\nEligible For: \n * atm\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * restaurant\n```" 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.\n\n\nCannot Include:\n* HTML markup\n\nFiltering Type: `text`\n\n```\nEligible For: \n * atm\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * restaurant\n```" 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.\n\nFiltering Type: `text`\n\n```\nEligible For: \n * atm\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * restaurant\n```" facebookOverrideCity: minLength: 0 type: string description: "The city to be displayed on this entity's Facebook profile\n\nFiltering Type: `text`\n\n```\nEligible For: \n * atm\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * restaurant\n```" facebookPageUrl: minLength: 0 type: string description: "URL for the entity's Facebook Page.\n\nValid formats:\n\n- facebook.com/profile.php?id=[numId]\n- facebook.com/group.php?gid=[numId]\n- facebook.com/groups/[numId]\n- facebook.com/[Name]\n- facebook.com/pages/[Name]/[numId]\n- facebook.com/people/[Name]/[numId]\n\nwhere [Name] is a String and [numId] is an Integer\nThe success response will contain a warning message explaining why the URL wasn't stored in the system.\n\nFiltering Type: `text`\n\n```\nEligible For: \n * atm\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * organization\n * restaurant\n```" 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\n\nFiltering Type: `text`\n\n```\nEligible For: \n * atm\n * brand\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * restaurant\n```" facebookProfilePhoto: required: - url additionalProperties: false type: object description: "The profile picture for the entity's Facebook profile\n\nYou must have a profile picture in order for your listing to appear on Facebook.\n\n\nImage must be at least 180 x 180 pixels\n\nImage area (width x height) may be no more than 41000000 pixels\n\nImage may be no more than 30000 x 30000 pixels\n\nSupported Aspect Ratios:\n* 1 x 1\n* 4 x 3\n* 3 x 2\n* 5 x 3\n* 16 x 9\n* 3 x 1\n* 2 x 3\n* 5 x 7\n* 4 x 5\n* 4 x 1\n\n**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.\n\n\nFiltering Type: `object`\n\n```\nEligible For: \n * atm\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * restaurant\n```" 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\n\nFiltering Type: `text`\n\n```\nEligible For: \n * atm\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * restaurant\n```" 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.\n\nFiltering Type: `text`\n\n```\nEligible For: \n * atm\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * restaurant\n```" 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).\n\nFiltering Type: `text`\n\n```\nEligible For: \n * atm\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * restaurant\n```" fax: minLength: 0 type: string description: "Must be a valid fax number.\n\nIf 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.\n\nFiltering Type: `text`\n\n```\nEligible For: \n * atm\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * restaurant\n```" 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\n\nFiltering Type: `object`\n\n```\nEligible For: \n * atm\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * restaurant\n```" firstName: minLength: 0 maxLength: 35 type: string description: "The first name of the healthcare professional\n\n\nCannot Include:\n* a URL or domain name\n* HTML markup\n\nFiltering Type: `text`\n\n```\nEligible For: \n * healthcareProfessional\n```" firstPartyReviewPage: minLength: 0 type: string description: "Link to the review-collection page, where consumers can leave first-party reviews\n\n```\nEligible For: \n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * restaurant\n```" fitnessCenter: enum: - FITNESS_CENTER_AVAILABLE - FITNESS_CENTER_AVAILABLE_FOR_FREE - NOT_APPLICABLE type: string description: "Indicates whether the entity has a fitness center.\n\nFiltering Type: `option`\n\n```\nEligible For: \n * hotel\n```" floorCount: multipleOf: 1 minimum: 0 type: number description: "The number of floors the entity has from ground floor to top floor.\n\nFiltering Type: `integer`\n\n```\nEligible For: \n * hotel\n```" freeWeights: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: "Indicates whether the entity has free weights.\n\nFiltering Type: `option`\n\n```\nEligible For: \n * hotel\n```" frequentlyAskedQuestions: description: "A list of questions that are frequently asked about this entity\n\n\nArray must be ordered.\n\nArray may have a maximum of 100 elements.\n\n\nFiltering Type: `list of object`\n\n```\nEligible For: \n * atm\n * event\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * restaurant\n```" 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.\n\nFiltering Type: `option`\n\n```\nEligible For: \n * hotel\n```" fullyVaccinatedStaff: type: boolean description: "Indicates whether the staff is vaccinated against COVID-19.\n\nFiltering Type: `boolean`\n\n```\nEligible For: \n * healthcareFacility\n * hotel\n * location\n * restaurant\n```" gameRoom: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: "Indicates whether the entity has a game room.\n\nFiltering Type: `option`\n\n```\nEligible For: \n * hotel\n```" gender: enum: - UNSPECIFIED - FEMALE - MALE - NONBINARY - TRANSGENDER_FEMALE - TRANSGENDER_MALE - OTHER - PREFER_NOT_TO_DISCLOSE type: string description: "The gender of the healthcare professional\n\nFiltering Type: `option`\n\n```\nEligible For: \n * healthcareProfessional\n```" geomodifier: minLength: 0 type: string description: "Provides additional information on where the entity can be found (e.g., `Times Square`, `Global Center Mall`)\n\nFiltering Type: `text`\n\n```\nEligible For: \n * atm\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * restaurant\n```" giftShop: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: "Indicates whether the entity has a gift shop.\n\nFiltering Type: `option`\n\n```\nEligible For: \n * hotel\n```" 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.\n\nFiltering Type: `option`\n\n```\nEligible For: \n * hotel\n```" 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.\n\nValid 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.\n\nKeyword 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`).\n\n* 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\" ] }]`)\n* 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\" ]}`)\n\n**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.\n\nFiltering Type: `object`\n\n```\nEligible For: \n * atm\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * restaurant\n```" googleCoverPhoto: required: - url additionalProperties: false type: object description: "The cover photo for the entity's Google profile\n\n\nImage must be at least 250 x 250 pixels\n\n\nFiltering Type: `object`\n\n```\nEligible For: \n * atm\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * restaurant\n```" 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.\nMust be a valid phone number.\nIf 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. \n\nFiltering 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.\n\nNOTE: 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.\n\nFiltering Type: `object`\n\n```\nEligible For: \n * atm\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * restaurant\n```" googleMyBusinessLabels: description: "Google Business Profile Labels help users organize their locations into groups within GBP.\n\n\nArray must be ordered.\n\nArray may have a maximum of 10 elements.\n\nArray item description:\n\n>Cannot Include:\n>* HTML markup\n\nFiltering Type: `list of text`\n\n```\nEligible For: \n * atm\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * restaurant\n```" 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.\n\nFiltering Type: `text`\n\n```\nEligible For: \n * atm\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * restaurant\n```" googleProfilePhoto: required: - url additionalProperties: false type: object description: "The profile photo for the entity's Google profile\n\n\nImage must be at least 250 x 250 pixels\n\nImage may be no more than 5000 x 5000 pixels\n\nSupported Aspect Ratios:\n* 1 x 1\n\n**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.\n\n\nFiltering Type: `object`\n\n```\nEligible For: \n * atm\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * restaurant\n```" 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).\n\nFor 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.\n\nFiltering Type: `text`\n\n```\nEligible For: \n * atm\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * restaurant\n```" 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.\n\nEach 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.\nSimilarly, holiday happy hours are represented by the `holidayHours` sub-field.\nSetting the `reopenDate` sub-field indicates that the business is temporarily closed and will reopen on the specified date.\nSPECIAL CASES:\n* 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.\n* 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.\n* If you are providing `openIntervals`, you may not set `isClosed` to true for that day.\n\nFiltering Type: `hours`\n\n```\nEligible For: \n * hotel\n * location\n * restaurant\n```" headshot: required: - url additionalProperties: false type: object description: "A portrait of the healthcare professional\n\nFiltering Type: `object`\n\n```\nEligible For: \n * contactCard\n * financialProfessional\n * healthcareProfessional\n```" 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\n\nFiltering Type: `text`\n\n```\nEligible For: \n * job\n```" holidayHoursConversationEnabled: type: boolean description: "Indicates whether holiday-hour confirmation alerts are enabled for the Yext Knowledge Assistant for this entity\n\nFiltering Type: `boolean`\n\n```\nEligible For: \n * atm\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * restaurant\n```" horsebackRiding: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: "Indicates whether the entity offers horseback riding.\n\nFiltering Type: `option`\n\n```\nEligible For: \n * hotel\n```" hotTub: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: "Indicates whether the entity has a hot tub.\n\nFiltering Type: `option`\n\n```\nEligible For: \n * hotel\n```" 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.\n\nEach 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.\nSimilarly, holiday hours are represented by the `holidayHours` sub-field.\nSetting the `reopenDate` sub-field indicates that the business is temporarily closed and will reopen on the specified date.\nSPECIAL CASES:\n* 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.\n* 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.\n* If you are providing `openIntervals`, you may not set `isClosed` to true for that day.\n\nFiltering Type: `hours`\n\n```\nEligible For: \n * atm\n * contactCard\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * restaurant\n```" housekeeping: enum: - HOUSEKEEPING_AVAILABLE - HOUSEKEEPING_AVAILABLE_DAILY - NOT_APPLICABLE type: string description: "Indicates whether the entity offers housekeeping services.\n\nFiltering Type: `option`\n\n```\nEligible For: \n * hotel\n```" 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.\n\nFiltering Type: `text`\n\n```\nEligible For: \n * atm\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * restaurant\n```" indoorPoolCount: multipleOf: 1 minimum: 0 type: number description: "A count of the number of indoor pools\n\nFiltering Type: `integer`\n\n```\nEligible For: \n * hotel\n```" instagramHandle: minLength: 0 maxLength: 30 type: string description: "Valid Instagram username for the entity without the leading \"@\" (e.g., `NewCityAuto`)\n\nFiltering Type: `text`\n\n```\nEligible For: \n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * organization\n * restaurant\n```" insuranceAccepted: description: "A list of insurance policies accepted by the healthcare provider\n\n\nArray must be ordered.\n\nArray may have a maximum of 100 elements.\n\nArray item description:\n\n>Cannot Include:\n>* HTML markup\n\nFiltering Type: `list of text`\n\n```\nEligible For: \n * healthcareFacility\n * healthcareProfessional\n```" 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\n\nFiltering Type: `text`\n\n```\nEligible For: \n * brand\n * financialProfessional\n * hotel\n * location\n * restaurant\n```" isClusterPrimary: type: boolean description: "Indicates whether the healthcare entity is the primary entity in its group\n\nFiltering Type: `boolean`\n\n```\nEligible For: \n * healthcareProfessional\n```" isFreeEvent: type: boolean description: "Indicates whether or not the event is free\n\nFiltering Type: `boolean`\n\n```\nEligible For: \n * event\n```" isoRegionCode: minLength: 0 type: string description: "The ISO 3166-2 region code for the entity\n\nYext 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.\n\nFiltering Type: `text`\n\n```\nEligible For: \n * atm\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * restaurant\n```" keywords: description: "Keywords that describe the entity.\n\nAll strings must be non-empty when trimmed of whitespace.\n\n\n\nArray must be ordered.\n\nArray may have a maximum of 100 elements.\n\nArray item description:\n\n>Cannot Include:\n>* HTML markup\n\nFiltering Type: `list of text`\n\n```\nEligible For: \n * atm\n * card\n * event\n * faq\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * helpArticle\n * hotel\n * job\n * location\n * product\n * restaurant\n```" 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.\n\nFiltering Type: `option`\n\n```\nEligible For: \n * hotel\n```" kidsClub: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: "Indicates if the property has a Kids Club.\n\nFiltering Type: `option`\n\n```\nEligible For: \n * hotel\n```" kidsStayFree: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: "Indicates whether the entity allows kids to stay free.\n\nFiltering Type: `option`\n\n```\nEligible For: \n * hotel\n```" 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.\n\nEach 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.\nSimilarly, holiday kitchen hours are represented by the `holidayHours` sub-field.\nSetting the `reopenDate` sub-field indicates that the business is temporarily closed and will reopen on the specified date.\nSPECIAL CASES:\n* 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.\n* 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.\n* If you are providing `openIntervals`, you may not set `isClosed` to true for that day.\n\nFiltering Type: `hours`\n\n```\nEligible For: \n * hotel\n * location\n * restaurant\n```" 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.\n\n**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.\n\nFiltering Type: `opaque`\n\n```\nEligible For: \n * atm\n * board\n * brand\n * card\n * contactCard\n * event\n * faq\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * helpArticle\n * hotel\n * hotelRoomType\n * job\n * location\n * organization\n * product\n * restaurant\n```" landingPageUrl: minLength: 0 format: uri type: string description: "The URL of this entity's Landing Page that was created with Yext Pages\n\nFiltering Type: `text`\n\n```\nEligible For: \n * atm\n * card\n * event\n * faq\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * helpArticle\n * hotel\n * job\n * location\n * product\n * restaurant\n```" languages: description: "The langauges in which consumers can commicate with this entity or its staff members\nAll strings must be non-empty when trimmed of whitespace.\n\n\n\nArray must be ordered.\n\nArray may have a maximum of 100 elements.\n\nArray item description:\n\n>Cannot Include:\n>* HTML markup\n\nFiltering Type: `list of text`\n\n```\nEligible For: \n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * restaurant\n```" 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\n\n\nCannot Include:\n* a URL or domain name\n* HTML markup\n\nFiltering Type: `text`\n\n```\nEligible For: \n * healthcareProfessional\n```" laundry: enum: - FULL_SERVICE - SELF_SERVICE - NOT_APPLICABLE type: string description: "Indicates whether the entity offers laundry services.\n\nFiltering Type: `option`\n\n```\nEligible For: \n * hotel\n```" lazyRiver: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: "Indicates if the property has a lazy river\n\nFiltering Type: `option`\n\n```\nEligible For: \n * hotel\n```" lifeguard: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: "Indicates if the property has a lifeguard on duty\n\nFiltering Type: `option`\n\n```\nEligible For: \n * hotel\n```" linkedInUrl: minLength: 0 format: uri type: string description: "URL for your LinkedIn account, format should be https://www.linkedin.com/in/yourUsername\n\nFiltering Type: `text`\n\n```\nEligible For: \n * contactCard\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * organization\n * restaurant\n```" linkedLocation: type: string description: "location ID of the event location, if the event is held at a location managed in the Yext Knowledge Manager\n\nFiltering Type: `entityId`\n\n```\nEligible For: \n * contactCard\n * event\n```" 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.\n\nFiltering Type: `text`\n\n```\nEligible For: \n * atm\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * restaurant\n```" localShuttle: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: "Indicates whether the entity offers local shuttle services.\n\nFiltering Type: `option`\n\n```\nEligible For: \n * hotel\n```" 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.\n\nFiltering Type: `entityId`\n\n```\nEligible For: \n * atm\n```" 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\n\nFiltering Type: `object`\n\n```\nEligible For: \n * job\n```" locationType: enum: - LOCATION - HEALTHCARE_FACILITY - HEALTHCARE_PROFESSIONAL - ATM - RESTAURANT - HOTEL type: string description: "Indicates the entity's type, if it is not an event\n\nFiltering Type: `option`\n\n```\nEligible For: \n * atm\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * restaurant\n```" logo: required: - image additionalProperties: false type: object description: "An image of the entity's logo\n\n\nSupported Aspect Ratios:\n* 1 x 1\n\n**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.\n\n\nFiltering Type: `object`\n\n```\nEligible For: \n * atm\n * contactCard\n * faq\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * job\n * location\n * organization\n * restaurant\n```" 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\n\nMust be a valid phone number.\n\nIf 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.\n\nFiltering Type: `text`\n\n```\nEligible For: \n * atm\n * contactCard\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * organization\n * restaurant\n```" massage: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: "Indicates whether the entity offers massage services.\n\nFiltering Type: `option`\n\n```\nEligible For: \n * hotel\n```" 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\n\nFiltering Type: `integer`\n\n```\nEligible For: \n * hotel\n```" 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\n\nFiltering Type: `integer`\n\n```\nEligible For: \n * hotel\n```" 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\n\nFiltering Type: `list of option`\n\n```\nEligible For: \n * restaurant\n```" meetingRoomCount: multipleOf: 1 minimum: 0 type: number description: "The number of meeting rooms the entity has.\n\nFiltering Type: `integer`\n\n```\nEligible For: \n * hotel\n```" 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\n\nFiltering Type: `object`\n\n```\nEligible For: \n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * restaurant\n```" 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\n\nFiltering Type: `object`\n\n```\nEligible For: \n * hotel\n * location\n * restaurant\n```" middleName: minLength: 0 maxLength: 35 type: string description: "The middle name of the healthcare professional\n\n\nCannot Include:\n* a URL or domain name\n* HTML markup\n\nFiltering Type: `text`\n\n```\nEligible For: \n * healthcareProfessional\n```" mobilePhone: minLength: 0 type: string description: "Must be a valid phone number.\n\nIf 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.\n\nFiltering Type: `text`\n\n```\nEligible For: \n * atm\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * restaurant\n```" mobilityAccessible: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: "Indicates whether the entity is mobility/wheelchair accessible\n\nFiltering Type: `option`\n\n```\nEligible For: \n * hotel\n```" nightclub: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: "Indicates whether the entity has a nightclub.\n\nFiltering Type: `option`\n\n```\nEligible For: \n * hotel\n```" npi: minLength: 0 type: string description: "The National Provider Identifier (NPI) of the healthcare provider\n\nFiltering Type: `text`\n\n```\nEligible For: \n * healthcareFacility\n * healthcareProfessional\n```" nudgeEnabled: type: boolean description: "Indicates whether Knowledge Nudge is enabled for the Yext Knowledge Assistant for this entity\n\nFiltering Type: `boolean`\n\n```\nEligible For: \n * atm\n * faq\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * helpArticle\n * hotel\n * job\n * location\n * organization\n * product\n * restaurant\n```" officeName: minLength: 0 type: string description: "The name of the office where the healthcare professional works, if different from **`name`**\n\nFiltering Type: `text`\n\n```\nEligible For: \n * healthcareProfessional\n```" 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.\n\nEach 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.\nSimilarly, holiday online service hours are represented by the `holidayHours` sub-field.\nSetting the `reopenDate` sub-field indicates that the business is temporarily closed and will reopen on the specified date.\nSPECIAL CASES:\n* 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.\n* 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.\n* If you are providing `openIntervals`, you may not set `isClosed` to true for that day.\n\nFiltering Type: `hours`\n\n```\nEligible For: \n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * location\n * restaurant\n```" openDate: format: date type: string description: "The date that the entity is set to open for the first time.\nMust be formatted in YYYY-MM-DD format.\n\nDate must be on or after 1970-01-01 Date must be before or on 2038-01-01\n\n\nFiltering Type: `date`\n\n```\nEligible For: \n * atm\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * restaurant\n```" 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\n\nFiltering Type: `list of option`\n\n```\nEligible For: \n * organization\n```" 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\n\nFiltering Type: `object`\n\n```\nEligible For: \n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * restaurant\n```" organizerEmail: minLength: 0 format: email type: string description: "Point of contact for the event organizer (not to be published publicly)\n\nFiltering Type: `text`\n\n```\nEligible For: \n * event\n```" organizerName: minLength: 0 type: string description: "Point of contact for the event organizer (not to be published publicly)\n\nFiltering Type: `text`\n\n```\nEligible For: \n * event\n```" organizerPhone: minLength: 0 type: string description: "Point of contact for the event organizer (not to be published publicly)\n\nFiltering Type: `text`\n\n```\nEligible For: \n * event\n```" outdoorPoolCount: multipleOf: 1 minimum: 0 type: number description: "The number of outdoor pools the entity has.\n\nFiltering Type: `integer`\n\n```\nEligible For: \n * hotel\n```" parking: enum: - PARKING_AVAILABLE - PARKING_AVAILABLE_FOR_FREE - NOT_APPLICABLE type: string description: "Indicates whether the entity offers parking services.\n\nFiltering Type: `option`\n\n```\nEligible For: \n * hotel\n```" 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\n\nValid elements depend on the entity's country.\n\n\nFiltering Type: `list of option`\n\n```\nEligible For: \n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * restaurant\n```" performers: description: "Performers at the event\n\n\nArray must be ordered.\n\nArray may have a maximum of 100 elements.\n\n\nFiltering Type: `list of text`\n\n```\nEligible For: \n * event\n```" 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.\n\nFiltering Type: `option`\n\n```\nEligible For: \n * hotel\n```" photoGallery: description: "\n**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.\n\n\n\nArray must be ordered.\n\nArray may have a maximum of 500 elements.\n\nArray item description:\n\n>Supported Aspect Ratios:\n>* 1 x 1\n>* 4 x 3\n>* 3 x 2\n>* 5 x 3\n>* 16 x 9\n>* 3 x 1\n>* 2 x 3\n>* 5 x 7\n>* 4 x 5\n>* 4 x 1\n>\n>**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.\n>\n\nFiltering Type: `list of object`\n\n```\nEligible For: \n * atm\n * event\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * hotelRoomType\n * location\n * organization\n * product\n * restaurant\n```" 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\n\nFiltering Type: `object`\n\n```\nEligible For: \n * atm\n * event\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * restaurant\n```" 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.\n\nEach 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.\nSimilarly, holiday pickup hours are represented by the `holidayHours` sub-field.\nSetting the `reopenDate` sub-field indicates that the business is temporarily closed and will reopen on the specified date.\nSPECIAL CASES:\n* 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.\n* 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.\n* If you are providing `openIntervals`, you may not set `isClosed` to true for that day.\n\nFiltering Type: `hours`\n\n```\nEligible For: \n * healthcareFacility\n * location\n * restaurant\n```" pinterestUrl: minLength: 0 format: uri type: string description: "URL for your Pinterest account, format should be https://www.pinterest.com/yourUsername\n\nFiltering Type: `text`\n\n```\nEligible For: \n * contactCard\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * organization\n * restaurant\n```" 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)\n\nFiltering Type: `option`\n\n```\nEligible For: \n * atm\n * healthcareFacility\n * healthcareProfessional\n * location\n * restaurant\n```" primaryConversationContact: minLength: 0 type: string description: "ID of the user who is the primary Knowledge Assistant contact for the entity\n\nFiltering Type: `option`\n\n```\nEligible For: \n * atm\n * faq\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * helpArticle\n * hotel\n * job\n * location\n * organization\n * product\n * restaurant\n```" privateBeach: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: "Indicates whether the entity has access to a private beach.\n\nFiltering Type: `option`\n\n```\nEligible For: \n * hotel\n```" privateCarService: enum: - PRIVATE_CAR_SERVICE - PRIVATE_CAR_SERVICE_FOR_FREE - NOT_APPLICABLE type: string description: "Indicates whether the entity offers private car services.\n\nFiltering Type: `option`\n\n```\nEligible For: \n * hotel\n```" 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\n\nFiltering Type: `object`\n\n```\nEligible For: \n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * restaurant\n```" products: description: "Products sold by this entity\n\nAll strings must be non-empty when trimmed of whitespace.\n\n\n\nArray must be ordered.\n\nArray may have a maximum of 100 elements.\n\nArray item description:\n\n>Cannot Include:\n>* HTML markup\n\nFiltering Type: `list of text`\n\n```\nEligible For: \n * financialProfessional\n * location\n```" 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\n\nFiltering Type: `boolean`\n\n```\nEligible For: \n * atm\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * organization\n * restaurant\n```" rankTrackingCompetitors: description: "Information about the competitors whose search performance you would like to compare to your own\n\n\nArray must be ordered.\n\nArray may have a maximum of 5 elements.\n\n\nFiltering Type: `list of object`\n\n```\nEligible For: \n * atm\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * organization\n * restaurant\n```" 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\n\nFiltering Type: `boolean`\n\n```\nEligible For: \n * atm\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * organization\n * restaurant\n```" rankTrackingFrequency: enum: - WEEKLY - MONTHLY - QUARTERLY type: string description: "How often we send search queries to track your search performance\n\nFiltering Type: `option`\n\n```\nEligible For: \n * atm\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * organization\n * restaurant\n```" rankTrackingQueryTemplates: description: "The ways in which your keywords will be arranged in the search queries we use to track your performance\n\n\nArray must have a minimum of 2 elements.\n\nArray may have a maximum of 4 elements.\n\n\nFiltering Type: `list of option`\n\n```\nEligible For: \n * atm\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * organization\n * restaurant\n```" 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\n\nFiltering Type: `list of option`\n\n```\nEligible For: \n * atm\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * organization\n * restaurant\n```" 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\n\nFiltering Type: `object`\n\n```\nEligible For: \n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * restaurant\n```" restaurantCount: multipleOf: 1 minimum: 0 type: number description: "The number of restaurants the entity has.\n\nFiltering Type: `integer`\n\n```\nEligible For: \n * hotel\n```" reviewGenerationUrl: minLength: 0 type: string description: "The URL given Review Invitation emails where consumers can leave a review about the entity\n\n```\nEligible For: \n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * restaurant\n```" reviewResponseConversationEnabled: type: boolean description: "Indicates whether Yext Knowledge Assistant review-response conversations are enabled for this entity\n\nFiltering Type: `boolean`\n\n```\nEligible For: \n * atm\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * restaurant\n```" roomCount: multipleOf: 1 minimum: 0 type: number description: "The number of rooms the entity has.\n\nFiltering Type: `integer`\n\n```\nEligible For: \n * hotel\n```" roomService: enum: - ROOM_SERVICE_AVAILABLE - ROOM_SERVICE_AVAILABLE_24_HOURS - NOT_APPLICABLE type: string description: "Indicates whether the entity offers room service.\n\nFiltering Type: `option`\n\n```\nEligible For: \n * hotel\n```" 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\n\nFiltering Type: `object`\n\n```\nEligible For: \n * atm\n * event\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * restaurant\n```" salon: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: "Indicates whether the entity has a salon.\n\nFiltering Type: `option`\n\n```\nEligible For: \n * hotel\n```" sauna: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: "Indicates whether the entity has a sauna.\n\nFiltering Type: `option`\n\n```\nEligible For: \n * hotel\n```" scuba: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: "Indicates whether the entity offers scuba diving.\n\nFiltering Type: `option`\n\n```\nEligible For: \n * hotel\n```" selfParking: enum: - SELF_PARKING_AVAILABLE - SELF_PARKING_AVAILABLE_FOR_FREE - NOT_APPLICABLE type: string description: "Indicates whether the entity offers self parking services.\n\nFiltering Type: `option`\n\n```\nEligible For: \n * hotel\n```" 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.\n\nEach 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.\nSimilarly, holiday senior hours are represented by the `holidayHours` sub-field.\nSetting the `reopenDate` sub-field indicates that the business is temporarily closed and will reopen on the specified date.\nSPECIAL CASES:\n* 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.\n* 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.\n* If you are providing `openIntervals`, you may not set `isClosed` to true for that day.\n\nFiltering Type: `hours`\n\n```\nEligible For: \n * location\n * restaurant\n```" serviceArea: additionalProperties: false type: object properties: places: description: "A list of places served by the entity, where each place is either:\n - a postal code, or\n - the name of a city.\n\n\n\nArray must be ordered.\n\nArray may have a maximum of 200 elements.\n\n\nFiltering 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.\n\n**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.\n\nFiltering Type: `object`\n\n```\nEligible For: \n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * restaurant\n```" 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.\n**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.\n\n\nArray may have a maximum of 200 elements.\n\n\nFiltering Type: `list of object`\n\n```\nEligible For: \n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * restaurant\n```" 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\n\nAll strings must be non-empty when trimmed of whitespace.\n\n\n\nArray must be ordered.\n\nArray may have a maximum of 100 elements.\n\nArray item description:\n\n>Cannot Include:\n>* HTML markup\n\nFiltering Type: `list of text`\n\n```\nEligible For: \n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * restaurant\n```" 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.\n\nFiltering Type: `option`\n\n```\nEligible For: \n * hotel\n```" snorkeling: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: "Indicates whether the entity offers snorkeling.\n\nFiltering Type: `option`\n\n```\nEligible For: \n * hotel\n```" socialHour: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: "Indicates whether the entity offers a social hour.\n\nFiltering Type: `option`\n\n```\nEligible For: \n * hotel\n```" spa: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: "Indicates whether the entity has a spa.\n\nFiltering Type: `option`\n\n```\nEligible For: \n * hotel\n```" specialities: description: "Up to 100 of this entity's specialities (e.g., for food and dining: `Chicago style`)\n\nAll strings must be non-empty when trimmed of whitespace.\n\n\n\nArray must be ordered.\n\nArray may have a maximum of 100 elements.\n\nArray item description:\n\n>Cannot Include:\n>* HTML markup\n\nFiltering Type: `list of text`\n\n```\nEligible For: \n * financialProfessional\n * location\n * restaurant\n```" 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.\n\nFiltering Type: `option`\n\n```\nEligible For: \n * hotel\n```" 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.\n\nEach 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.\nSimilarly, holiday takeout hours are represented by the `holidayHours` sub-field.\nSetting the `reopenDate` sub-field indicates that the business is temporarily closed and will reopen on the specified date.\nSPECIAL CASES:\n* 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.\n* 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.\n* If you are providing `openIntervals`, you may not set `isClosed` to true for that day.\n\nFiltering Type: `hours`\n\n```\nEligible For: \n * location\n * restaurant\n```" tennis: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: "Indicates whether the entity has tennis courts.\n\nFiltering Type: `option`\n\n```\nEligible For: \n * hotel\n```" thermalPool: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: "Indicates whether the entity has a thermal pool.\n\nFiltering Type: `option`\n\n```\nEligible For: \n * hotel\n```" ticketAvailability: enum: - IN_STOCK - SOLD_OUT - PRE_ORDER - UNSPECIFIED type: string description: "Information about the availability of tickets for the event\n\nFiltering Type: `option`\n\n```\nEligible For: \n * event\n```" 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\n\nFiltering Type: `object`\n\n```\nEligible For: \n * event\n```" ticketSaleDateTime: format: date-time type: string description: "The date/time tickets are available for sale (local time)\n\nFiltering Type: `datetime`\n\n```\nEligible For: \n * event\n```" ticketUrl: minLength: 0 format: uri type: string description: "URL to purchase tickets for the event (if ticketed)\n\nFiltering Type: `text`\n\n```\nEligible For: \n * event\n```" tikTokUrl: minLength: 0 format: uri type: string description: "URL for your TikTok profile, format should be https://www.tiktok.com/yourUsername\n\nFiltering Type: `text`\n\n```\nEligible For: \n * contactCard\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * organization\n * restaurant\n```" 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\n\nFiltering Type: `object`\n\n```\nEligible For: \n * event\n```" timeZoneUtcOffset: minLength: 0 type: string description: "Represents the time zone offset of the entity from UTC, in `±hh:mm` format.\n\nFor example, if the entity is 4 hours ahead of UTC time, the offset will be `+04:00`.\n\nIf the entity is 15.5 hours behind UTC time, the offset will be `-15:30`.\n\nIf the entity is in UTC time, the offset will be `+00:00`.\n\n\n```\nEligible For: \n * atm\n * event\n * faq\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * job\n * location\n * restaurant\n```" 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\"`\n\nFiltering Type: `option`\n\n```\nEligible For: \n * atm\n * board\n * card\n * contactCard\n * event\n * faq\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * helpArticle\n * hotel\n * hotelRoomType\n * job\n * location\n * organization\n * product\n * restaurant\n```" tollFreePhone: minLength: 0 type: string description: "Must be a valid phone number.\n\nIf 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.\n\nFiltering Type: `text`\n\n```\nEligible For: \n * atm\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * restaurant\n```" treadmill: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: "Indicates whether the entity has a treadmill.\n\nFiltering Type: `option`\n\n```\nEligible For: \n * hotel\n```" ttyPhone: minLength: 0 type: string description: "Must be a valid phone number.\n\nIf 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.\n\nFiltering Type: `text`\n\n```\nEligible For: \n * atm\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * restaurant\n```" turndownService: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: "Indicates whether the entity offers turndown service.\n\nFiltering Type: `option`\n\n```\nEligible For: \n * hotel\n```" twitterHandle: minLength: 0 maxLength: 15 type: string description: "Valid Twitter handle for the entity without the leading \"@\" (e.g., `JohnSmith`)\n\nIf 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.\n\nFiltering Type: `text`\n\n```\nEligible For: \n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * organization\n * restaurant\n```" 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\n\nFiltering Type: `object`\n\n```\nEligible For: \n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * restaurant\n```" 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\n\nFiltering Type: `object`\n\n```\nEligible For: \n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * restaurant\n```" valetParking: enum: - VALET_PARKING_AVAILABLE - VALET_PARKING_AVAILABLE_FOR_FREE - NOT_APPLICABLE type: string description: "Indicates whether the entity offers valet parking services.\n\nFiltering Type: `option`\n\n```\nEligible For: \n * hotel\n```" validThrough: format: date-time type: string description: "The date this entity is valid through.\n\nFiltering Type: `datetime`\n\n```\nEligible For: \n * job\n```" vendingMachine: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: "Indicates whether the entity has a vending machine.\n\nFiltering Type: `option`\n\n```\nEligible For: \n * hotel\n```" venueName: minLength: 0 type: string description: "Name of the venue where the event is being held\n\nFiltering Type: `text`\n\n```\nEligible For: \n * event\n```" videos: description: "Valid YouTube URLs for embedding a video on some publisher sites\n\n**NOTE:** Currently, only the first URL in the Array appears in your listings.\n\n\n\nArray must be ordered.\n\n\nFiltering Type: `list of object`\n\n```\nEligible For: \n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * hotelRoomType\n * location\n * organization\n * product\n * restaurant\n```" 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.\n\nFiltering Type: `option`\n\n```\nEligible For: \n * hotel\n```" wakeUpCalls: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: "Indicates whether the entity offers wake up call services.\n\nFiltering Type: `option`\n\n```\nEligible For: \n * hotel\n```" 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\n\nFiltering Type: `object`\n\n```\nEligible For: \n * atm\n * event\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * restaurant\n```" waterPark: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: "Indicates whether the entity has a water park.\n\nFiltering Type: `option`\n\n```\nEligible For: \n * hotel\n```" waterSkiing: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: "Indicates whether the entity offers water skiing.\n\nFiltering Type: `option`\n\n```\nEligible For: \n * hotel\n```" watercraft: enum: - WATERCRAFT_RENTALS - WATERCRAFT_RENTALS_FOR_FREE - NOT_APPLICABLE type: string description: "Indicates whether the entity offers any kind of watercrafts.\n\nFiltering Type: `option`\n\n```\nEligible For: \n * hotel\n```" waterslide: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: "Indicates whether the entity has a water slide.\n\nFiltering Type: `option`\n\n```\nEligible For: \n * hotel\n```" wavePool: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: "Indicates whether the entity has a wave pool.\n\nFiltering Type: `option`\n\n```\nEligible For: \n * hotel\n```" 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\n\nFiltering Type: `object`\n\n```\nEligible For: \n * atm\n * contactCard\n * event\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * organization\n * restaurant\n```" weightMachine: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: "Indicates whether the entity has a weight machine.\n\nFiltering Type: `option`\n\n```\nEligible For: \n * hotel\n```" wheelchairAccessible: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: "Indicates if the entity is wheelchair accessible.\n\nFiltering Type: `option`\n\n```\nEligible For: \n * hotel\n```" wifiAvailable: enum: - WIFI_AVAILABLE - WIFI_AVAILABLE_FOR_FREE - NOT_APPLICABLE type: string description: "Indicates whether the entity has WiFi available\n\nFiltering Type: `option`\n\n```\nEligible For: \n * hotel\n```" workRemote: type: boolean description: "Indicates whether the job is remote.\n\nFiltering Type: `boolean`\n\n```\nEligible For: \n * job\n```" yearEstablished: multipleOf: 1 minimum: 1000 maximum: 2028 type: number description: "The year the entity was established.\n\nFiltering Type: `integer`\n\n```\nEligible For: \n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * restaurant\n```" yearLastRenovated: multipleOf: 1 minimum: 1000 maximum: 2028 type: number description: "The most recent year the entity was partially or completely renovated.\n\nFiltering Type: `integer`\n\n```\nEligible For: \n * hotel\n```" 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\n\nFiltering Type: `object`\n\n```\nEligible For: \n * atm\n * event\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * job\n * location\n * restaurant\n```" 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\n\nFiltering Type: `object`\n\n```\nEligible For: \n * atm\n * event\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * restaurant\n```" 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\n\nFiltering Type: `object`\n\n```\nEligible For: \n * atm\n * event\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * restaurant\n```" 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\n\nFiltering Type: `object`\n\n```\nEligible For: \n * atm\n * event\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * restaurant\n```" 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\n\nFiltering Type: `object`\n\n```\nEligible For: \n * atm\n * event\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * restaurant\n```" youTubeChannelUrl: minLength: 0 format: uri type: string description: "URL for your YouTube channel, format should be https://www.youtube.com/c/yourUsername\n\nFiltering Type: `text`\n\n```\nEligible For: \n * contactCard\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * organization\n * restaurant\n```" 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.\n - `false`: **Markdown** fields will be returned as JSON\n - `true`: **Markdown** fields will be returned as HTML\n" name: convertMarkdownToHTML in: query required: false - schema: minLength: 0 type: string description: "Optional parameter to return fields of type **Rich Text** as HTML.\n - `false`: **Rich Text** fields will be returned as JSON\n - `true`: **Rich Text** fields will be returned as HTML\n" name: convertRichTextToHTML in: query required: false - schema: minLength: 0 type: string description: "Comma-separated list of Entity types to filter on. Example: `\"location,event\"`\n\nShould be from the following types:\n * `atm`\n * `event`\n * `faq`\n * `financialProfessional`\n * `healthcareFacility`\n * `healthcareProfessional`\n * `hotel`\n * `hotelRoomType`\n * `job`\n * `location`\n * `organization`\n * `product`\n * `restaurant`\n\nOR the API name of a custom entity type.\n" 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.\n\nFor 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`\n\n**Basic Filter Structure**\n\nThe filter object at its core consists of a *matcher*, a *field*, and an *argument*.\n\nFor example, in the following filter JSON:\n\n```\n{\n \"name\":{\n \"$eq\":\"John\"\n }\n}\n```\n\n`$eq` is the *matcher*, or filtering operation (equals, in this example),\n\n`name` is the *field* being filtered by, and\n\n`John` is *value* to be matched against.\n\n**Combining Multiple Filters**\n\nMultiple 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.\n```\n{\n \"$and\":[\n {\n \"firstName\":{\n \"$eq\":\"John\"\n }\n },\n {\n \"countryCode\":{\n \"$in\":[\n \"US\",\n \"GB\"\n ]\n }\n }\n ]\n}\n```\n\n**Filter Negation**\n\nCertain filter types may be negated. For example:\n\n```\n{\n \"$not\": {\n \"name\": {\n \"$eq\": \"John\"\n }\n }\n}\n```\n\nThis can also be written more simply with a `!` in the `$eq` parameter. The following filter would have the same effect:\n\n```\n{\n \"name\":{\n \"!$eq\":\"John\"\n }\n}\n```\n\n**Filter Complement**\n\nYou 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.\n\n```\n{\n \"$complement\":{\n \"description\":{\n \"$contains\":\"hello\"\n }\n }\n}\n```\n\n**Addressing Subfields**\n\nSubfields of fields can be addressed using the \"dot\" notation while filtering. For example, if you have a custom field called **`c_myCustomField`**:\n\n```\n{\n \"c_myCustomField\":{\n \"age\": 30,\n \"name\": \"Jim\",\n }\n}\n```\n\nWhile filtering, subfields may be addressed using the \"dot\" notation.\n\n```\n{\n \"c_myCustomField.name\":{\n \"!$eq\":\"John\"\n }\n}\n```\n\nFields 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`**.\n\n**Field Support**\n\nEntity 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).\n\n**TEXT**\n\nThe `TEXT` filter type is supported for text fields. (e.g., **`name`**, **`countryCode`**)\n\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
MatcherDetails
$eq (equals)\n\n {\n \"countryCode\":{\n \"$eq\":\"US\"\n }\n },\n {\n \"countryCode\":{\n \"!$eq\":\"US\"\n }\n }\n\n Supports negation. Case insensitive.\n
$startsWith\n\n Matches if the field starts with the argument value.\n\n e.g., \"Amazing\" starts with \"amaz\"\n\n {\n \"address.line1\":{\n \"$startsWith\": \"Jo\"\n }\n }\n\n Supports negation. Case insensitive.\n
$in\n\n Matches if field value is a member of the argument list.\n\n {\n \"firstName\":{\n \"$in\": [\"John\", \"Jimmy\"]\n }\n }\n\n Does not support negation. Negation can be mimicked by using an \"OR\" matcher, for example:\n\n {\n \"$and\":[\n {\n \"firstName\":{\n \"!$eq\": \"John\"\n }\n },\n {\n \"firstName\":{\n \"!$eq\": \"Jimmy\"\n }\n }\n ]\n }\n\n
$contains\n\n {\n \"c_myString\":{\n \"$contains\":\"sample\"\n }\n }\n\n This filter will match if \"sample\" is contained in any string within **`c_myString`**.\n\n 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\".\n\n Supports negation.\n
$containsAny\n\n {\n \"c_myString\":{\n \"$containsAny\":[\n \"sample1\", \"sample2\"\n ]\n }\n }\n\n 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.\n\n 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\".\n\n Supports negation.\n
$containsAll\n\n {\n \"c_myString\":{\n \"$containsAll\":[\n \"sample1\",\n \"sample2\"\n ]\n }\n }\n\n 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.\n\n 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\".\n\n Supports negation.\n
\n\n**BOOLEAN**\n\n\nThe BOOLEAN filter type is supported for boolean fields and Yes / No custom fields.\n\n \n \n \n \n \n \n \n
MatcherDetails
$eq\n\n {\n \"isFreeEvent\": {\n \"$eq\": true\n }\n }\n\n For booleans, the filter takes a boolean value, not a string.\n Supports negation.\n
\n\n**STRUCT**\n\nThe STRUCT filter type is supported for compound fields with subfields.\n\n*e.g., **`address`**, **`featuredMessage`**, fields of custom types*\n\n\n \n \n \n \n \n \n \n
MatcherDetails
$hasProperty\n\n 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.\n\n {\n \"address\": {\n \"$hasProperty\": \"line1\"\n }\n }\n\n 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.\n\n Supports negation.\n\n
\n\n**OPTION**\n\nThe OPTION filter type is supported for options custom fields and fields that have a predetermined list of valid values.\n\n *e.g., **`eventStatus`**, **`gender`**, `SINGLE_OPTION` and `MULTI_OPTION` types of custom fields.*\n\n\n \n \n \n \n \n \n \n \n \n \n
MatcherDetails
$eq\n\n Matching is case insensitive and insensitive to consecutive whitespace.\n\n e.g., \"XYZ 123\" matches \"xyz 123\"\n\n {\n \"eventStatus\": {\n \"$eq\": \"SCHEDULED\"\n }\n }\n\n Supports negation. Negating `$eq` on the list will match any field that does not hold any of the provided values.\n\n
$in\n\n {\n \"eventStatus\": {\n \"$in\": [\n \"SCHEDULED\",\n \"POSTPONED\"\n ]\n }\n }\n\n Does not support negation. However, negation can be mimicked by using an `$and` matcher to negate individually over the desired values. For example:\n\n {\n \"$and\": [\n {\n \"eventStatus\":{\n \"!$eq\": \"SCHEDULED\"\n }\n },\n {\n \"firstName\":{\n \"!$eq\": \"POSTPONED\"\n }\n }\n ]\n }\n\n
\n\n**PHONE**\n\nThe 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.\n\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n
MatcherDetails
$eq\n\n {\n \"mainPhone\":{\n \"$eq\":\"+18187076189\"\n }\n },\n {\n \"mainPhone\":{\n \"$eq\":\"8187076189\"\n }\n },\n {\n \"mainPhone\":{\n \"!$eq\":\"9177076189\"\n }\n }\n\n Supports negation. Case insensitive.\n\n
$startsWith\n\n Matches if the field starts with the argument value.\n\n e.g., \"8187076189\" starts with \"818\"\n\n {\n \"mainPhone\":{\n \"$startsWith\": \"818\"\n }\n }\n\n Supports negation. Case insensitive.\n\n
$in\n\n Matches if field value is a member of the argument list.\n\n {\n \"mainPhone\":{\n \"$in\": [\n \"8185551616\",\n \"9171112211\"\n ]\n }\n }\n\n Does not support negation. However, negation can be mimicked by using an `$and` matcher to negate individually over the desired values.\n\n
\n\n**INTEGER, FLOAT, DATE, DATETIME, and TIME**\n\nThese filter types are strictly ordered -- therefore, they support the following matchers:\n- Equals\n- Less Than / Less Than or Equal To\n- Greater Than / Greater Than or Equal To\n\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
MatcherDetails
$eq\n\n Equals\n\n {\n \"ageRange.maxValue\": {\n \"$eq\": \"80\"\n }\n }\n\n Supports negation.\n\n
$lt\n\n Less than\n\n {\n \"time.start\": {\n \"$lt\": \"2018-08-28T05:56\"\n }\n }\n\n
$gt\n\n Greater than\n\n {\n \"ageRange.maxValue\": {\n \"$gt\": \"50\"\n }\n }\n\n
$le\n\n Less than or equal to\n\n {\n \"ageRange.maxValue\": {\n \"$le\": \"40\"\n }\n }\n\n
$ge\n\n Greater than or equal to\n\n {\n \"time.end\": {\n \"$ge\": \"2018-08-28T05:56\"\n }\n }\n\n
Combinations\n\n 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:\n\n {\n \"ageRange.maxValue : {\n \"$gt\" : 10,\n \"$lt\": 20\n }\n }\n\n
\n\n**LIST OF TEXT**\n\nAny field that has a list of valid values and supports any of the previously mentioned filter types will also support the `$contains` matcher.\n\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
MatcherDetails
$eq\n\n {\n \"c_myStringList\": {\n \"$eq\": \"sample\"\n }\n }\n\n This filter will match if \"sample\" EXACTLY matches any string within **`c_myStringList`**.\n\n Supports negation.\n\n
$eqAny\n\n {\n \"c_myStringList\": {\n \"$eqAny\": [\n \"sample1\",\n \"sample2\"\n ]\n }\n }\n\n 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.\n\n Supports negation.\n\n
$eqAll\n\n {\n \"c_myStringList\": {\n \"$eqAll\": [\n \"sample1\",\n \"sample2\"\n ]\n }\n }\n\n This filter will match if both \"sample1\" AND \"sample2\" EXACTLY match a string within **`c_myStringList`**. The argument can have more than two strings.\n\n Supports negation.\n\n
$contains\n\n {\n \"c_myStringList\":{\n \"$contains\":\"sample\"\n }\n }\n\n This filter will match if \"sample\" is contained in any string within **`c_myStringList`**.\n\n 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\".\n\n Supports negation.\n\n
$containsAny\n\n {\n \"c_myStringList\": {\n \"$containsAny\": [\n \"sample1\",\n \"sample2\"\n ]\n }\n }\n\n\n 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.\n\n 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\".\n\n Supports negation.\n\n
$containsAll\n\n {\n \"c_myStringList\": {\n \"$containsAll\": [\n \"sample1\",\n \"sample2\"\n ]\n }\n }\n\n 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.\n\n 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\".\n\n Supports negation.\n\n
$startsWith\n\n {\n \"c_myStringList\": {\n \"$startsWith\":\"sample\"\n }\n }\n\n This filter will match if any string within **`c_myStringList`** starts with \"sample\".\n\n Does not supports negation. Case Insensitive.\n\n
\n\n**LIST OF BOOLEAN, OPTION, PHONE, INTEGER, FLOAT, DATE, DATETIME, OR TIME**\n\n\n \n \n \n \n \n \n \n \n \n \n\n \n \n \n
MatcherDetails
$eq\n\n {\n \"c_myDateList\": {\n \"$eq\": \"2019-01-01\"\n }\n }\n\n\n This filter will match if \"2019-01-01\" EXACTLY matches any date within **`c_myDateList`**.\n\n Supports negation.\n\n
$eqAny\n\n {\n \"c_myIntegerList\": {\n \"$eqAny\": [1, 2]\n }\n }\n\n This filter will match if 1 or 2 EXACTLY match any integer within **`c_myIntegerList`**. The argument list can have more than two elements.\n\n Supports negation.\n\n
$eqAll\n\n {\n \"c_myStringList\": {\n \"$eqAll\": [\n \"sample1\",\n \"sample2\"\n ]\n }\n }\n\n 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.\n\n Supports negation.\n\n
\n\n**LIST OF STRUCT**\n\nFiltering on lists of struct types is a bit nuanced. Filtering can only be done on lists of structs of the SAME type.\nFor 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:\n\n```\n{\n \"c_myStructList.age\":{\n \"$eq\": 20\n }\n}\n```\n\nwill 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`).\n\n\n**HOURS**\n\nBy 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.\n\n\n \n \n \n \n \n \n \n \n \n \n\n \n \n \n \n \n \n \n \n \n \n \n \n
MatcherDetails
$openAt\n\n {\n \"hours\": {\n \"$openAt\":\n \"2019-01-06T13:45\"\n }\n }\n\n\n This filter would match entities open at the specified time.\n\n
$closedAt\n\n {\n \"hours\": {\n \"$closedAt:\n \"2019-01-06T13:45\"\n }\n }\n\n
$openForAllOf\n\n {\n \"hours\": {\n \"$openForAllOf\": {\n \"start\":\n \"2019-01-06T13:45\",\n \"end\":\n \"2019-01-06T15:00\"\n }\n }\n }\n\n\n This filter would match only those entities that are open for the entire range between 2019-01-06T13:45 and 2019-01-06T15:00.\n\n {\n \"hours\": {\n \"$openForAllOf\":\n \"2019-05-10\"\n }\n }\n\n This filter would match entities open for the entire 24 hour period on 2019-05-10.\n\n You can also supply a year, a month, or an hour to filter for entities open for the entire year, month, or hour, respectively.\n\n
$openForAnyOf\n\n {\n \"hours\": {\n \"$openForAnyOf\": {\n \"start\": \"now\",\n \"end\": \"now+2h\"\n }\n }\n }\n\n 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.\n\n
$closedForAllOf\n\n {\n \"hours\": {\n \"$closedForAllOf\": {\n \"start\":\n \"2019-01-06T13:45\",\n \"end\":\n \"2019-01-06T15:00\"\n }\n }\n }\n\n This filter will match only those entities that are closed for the entire given time range.\n
$closedForAnyOf\n\n {\n \"hours\": {\n \"$closedForAnyOf\": {\n \"start\":\n \"2019-01-06T13:45\",\n \"end\":\n \"2019-01-06T15:00\"\n }\n }\n }\n\n This filter will match any entities that are closed for at least a portion of the given time range.\n
\n\n\n**Filtering by Dates and Times**\n\n**Time zones**\n\nThe 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.\n\nTo search in local time, simply provide the date or time without any zone: `2019-06-07T15:30` or `2019-06-07`.\n\nTo 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]`.\n\n\n**Date and time types**\n\nIn addition to searching with dates and datetimes, you can also query with years, months, and hours. For example, the filter:\n\n```\n{\n \"time.start\": {\n \"$eq\": \"2018\"\n }\n}\n```\n\nwould 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`).\n\nThese types also work with ordered searches. For example:\n\n```\n{\n \"time.start\": {\n \"$lt\": \"2018\"\n }\n}\n```\n\nwould 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.\n\n**\"Now\" and Date Math**\n\nInstead 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.\n\nIn 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`).\n\nIt 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`.\n\nYou 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.\n\n**Filtering Across an Entity**\n\nIt is possible to search for a specific text string across all fields of an entity by using the `$anywhere` matcher.\n\n\n \n \n \n \n \n \n \n
MatcherDetails
$anywhere\n\n Matches if the argument text appears anywhere in the entity (including subfields, structs, and lists)\n\n {\n \"$anywhere\": \"hello\"\n }\n\n This filter will match all entities that contain the string \"hello\" or strings that begin with \"hello\".\n\n
\n\n**Examples**\n\nThe following filter will match against entities that:\n- Are of type `event` (note that entity types can also be filtered by the **`entityTypes`** query parameter)\n- Have a name that starts with the text \"Century\"\n- Have a maximum age between 10 and 20\n- Have a minimum age between 5 and 7\n- Start after 7 PM (19:00) on August 28, 2018\n\n```\n{\n \"$and\":[\n {\n \"entityType\":{\n \"$eq\":\"event\"\n }\n },\n {\n \"name\":{\n \"$startsWith\":\"Century\"\n }\n },\n {\n \"ageRange.maxValue\":{\n \"$gt\":10,\n \"$lt\":20\n }\n },\n {\n \"ageRange.minValue\":{\n \"$gt\":5,\n \"$lt\":7\n }\n },\n {\n \"time.start\":{\n \"$ge\":\"2018-08-28T19:00\"\n }\n }\n ]\n}\n```\n" 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**.\"\n\nValid values:\n * `markdown`\n * `html`\n * `none`\n" 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 default: 'false' description: '- `false`: The response will only contain overridable or language-specific fields for the requested language. - `true`: The response will contain the full location profile in the requested language, including data that remains the same across languages. ' name: rendered 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: - Knowledge Manager summary: 'Entity Language Profiles: List All' description: 'Retrieve a list of Language Profiles for Entities within an account **NOTE:** * If the **`v`** parameter is before `20190103`: by default, returned alternate Language Profiles include **`googleAttributes`** and **`categoryIds`** fields * If the **`v`** parameter is `20190103` or later: by default, returned alternate Language Profiles do not include **`googleAttributes`** and **`categoryIds`** fields. However, these fields can still be retrieved if the **`rendered`** parameter in the request is set to `true`. * If the **`v`** parameter is `20240221` or later: returned alternate Language Profiles replace the **`categoryIds`** field with the **`categories`** field. ' 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.\n\n```\nEligible For: \n * atm\n * event\n * faq\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * job\n * location\n * restaurant\n```" name: minLength: 0 maxLength: 5000 type: string description: "\n\n\nCannot Include:\n* HTML markup\n\nFiltering Type: `text`\n\n```\nEligible For: \n * atm\n * board\n * brand\n * card\n * contactCard\n * event\n * faq\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * helpArticle\n * hotel\n * hotelRoomType\n * job\n * location\n * organization\n * product\n * restaurant\n```" 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)\n\nMust be a valid address\nCannot be a P.O. Box\n\nIf the entity is an `event`, either an **`address`** value or a **`linkedLocation`** value can be provided.\n\nFiltering Type: `object`\n\n```\nEligible For: \n * atm\n * event\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * restaurant\n```" acceptingNewPatients: type: boolean description: "Indicates whether the healthcare provider is accepting new patients.\n\nFiltering Type: `boolean`\n\n```\nEligible For: \n * healthcareFacility\n * healthcareProfessional\n```" acceptsReservations: type: boolean description: "Indicates whether the entity accepts reservations.\n\nFiltering Type: `boolean`\n\n```\nEligible For: \n * restaurant\n```" 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.\n\nEach 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.\nSimilarly, holiday access hours are represented by the `holidayHours` sub-field.\nSetting the `reopenDate` sub-field indicates that the business is temporarily closed and will reopen on the specified date.\nSPECIAL CASES:\n* 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.\n* 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.\n* If you are providing `openIntervals`, you may not set `isClosed` to true for that day.\n\nFiltering Type: `hours`\n\n```\nEligible For: \n * atm\n * healthcareFacility\n * hotel\n * location\n * restaurant\n```" additionalHoursText: minLength: 0 maxLength: 255 type: string description: "Additional information about hours that does not fit in **`hours`** (e.g., `\"Closed during the winter\"`)\n\nFiltering Type: `text`\n\n```\nEligible For: \n * atm\n * contactCard\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * restaurant\n```" additionalPromotingLocations: description: "If other locations are promoting this event, a list of those locations' **`id`**s in the Yext Knowledge Manager\n\n\nArray must be ordered.\n\n\nFiltering Type: `list of entityId`\n\n```\nEligible For: \n * event\n```" 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`.\n\nFiltering Type: `boolean`\n\n```\nEligible For: \n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * restaurant\n```" admittingHospitals: description: "A list of hospitals where the healthcare professional admits patients\n\n\nArray must be ordered.\n\nArray may have a maximum of 100 elements.\n\nArray item description:\n\n>Cannot Include:\n>* HTML markup\n\nFiltering Type: `list of text`\n\n```\nEligible For: \n * healthcareProfessional\n```" 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.\n\nFiltering Type: `option`\n\n```\nEligible For: \n * hotel\n```" 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\n\nFiltering Type: `object`\n\n```\nEligible For: \n * event\n```" 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.\n\nFiltering Type: `option`\n\n```\nEligible For: \n * hotel\n```" 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.\n\nFiltering Type: `option`\n\n```\nEligible For: \n * hotel\n```" allInclusive: enum: - ALL_INCLUSIVE_RATES_AVAILABLE - ALL_INCLUSIVE_RATES_ONLY - NOT_APPLICABLE type: string description: "Indicates whether the entity offers all-inclusive rates.\n\nFiltering Type: `option`\n\n```\nEligible For: \n * hotel\n```" alternateNames: description: "Other names for your business that you would like us to use when tracking your search performance\n\n\nArray must be ordered.\n\nArray may have a maximum of 3 elements.\n\nArray item description:\n\n>Cannot Include:\n>* HTML markup\n\nFiltering Type: `list of text`\n\n```\nEligible For: \n * atm\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * organization\n * restaurant\n```" 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.\n\nIf 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.\n\nFiltering Type: `text`\n\n```\nEligible For: \n * atm\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * restaurant\n```" alternateWebsites: description: "Other websites for your business that we should search for when tracking your search performance\n\n\nArray must be ordered.\n\nArray may have a maximum of 3 elements.\n\nArray item description:\n\n>Cannot Include:\n>* common domain names, e.g., google.com, youtube.com, etc.\n\nFiltering Type: `list of text`\n\n```\nEligible For: \n * atm\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * organization\n * restaurant\n```" 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\n\nFiltering Type: `text`\n\n```\nEligible For: \n * brand\n * financialProfessional\n * hotel\n * location\n * restaurant\n```" answer: description: "The answer to the frequently asked question represented by this entity\n\n\nCharacter limit: 0 .. 15000\n\nSupported formats include:\n* BOLD\n* ITALICS\n* UNDERLINE\n* BULLETED_LIST\n* NUMBERED_LIST\n* HYPERLINK\n* IMAGE\n* CODE_SPAN\n* HEADINGS\n\n```\nEligible For: \n * faq\n```" type: string format: rich-text appleActionLinks: description: "Use this field to add action links to your Apple Listings.\n\nThe call to action category will be displayed on the action link button.\n\nThe App Store URL should contain a valid link to the landing page of an App in the Apple App Store.\n\nThe Quick Link URL is where a user is taken when an action link is clicked by a user.\n\nThe 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.\n\n\nArray must be ordered.\n\n\nFiltering Type: `list of object`\n\n```\nEligible For: \n * atm\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * restaurant\n```" 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\n\nFiltering Type: `text`\n\n```\nEligible For: \n * atm\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * restaurant\n```" appleBusinessId: minLength: 0 pattern: ^\d*\.?\d*$ type: string description: "The ID associated with an individual Business Folder in your Apple account\n\nFiltering Type: `text`\n\n```\nEligible For: \n * atm\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * restaurant\n```" appleCompanyId: minLength: 0 pattern: ^\d*\.?\d*$ type: string description: "The ID associated with your Apple account. Numerical values only\n\nFiltering Type: `text`\n\n```\nEligible For: \n * atm\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * restaurant\n```" appleCoverPhoto: required: - url additionalProperties: false type: object description: "The cover photo for the entity''s Apple profile\n\n\nImage must be at least 1600 x 1040 pixels\n\nImage may be no more than 4864 x 3163 pixels\n\nSupported Aspect Ratios:\n* 154 x 100\n\n**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.\n\n\nFiltering Type: `object`\n\n```\nEligible For: \n * atm\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * restaurant\n```" 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.\nNOTE: The names of Brands and their respective Locations within an Apple Business Connect Account must match identically.\nCannot Include:\nHTML markup \n\n\nCannot Include:\n* HTML markup\n\nFiltering Type: `text`\n\n```\nEligible For: \n * atm\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * restaurant\n```" applicationUrl: minLength: 0 format: uri type: string description: "The application URL\n\nFiltering Type: `text`\n\n```\nEligible For: \n * job\n```" associations: description: "Association memberships relevant to the entity (e.g., `\"New York Doctors Association\"`)\nAll strings must be non-empty when trimmed of whitespace.\n\n\n\nArray must be ordered.\n\nArray may have a maximum of 100 elements.\n\nArray item description:\n\n>Cannot Include:\n>* HTML markup\n\nFiltering Type: `list of text`\n\n```\nEligible For: \n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * restaurant\n```" 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.\nA `virtualLocationUrl` must be specified for online and mixed events.\n\nFiltering Type: `object`\n\n```\nEligible For: \n * event\n```" attire: enum: - UNSPECIFIED - DRESSY - CASUAL - FORMAL type: string description: "The formality of clothing typically worn at this restaurant\n\nFiltering Type: `option`\n\n```\nEligible For: \n * restaurant\n```" babysittingOffered: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: "Indicates whether the entity offers babysitting.\n\nFiltering Type: `option`\n\n```\nEligible For: \n * hotel\n```" baggageStorage: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: "Indicates whether the entity offers baggage storage pre check-in and post check-out.\n\nFiltering Type: `option`\n\n```\nEligible For: \n * hotel\n```" bar: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: "Indicates whether the entity has an indoor or outdoor bar onsite.\n\nFiltering Type: `option`\n\n```\nEligible For: \n * hotel\n```" beachAccess: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: "Indicates whether the entity has access to a beach.\n\nFiltering Type: `option`\n\n```\nEligible For: \n * hotel\n```" beachFrontProperty: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: "Indicates whether the entity is physically located next to a beach.\n\nFiltering Type: `option`\n\n```\nEligible For: \n * hotel\n```" bicycles: enum: - BICYCLE_RENTALS - BICYCLE_RENTALS_FOR_FREE - NOT_APPLICABLE type: string description: "Indicates whether the entity offers bicycles for rent or for free.\n\nFiltering Type: `option`\n\n```\nEligible For: \n * hotel\n```" 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\n\nFiltering Type: `object`\n\n```\nEligible For: \n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * organization\n * restaurant\n```" 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.\n\nFiltering Type: `option`\n\n```\nEligible For: \n * hotel\n```" brands: description: "Brands sold by this entity\nAll strings must be non-empty when trimmed of whitespace.\n\n\n\nArray must be ordered.\n\nArray may have a maximum of 100 elements.\n\nArray item description:\n\n>Cannot Include:\n>* HTML markup\n\nFiltering Type: `list of text`\n\n```\nEligible For: \n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * restaurant\n```" 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.\n\nFiltering Type: `option`\n\n```\nEligible For: \n * hotel\n```" 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.\n\nEach 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.\nSimilarly, holiday brunch hours are represented by the `holidayHours` sub-field.\nSetting the `reopenDate` sub-field indicates that the business is temporarily closed and will reopen on the specified date.\nSPECIAL CASES:\n* 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.\n* 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.\n* If you are providing `openIntervals`, you may not set `isClosed` to true for that day.\n\nFiltering Type: `hours`\n\n```\nEligible For: \n * hotel\n * location\n * restaurant\n```" businessCenter: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: "Indicates whether the entity has a business center.\n\nFiltering Type: `option`\n\n```\nEligible For: \n * hotel\n```" 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\n\nFiltering Type: `object`\n\n```\nEligible For: \n * financialProfessional\n * healthcareFacility\n * hotel\n * location\n * restaurant\n```" carRental: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: "Indicates whether the entity offers car rental.\n\nFiltering Type: `option`\n\n```\nEligible For: \n * hotel\n```" casino: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: "Indicates whether the entity has a casino on premise or nearby.\n\nFiltering Type: `option`\n\n```\nEligible For: \n * hotel\n```" categories: additionalProperties: false type: object properties: {} description: "Yext Categories. (Supported for versions > 20240220)\n\nA map of category list external IDs (i.e. \"yext\") to a list of category IDs.\n\nIDs must be valid and selectable (i.e., cannot be parent categories).\n\nPartial updates are accepted, meaning sending only the \"yext\" property will have no effect on any category list except the \"yext\" category. \n\nFiltering Type: `object`\n\n```\nEligible For: \n * atm\n * event\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * restaurant\n```" categoryIds: uniqueItems: false type: array items: minLength: 0 type: string description: 'Filtering Type: `text`' description: "Yext Category IDs. (Deprecated: For versions > 20240220)\n\nIDs must be valid and selectable (i.e., cannot be parent categories).\n\nNOTE: 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.\n\n\nFiltering Type: `list of text`\n\n```\nEligible For: \n * atm\n * event\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * restaurant\n```" catsAllowed: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: "Indicates if the entity is cat friendly.\n\nFiltering Type: `option`\n\n```\nEligible For: \n * hotel\n```" certifications: description: "A list of the certifications held by the healthcare professional\n**NOTE:** This field is only available to locations whose **`entityType`** is `healthcareProfessional`.\n\n\n\nArray must be ordered.\n\nArray may have a maximum of 100 elements.\n\nArray item description:\n\n>Cannot Include:\n>* HTML markup\n\nFiltering Type: `list of text`\n\n```\nEligible For: \n * financialProfessional\n * healthcareProfessional\n```" 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\n\nFiltering Type: `time`\n\n```\nEligible For: \n * hotel\n```" checkOutTime: format: time type: string description: "The check-out time\n\nFiltering Type: `time`\n\n```\nEligible For: \n * hotel\n```" classificationRating: pattern: ^\d*\.?\d*$ type: string description: "The 1 to 5 star rating of the entitiy based on its services and facilities.\n\nFiltering Type: `decimal`\n\n```\nEligible For: \n * hotel\n```" closed: type: boolean description: "Indicates whether the entity is closed\n\nFiltering Type: `boolean`\n\n```\nEligible For: \n * atm\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * restaurant\n```" concierge: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: "Indicates whether the entity offers concierge service.\n\nFiltering Type: `option`\n\n```\nEligible For: \n * hotel\n```" conditionsTreated: description: "A list of the conditions treated by the healthcare provider\n\n\nArray must be ordered.\n\nArray may have a maximum of 100 elements.\n\nArray item description:\n\n>Cannot Include:\n>* HTML markup\n\nFiltering Type: `list of text`\n\n```\nEligible For: \n * healthcareFacility\n * healthcareProfessional\n```" 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.\n\nFiltering Type: `option`\n\n```\nEligible For: \n * hotel\n```" covidMessaging: minLength: 0 maxLength: 15000 type: string description: "Information or messaging related to COVID-19.\n\nFiltering Type: `text`\n\n```\nEligible For: \n * healthcareFacility\n * healthcareProfessional\n * location\n```" covidTestAppointmentUrl: minLength: 0 format: uri type: string description: "An appointment URL for scheduling a COVID-19 test.\n\nFiltering Type: `text`\n\n```\nEligible For: \n * healthcareFacility\n * location\n```" covidTestingAppointmentRequired: type: boolean description: "Indicates whether an appointment is required for a COVID-19 test.\n\nFiltering Type: `boolean`\n\n```\nEligible For: \n * healthcareFacility\n * location\n```" covidTestingDriveThroughSite: type: boolean description: "Indicates whether location is a drive-through site for COVID-19 tests.\n\nFiltering Type: `boolean`\n\n```\nEligible For: \n * healthcareFacility\n * location\n```" covidTestingIsFree: type: boolean description: "Indicates whether location offers free COVID-19 testing.\n\nFiltering Type: `boolean`\n\n```\nEligible For: \n * healthcareFacility\n * location\n```" covidTestingPatientRestrictions: type: boolean description: "Indicates whether there are patient restrictions for COVID-19 testing.\n\nFiltering Type: `boolean`\n\n```\nEligible For: \n * healthcareFacility\n * location\n```" covidTestingReferralRequired: type: boolean description: "Indicates whether a referral is required for COVID-19 testing.\n\nFiltering Type: `boolean`\n\n```\nEligible For: \n * healthcareFacility\n * location\n```" covidTestingSiteInstructions: minLength: 0 maxLength: 15000 type: string description: "Information or instructions for the COVID-19 testing site.\n\nFiltering Type: `text`\n\n```\nEligible For: \n * healthcareFacility\n * location\n```" covidVaccineAppointmentRequired: type: boolean description: "Indicates whether an appointment is required for a COVID-19 vaccine.\n\nFiltering Type: `boolean`\n\n```\nEligible For: \n * healthcareFacility\n * location\n```" covidVaccineDriveThroughSite: type: boolean description: "Indicates whether location is a drive-through site for COVID-19 vaccines.\n\nFiltering Type: `boolean`\n\n```\nEligible For: \n * healthcareFacility\n * location\n```" covidVaccineInformationUrl: minLength: 0 format: uri type: string description: "An information URL for more information about COVID-19 vaccines.\n\nFiltering Type: `text`\n\n```\nEligible For: \n * healthcareFacility\n * location\n```" covidVaccinePatientRestrictions: type: boolean description: "Indicates whether there are patient restrictions for a COVID-19 vaccine.\n\nFiltering Type: `boolean`\n\n```\nEligible For: \n * healthcareFacility\n * location\n```" covidVaccineReferralRequired: type: boolean description: "Indicates whether a referral is required for a COVID-19 vaccine.\n\nFiltering Type: `boolean`\n\n```\nEligible For: \n * healthcareFacility\n * location\n```" covidVaccineSiteInstructions: minLength: 0 maxLength: 15000 type: string description: "Information or instructions for the COVID-19 vaccination site.\n\nFiltering Type: `text`\n\n```\nEligible For: \n * healthcareFacility\n * location\n```" 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.\n\nFiltering Type: `list of option`\n\n```\nEligible For: \n * healthcareFacility\n * location\n```" currencyExchange: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: "Indicates whether the entity offers currency exchange services.\n\nFiltering Type: `option`\n\n```\nEligible For: \n * hotel\n```" customKeywords: description: "Additional keywords you would like us to use when tracking your search performance\n\n\nArray must be ordered.\n\nArray may have a maximum of 5 elements.\n\n\nFiltering Type: `list of text`\n\n```\nEligible For: \n * atm\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * organization\n * restaurant\n```" 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\n\nFiltering Type: `date`\n\n```\nEligible For: \n * job\n```" degrees: description: "A list of the degrees earned by the healthcare professional\n\n\nArray must be ordered.\n\n\nFiltering Type: `list of option`\n\n```\nEligible For: \n * healthcareProfessional\n```" 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.\n\nEach 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.\nSimilarly, holiday delivery hours are represented by the `holidayHours` sub-field.\nSetting the `reopenDate` sub-field indicates that the business is temporarily closed and will reopen on the specified date.\nSPECIAL CASES:\n* 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.\n* 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.\n* If you are providing `openIntervals`, you may not set `isClosed` to true for that day.\n\nFiltering Type: `hours`\n\n```\nEligible For: \n * location\n * restaurant\n```" description: minLength: 10 maxLength: 15000 type: string description: "A description of the entity\n\n\nCannot Include:\n* HTML markup\n\nFiltering Type: `text`\n\n```\nEligible For: \n * atm\n * contactCard\n * event\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * job\n * location\n * organization\n * restaurant\n```" 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\n\nFiltering Type: `object`\n\n```\nEligible For: \n * atm\n * event\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * job\n * location\n * restaurant\n```" doctorOnCall: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: "Indicates whether the entity has a doctor on premise or on call.\n\nFiltering Type: `option`\n\n```\nEligible For: \n * hotel\n```" dogsAllowed: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: "Indicates if the entity is dog friendly.\n\nFiltering Type: `option`\n\n```\nEligible For: \n * hotel\n```" 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.\n\nEach 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.\nSimilarly, holiday drive-through hours are represented by the `holidayHours` sub-field.\nSetting the `reopenDate` sub-field indicates that the business is temporarily closed and will reopen on the specified date.\nSPECIAL CASES:\n* 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.\n* 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.\n* If you are providing `openIntervals`, you may not set `isClosed` to true for that day.\n\nFiltering Type: `hours`\n\n```\nEligible For: \n * atm\n * location\n * restaurant\n```" 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\n\nFiltering Type: `object`\n\n```\nEligible For: \n * atm\n * event\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * restaurant\n```" educationList: description: "Information about the education or training completed by the healthcare professional\n\n\nArray must be ordered.\n\n\nFiltering Type: `list of object`\n\n```\nEligible For: \n * healthcareProfessional\n```" 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.\n\nFiltering Type: `option`\n\n```\nEligible For: \n * hotel\n```" elevator: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: "Indicates whether the entity has an elevator.\n\nFiltering Type: `option`\n\n```\nEligible For: \n * hotel\n```" ellipticalMachine: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: "Indicates whether the entity has an elliptical machine.\n\nFiltering Type: `option`\n\n```\nEligible For: \n * hotel\n```" emails: description: "Emails addresses for this entity's point of contact\n\nMust be valid email addresses\n\n\n\nArray must be ordered.\n\nArray may have a maximum of 5 elements.\n\n\nFiltering Type: `list of text`\n\n```\nEligible For: \n * contactCard\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * organization\n * restaurant\n```" 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.\n\nFiltering Type: `option`\n\n```\nEligible For: \n * job\n```" eventStatus: enum: - SCHEDULED - RESCHEDULED - POSTPONED - CANCELED - EVENT_MOVED_ONLINE type: string description: "Information on whether the event will take place as scheduled\n\nFiltering Type: `option`\n\n```\nEligible For: \n * event\n```" facebookAbout: minLength: 0 maxLength: 255 type: string description: "A description of the entity to be used in the \"About You\" section on Facebook\n\nFiltering Type: `text`\n\n```\nEligible For: \n * atm\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * restaurant\n```" 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\n\nValid contents of **`value`** depends on the Call-to-Action's **`type`**:\n* `NONE`: (optional)\n* `BOOK_NOW`: URL\n* `CALL_NOW`: Phone number\n* `CONTACT_US`: URL\n* `SEND_MESSAGE`: Any string\n* `USE_APP`: URL\n* `PLAY_GAME`: URL\n* `SHOP_NOW`: URL\n* `SIGN_UP`: URL\n* `WATCH_VIDEO`: URL\n* `SEND_EMAIL`: Email address\n* `LEARN_MORE`: URL\n* `PURCHASE_GIFT_CARDS`: URL\n* `ORDER_NOW`: URL\n* `FOLLOW_PAGE`: Any string\n\nFiltering Type: `object`\n\n```\nEligible For: \n * atm\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * restaurant\n```" facebookCoverPhoto: required: - url additionalProperties: false type: object description: "The cover photo for the entity's Facebook profile\n\nDisplayed as a 851 x 315 pixel image\n\nYou may need a cover photo in order for your listing to appear on Facebook. Please check your listings tab to learn more.\n\n\nImage must be at least 400 x 150 pixels\n\nImage area (width x height) may be no more than 41000000 pixels\n\nImage may be no more than 30000 x 30000 pixels\n\nSupported Aspect Ratios:\n* 1 x 1\n* 4 x 3\n* 3 x 2\n* 5 x 3\n* 16 x 9\n* 3 x 1\n* 2 x 3\n* 5 x 7\n* 4 x 5\n* 4 x 1\n\n**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.\n\n\nFiltering Type: `object`\n\n```\nEligible For: \n * atm\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * restaurant\n```" 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.\n\n\nCannot Include:\n* HTML markup\n\nFiltering Type: `text`\n\n```\nEligible For: \n * atm\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * restaurant\n```" 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.\n\nFiltering Type: `text`\n\n```\nEligible For: \n * atm\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * restaurant\n```" facebookOverrideCity: minLength: 0 type: string description: "The city to be displayed on this entity's Facebook profile\n\nFiltering Type: `text`\n\n```\nEligible For: \n * atm\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * restaurant\n```" facebookPageUrl: minLength: 0 type: string description: "URL for the entity's Facebook Page.\n\nValid formats:\n\n- facebook.com/profile.php?id=[numId]\n- facebook.com/group.php?gid=[numId]\n- facebook.com/groups/[numId]\n- facebook.com/[Name]\n- facebook.com/pages/[Name]/[numId]\n- facebook.com/people/[Name]/[numId]\n\nwhere [Name] is a String and [numId] is an Integer\nThe success response will contain a warning message explaining why the URL wasn't stored in the system.\n\nFiltering Type: `text`\n\n```\nEligible For: \n * atm\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * organization\n * restaurant\n```" 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\n\nFiltering Type: `text`\n\n```\nEligible For: \n * atm\n * brand\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * restaurant\n```" facebookProfilePhoto: required: - url additionalProperties: false type: object description: "The profile picture for the entity's Facebook profile\n\nYou must have a profile picture in order for your listing to appear on Facebook.\n\n\nImage must be at least 180 x 180 pixels\n\nImage area (width x height) may be no more than 41000000 pixels\n\nImage may be no more than 30000 x 30000 pixels\n\nSupported Aspect Ratios:\n* 1 x 1\n* 4 x 3\n* 3 x 2\n* 5 x 3\n* 16 x 9\n* 3 x 1\n* 2 x 3\n* 5 x 7\n* 4 x 5\n* 4 x 1\n\n**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.\n\n\nFiltering Type: `object`\n\n```\nEligible For: \n * atm\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * restaurant\n```" 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\n\nFiltering Type: `text`\n\n```\nEligible For: \n * atm\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * restaurant\n```" 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.\n\nFiltering Type: `text`\n\n```\nEligible For: \n * atm\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * restaurant\n```" 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).\n\nFiltering Type: `text`\n\n```\nEligible For: \n * atm\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * restaurant\n```" fax: minLength: 0 type: string description: "Must be a valid fax number.\n\nIf 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.\n\nFiltering Type: `text`\n\n```\nEligible For: \n * atm\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * restaurant\n```" 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\n\nFiltering Type: `object`\n\n```\nEligible For: \n * atm\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * restaurant\n```" firstName: minLength: 0 maxLength: 35 type: string description: "The first name of the healthcare professional\n\n\nCannot Include:\n* a URL or domain name\n* HTML markup\n\nFiltering Type: `text`\n\n```\nEligible For: \n * healthcareProfessional\n```" firstPartyReviewPage: minLength: 0 type: string description: "Link to the review-collection page, where consumers can leave first-party reviews\n\n```\nEligible For: \n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * restaurant\n```" fitnessCenter: enum: - FITNESS_CENTER_AVAILABLE - FITNESS_CENTER_AVAILABLE_FOR_FREE - NOT_APPLICABLE type: string description: "Indicates whether the entity has a fitness center.\n\nFiltering Type: `option`\n\n```\nEligible For: \n * hotel\n```" floorCount: multipleOf: 1 minimum: 0 type: number description: "The number of floors the entity has from ground floor to top floor.\n\nFiltering Type: `integer`\n\n```\nEligible For: \n * hotel\n```" freeWeights: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: "Indicates whether the entity has free weights.\n\nFiltering Type: `option`\n\n```\nEligible For: \n * hotel\n```" frequentlyAskedQuestions: description: "A list of questions that are frequently asked about this entity\n\n\nArray must be ordered.\n\nArray may have a maximum of 100 elements.\n\n\nFiltering Type: `list of object`\n\n```\nEligible For: \n * atm\n * event\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * restaurant\n```" 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.\n\nFiltering Type: `option`\n\n```\nEligible For: \n * hotel\n```" fullyVaccinatedStaff: type: boolean description: "Indicates whether the staff is vaccinated against COVID-19.\n\nFiltering Type: `boolean`\n\n```\nEligible For: \n * healthcareFacility\n * hotel\n * location\n * restaurant\n```" gameRoom: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: "Indicates whether the entity has a game room.\n\nFiltering Type: `option`\n\n```\nEligible For: \n * hotel\n```" gender: enum: - UNSPECIFIED - FEMALE - MALE - NONBINARY - TRANSGENDER_FEMALE - TRANSGENDER_MALE - OTHER - PREFER_NOT_TO_DISCLOSE type: string description: "The gender of the healthcare professional\n\nFiltering Type: `option`\n\n```\nEligible For: \n * healthcareProfessional\n```" geomodifier: minLength: 0 type: string description: "Provides additional information on where the entity can be found (e.g., `Times Square`, `Global Center Mall`)\n\nFiltering Type: `text`\n\n```\nEligible For: \n * atm\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * restaurant\n```" giftShop: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: "Indicates whether the entity has a gift shop.\n\nFiltering Type: `option`\n\n```\nEligible For: \n * hotel\n```" 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.\n\nFiltering Type: `option`\n\n```\nEligible For: \n * hotel\n```" 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.\n\nValid 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.\n\nKeyword 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`).\n\n* 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\" ] }]`)\n* 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\" ]}`)\n\n**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.\n\nFiltering Type: `object`\n\n```\nEligible For: \n * atm\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * restaurant\n```" googleCoverPhoto: required: - url additionalProperties: false type: object description: "The cover photo for the entity's Google profile\n\n\nImage must be at least 250 x 250 pixels\n\n\nFiltering Type: `object`\n\n```\nEligible For: \n * atm\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * restaurant\n```" 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.\nMust be a valid phone number.\nIf 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. \n\nFiltering 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.\n\nNOTE: 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.\n\nFiltering Type: `object`\n\n```\nEligible For: \n * atm\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * restaurant\n```" googleMyBusinessLabels: description: "Google Business Profile Labels help users organize their locations into groups within GBP.\n\n\nArray must be ordered.\n\nArray may have a maximum of 10 elements.\n\nArray item description:\n\n>Cannot Include:\n>* HTML markup\n\nFiltering Type: `list of text`\n\n```\nEligible For: \n * atm\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * restaurant\n```" 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.\n\nFiltering Type: `text`\n\n```\nEligible For: \n * atm\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * restaurant\n```" googleProfilePhoto: required: - url additionalProperties: false type: object description: "The profile photo for the entity's Google profile\n\n\nImage must be at least 250 x 250 pixels\n\nImage may be no more than 5000 x 5000 pixels\n\nSupported Aspect Ratios:\n* 1 x 1\n\n**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.\n\n\nFiltering Type: `object`\n\n```\nEligible For: \n * atm\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * restaurant\n```" 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).\n\nFor 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.\n\nFiltering Type: `text`\n\n```\nEligible For: \n * atm\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * restaurant\n```" 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.\n\nEach 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.\nSimilarly, holiday happy hours are represented by the `holidayHours` sub-field.\nSetting the `reopenDate` sub-field indicates that the business is temporarily closed and will reopen on the specified date.\nSPECIAL CASES:\n* 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.\n* 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.\n* If you are providing `openIntervals`, you may not set `isClosed` to true for that day.\n\nFiltering Type: `hours`\n\n```\nEligible For: \n * hotel\n * location\n * restaurant\n```" headshot: required: - url additionalProperties: false type: object description: "A portrait of the healthcare professional\n\nFiltering Type: `object`\n\n```\nEligible For: \n * contactCard\n * financialProfessional\n * healthcareProfessional\n```" 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\n\nFiltering Type: `text`\n\n```\nEligible For: \n * job\n```" holidayHoursConversationEnabled: type: boolean description: "Indicates whether holiday-hour confirmation alerts are enabled for the Yext Knowledge Assistant for this entity\n\nFiltering Type: `boolean`\n\n```\nEligible For: \n * atm\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * restaurant\n```" horsebackRiding: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: "Indicates whether the entity offers horseback riding.\n\nFiltering Type: `option`\n\n```\nEligible For: \n * hotel\n```" hotTub: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: "Indicates whether the entity has a hot tub.\n\nFiltering Type: `option`\n\n```\nEligible For: \n * hotel\n```" 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.\n\nEach 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.\nSimilarly, holiday hours are represented by the `holidayHours` sub-field.\nSetting the `reopenDate` sub-field indicates that the business is temporarily closed and will reopen on the specified date.\nSPECIAL CASES:\n* 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.\n* 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.\n* If you are providing `openIntervals`, you may not set `isClosed` to true for that day.\n\nFiltering Type: `hours`\n\n```\nEligible For: \n * atm\n * contactCard\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * restaurant\n```" housekeeping: enum: - HOUSEKEEPING_AVAILABLE - HOUSEKEEPING_AVAILABLE_DAILY - NOT_APPLICABLE type: string description: "Indicates whether the entity offers housekeeping services.\n\nFiltering Type: `option`\n\n```\nEligible For: \n * hotel\n```" 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.\n\nFiltering Type: `text`\n\n```\nEligible For: \n * atm\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * restaurant\n```" indoorPoolCount: multipleOf: 1 minimum: 0 type: number description: "A count of the number of indoor pools\n\nFiltering Type: `integer`\n\n```\nEligible For: \n * hotel\n```" instagramHandle: minLength: 0 maxLength: 30 type: string description: "Valid Instagram username for the entity without the leading \"@\" (e.g., `NewCityAuto`)\n\nFiltering Type: `text`\n\n```\nEligible For: \n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * organization\n * restaurant\n```" insuranceAccepted: description: "A list of insurance policies accepted by the healthcare provider\n\n\nArray must be ordered.\n\nArray may have a maximum of 100 elements.\n\nArray item description:\n\n>Cannot Include:\n>* HTML markup\n\nFiltering Type: `list of text`\n\n```\nEligible For: \n * healthcareFacility\n * healthcareProfessional\n```" 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\n\nFiltering Type: `text`\n\n```\nEligible For: \n * brand\n * financialProfessional\n * hotel\n * location\n * restaurant\n```" isClusterPrimary: type: boolean description: "Indicates whether the healthcare entity is the primary entity in its group\n\nFiltering Type: `boolean`\n\n```\nEligible For: \n * healthcareProfessional\n```" isFreeEvent: type: boolean description: "Indicates whether or not the event is free\n\nFiltering Type: `boolean`\n\n```\nEligible For: \n * event\n```" isoRegionCode: minLength: 0 type: string description: "The ISO 3166-2 region code for the entity\n\nYext 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.\n\nFiltering Type: `text`\n\n```\nEligible For: \n * atm\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * restaurant\n```" keywords: description: "Keywords that describe the entity.\n\nAll strings must be non-empty when trimmed of whitespace.\n\n\n\nArray must be ordered.\n\nArray may have a maximum of 100 elements.\n\nArray item description:\n\n>Cannot Include:\n>* HTML markup\n\nFiltering Type: `list of text`\n\n```\nEligible For: \n * atm\n * card\n * event\n * faq\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * helpArticle\n * hotel\n * job\n * location\n * product\n * restaurant\n```" 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.\n\nFiltering Type: `option`\n\n```\nEligible For: \n * hotel\n```" kidsClub: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: "Indicates if the property has a Kids Club.\n\nFiltering Type: `option`\n\n```\nEligible For: \n * hotel\n```" kidsStayFree: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: "Indicates whether the entity allows kids to stay free.\n\nFiltering Type: `option`\n\n```\nEligible For: \n * hotel\n```" 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.\n\nEach 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.\nSimilarly, holiday kitchen hours are represented by the `holidayHours` sub-field.\nSetting the `reopenDate` sub-field indicates that the business is temporarily closed and will reopen on the specified date.\nSPECIAL CASES:\n* 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.\n* 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.\n* If you are providing `openIntervals`, you may not set `isClosed` to true for that day.\n\nFiltering Type: `hours`\n\n```\nEligible For: \n * hotel\n * location\n * restaurant\n```" 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.\n\n**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.\n\nFiltering Type: `opaque`\n\n```\nEligible For: \n * atm\n * board\n * brand\n * card\n * contactCard\n * event\n * faq\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * helpArticle\n * hotel\n * hotelRoomType\n * job\n * location\n * organization\n * product\n * restaurant\n```" landingPageUrl: minLength: 0 format: uri type: string description: "The URL of this entity's Landing Page that was created with Yext Pages\n\nFiltering Type: `text`\n\n```\nEligible For: \n * atm\n * card\n * event\n * faq\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * helpArticle\n * hotel\n * job\n * location\n * product\n * restaurant\n```" languages: description: "The langauges in which consumers can commicate with this entity or its staff members\nAll strings must be non-empty when trimmed of whitespace.\n\n\n\nArray must be ordered.\n\nArray may have a maximum of 100 elements.\n\nArray item description:\n\n>Cannot Include:\n>* HTML markup\n\nFiltering Type: `list of text`\n\n```\nEligible For: \n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * restaurant\n```" 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\n\n\nCannot Include:\n* a URL or domain name\n* HTML markup\n\nFiltering Type: `text`\n\n```\nEligible For: \n * healthcareProfessional\n```" laundry: enum: - FULL_SERVICE - SELF_SERVICE - NOT_APPLICABLE type: string description: "Indicates whether the entity offers laundry services.\n\nFiltering Type: `option`\n\n```\nEligible For: \n * hotel\n```" lazyRiver: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: "Indicates if the property has a lazy river\n\nFiltering Type: `option`\n\n```\nEligible For: \n * hotel\n```" lifeguard: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: "Indicates if the property has a lifeguard on duty\n\nFiltering Type: `option`\n\n```\nEligible For: \n * hotel\n```" linkedInUrl: minLength: 0 format: uri type: string description: "URL for your LinkedIn account, format should be https://www.linkedin.com/in/yourUsername\n\nFiltering Type: `text`\n\n```\nEligible For: \n * contactCard\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * organization\n * restaurant\n```" linkedLocation: type: string description: "location ID of the event location, if the event is held at a location managed in the Yext Knowledge Manager\n\nFiltering Type: `entityId`\n\n```\nEligible For: \n * contactCard\n * event\n```" 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.\n\nFiltering Type: `text`\n\n```\nEligible For: \n * atm\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * restaurant\n```" localShuttle: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: "Indicates whether the entity offers local shuttle services.\n\nFiltering Type: `option`\n\n```\nEligible For: \n * hotel\n```" 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.\n\nFiltering Type: `entityId`\n\n```\nEligible For: \n * atm\n```" 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\n\nFiltering Type: `object`\n\n```\nEligible For: \n * job\n```" locationType: enum: - LOCATION - HEALTHCARE_FACILITY - HEALTHCARE_PROFESSIONAL - ATM - RESTAURANT - HOTEL type: string description: "Indicates the entity's type, if it is not an event\n\nFiltering Type: `option`\n\n```\nEligible For: \n * atm\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * restaurant\n```" logo: required: - image additionalProperties: false type: object description: "An image of the entity's logo\n\n\nSupported Aspect Ratios:\n* 1 x 1\n\n**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.\n\n\nFiltering Type: `object`\n\n```\nEligible For: \n * atm\n * contactCard\n * faq\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * job\n * location\n * organization\n * restaurant\n```" 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\n\nMust be a valid phone number.\n\nIf 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.\n\nFiltering Type: `text`\n\n```\nEligible For: \n * atm\n * contactCard\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * organization\n * restaurant\n```" massage: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: "Indicates whether the entity offers massage services.\n\nFiltering Type: `option`\n\n```\nEligible For: \n * hotel\n```" 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\n\nFiltering Type: `integer`\n\n```\nEligible For: \n * hotel\n```" 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\n\nFiltering Type: `integer`\n\n```\nEligible For: \n * hotel\n```" 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\n\nFiltering Type: `list of option`\n\n```\nEligible For: \n * restaurant\n```" meetingRoomCount: multipleOf: 1 minimum: 0 type: number description: "The number of meeting rooms the entity has.\n\nFiltering Type: `integer`\n\n```\nEligible For: \n * hotel\n```" 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\n\nFiltering Type: `object`\n\n```\nEligible For: \n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * restaurant\n```" 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\n\nFiltering Type: `object`\n\n```\nEligible For: \n * hotel\n * location\n * restaurant\n```" middleName: minLength: 0 maxLength: 35 type: string description: "The middle name of the healthcare professional\n\n\nCannot Include:\n* a URL or domain name\n* HTML markup\n\nFiltering Type: `text`\n\n```\nEligible For: \n * healthcareProfessional\n```" mobilePhone: minLength: 0 type: string description: "Must be a valid phone number.\n\nIf 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.\n\nFiltering Type: `text`\n\n```\nEligible For: \n * atm\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * restaurant\n```" mobilityAccessible: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: "Indicates whether the entity is mobility/wheelchair accessible\n\nFiltering Type: `option`\n\n```\nEligible For: \n * hotel\n```" nightclub: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: "Indicates whether the entity has a nightclub.\n\nFiltering Type: `option`\n\n```\nEligible For: \n * hotel\n```" npi: minLength: 0 type: string description: "The National Provider Identifier (NPI) of the healthcare provider\n\nFiltering Type: `text`\n\n```\nEligible For: \n * healthcareFacility\n * healthcareProfessional\n```" nudgeEnabled: type: boolean description: "Indicates whether Knowledge Nudge is enabled for the Yext Knowledge Assistant for this entity\n\nFiltering Type: `boolean`\n\n```\nEligible For: \n * atm\n * faq\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * helpArticle\n * hotel\n * job\n * location\n * organization\n * product\n * restaurant\n```" officeName: minLength: 0 type: string description: "The name of the office where the healthcare professional works, if different from **`name`**\n\nFiltering Type: `text`\n\n```\nEligible For: \n * healthcareProfessional\n```" 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.\n\nEach 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.\nSimilarly, holiday online service hours are represented by the `holidayHours` sub-field.\nSetting the `reopenDate` sub-field indicates that the business is temporarily closed and will reopen on the specified date.\nSPECIAL CASES:\n* 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.\n* 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.\n* If you are providing `openIntervals`, you may not set `isClosed` to true for that day.\n\nFiltering Type: `hours`\n\n```\nEligible For: \n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * location\n * restaurant\n```" openDate: format: date type: string description: "The date that the entity is set to open for the first time.\nMust be formatted in YYYY-MM-DD format.\n\nDate must be on or after 1970-01-01 Date must be before or on 2038-01-01\n\n\nFiltering Type: `date`\n\n```\nEligible For: \n * atm\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * restaurant\n```" 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\n\nFiltering Type: `list of option`\n\n```\nEligible For: \n * organization\n```" 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\n\nFiltering Type: `object`\n\n```\nEligible For: \n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * restaurant\n```" organizerEmail: minLength: 0 format: email type: string description: "Point of contact for the event organizer (not to be published publicly)\n\nFiltering Type: `text`\n\n```\nEligible For: \n * event\n```" organizerName: minLength: 0 type: string description: "Point of contact for the event organizer (not to be published publicly)\n\nFiltering Type: `text`\n\n```\nEligible For: \n * event\n```" organizerPhone: minLength: 0 type: string description: "Point of contact for the event organizer (not to be published publicly)\n\nFiltering Type: `text`\n\n```\nEligible For: \n * event\n```" outdoorPoolCount: multipleOf: 1 minimum: 0 type: number description: "The number of outdoor pools the entity has.\n\nFiltering Type: `integer`\n\n```\nEligible For: \n * hotel\n```" parking: enum: - PARKING_AVAILABLE - PARKING_AVAILABLE_FOR_FREE - NOT_APPLICABLE type: string description: "Indicates whether the entity offers parking services.\n\nFiltering Type: `option`\n\n```\nEligible For: \n * hotel\n```" 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\n\nValid elements depend on the entity's country.\n\n\nFiltering Type: `list of option`\n\n```\nEligible For: \n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * restaurant\n```" performers: description: "Performers at the event\n\n\nArray must be ordered.\n\nArray may have a maximum of 100 elements.\n\n\nFiltering Type: `list of text`\n\n```\nEligible For: \n * event\n```" 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.\n\nFiltering Type: `option`\n\n```\nEligible For: \n * hotel\n```" photoGallery: description: "\n**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.\n\n\n\nArray must be ordered.\n\nArray may have a maximum of 500 elements.\n\nArray item description:\n\n>Supported Aspect Ratios:\n>* 1 x 1\n>* 4 x 3\n>* 3 x 2\n>* 5 x 3\n>* 16 x 9\n>* 3 x 1\n>* 2 x 3\n>* 5 x 7\n>* 4 x 5\n>* 4 x 1\n>\n>**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.\n>\n\nFiltering Type: `list of object`\n\n```\nEligible For: \n * atm\n * event\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * hotelRoomType\n * location\n * organization\n * product\n * restaurant\n```" 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\n\nFiltering Type: `object`\n\n```\nEligible For: \n * atm\n * event\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * restaurant\n```" 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.\n\nEach 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.\nSimilarly, holiday pickup hours are represented by the `holidayHours` sub-field.\nSetting the `reopenDate` sub-field indicates that the business is temporarily closed and will reopen on the specified date.\nSPECIAL CASES:\n* 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.\n* 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.\n* If you are providing `openIntervals`, you may not set `isClosed` to true for that day.\n\nFiltering Type: `hours`\n\n```\nEligible For: \n * healthcareFacility\n * location\n * restaurant\n```" pinterestUrl: minLength: 0 format: uri type: string description: "URL for your Pinterest account, format should be https://www.pinterest.com/yourUsername\n\nFiltering Type: `text`\n\n```\nEligible For: \n * contactCard\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * organization\n * restaurant\n```" 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)\n\nFiltering Type: `option`\n\n```\nEligible For: \n * atm\n * healthcareFacility\n * healthcareProfessional\n * location\n * restaurant\n```" primaryConversationContact: minLength: 0 type: string description: "ID of the user who is the primary Knowledge Assistant contact for the entity\n\nFiltering Type: `option`\n\n```\nEligible For: \n * atm\n * faq\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * helpArticle\n * hotel\n * job\n * location\n * organization\n * product\n * restaurant\n```" privateBeach: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: "Indicates whether the entity has access to a private beach.\n\nFiltering Type: `option`\n\n```\nEligible For: \n * hotel\n```" privateCarService: enum: - PRIVATE_CAR_SERVICE - PRIVATE_CAR_SERVICE_FOR_FREE - NOT_APPLICABLE type: string description: "Indicates whether the entity offers private car services.\n\nFiltering Type: `option`\n\n```\nEligible For: \n * hotel\n```" 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\n\nFiltering Type: `object`\n\n```\nEligible For: \n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * restaurant\n```" products: description: "Products sold by this entity\n\nAll strings must be non-empty when trimmed of whitespace.\n\n\n\nArray must be ordered.\n\nArray may have a maximum of 100 elements.\n\nArray item description:\n\n>Cannot Include:\n>* HTML markup\n\nFiltering Type: `list of text`\n\n```\nEligible For: \n * financialProfessional\n * location\n```" 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\n\nFiltering Type: `boolean`\n\n```\nEligible For: \n * atm\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * organization\n * restaurant\n```" rankTrackingCompetitors: description: "Information about the competitors whose search performance you would like to compare to your own\n\n\nArray must be ordered.\n\nArray may have a maximum of 5 elements.\n\n\nFiltering Type: `list of object`\n\n```\nEligible For: \n * atm\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * organization\n * restaurant\n```" 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\n\nFiltering Type: `boolean`\n\n```\nEligible For: \n * atm\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * organization\n * restaurant\n```" rankTrackingFrequency: enum: - WEEKLY - MONTHLY - QUARTERLY type: string description: "How often we send search queries to track your search performance\n\nFiltering Type: `option`\n\n```\nEligible For: \n * atm\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * organization\n * restaurant\n```" rankTrackingQueryTemplates: description: "The ways in which your keywords will be arranged in the search queries we use to track your performance\n\n\nArray must have a minimum of 2 elements.\n\nArray may have a maximum of 4 elements.\n\n\nFiltering Type: `list of option`\n\n```\nEligible For: \n * atm\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * organization\n * restaurant\n```" 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\n\nFiltering Type: `list of option`\n\n```\nEligible For: \n * atm\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * organization\n * restaurant\n```" 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\n\nFiltering Type: `object`\n\n```\nEligible For: \n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * restaurant\n```" restaurantCount: multipleOf: 1 minimum: 0 type: number description: "The number of restaurants the entity has.\n\nFiltering Type: `integer`\n\n```\nEligible For: \n * hotel\n```" reviewGenerationUrl: minLength: 0 type: string description: "The URL given Review Invitation emails where consumers can leave a review about the entity\n\n```\nEligible For: \n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * restaurant\n```" reviewResponseConversationEnabled: type: boolean description: "Indicates whether Yext Knowledge Assistant review-response conversations are enabled for this entity\n\nFiltering Type: `boolean`\n\n```\nEligible For: \n * atm\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * restaurant\n```" roomCount: multipleOf: 1 minimum: 0 type: number description: "The number of rooms the entity has.\n\nFiltering Type: `integer`\n\n```\nEligible For: \n * hotel\n```" roomService: enum: - ROOM_SERVICE_AVAILABLE - ROOM_SERVICE_AVAILABLE_24_HOURS - NOT_APPLICABLE type: string description: "Indicates whether the entity offers room service.\n\nFiltering Type: `option`\n\n```\nEligible For: \n * hotel\n```" 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\n\nFiltering Type: `object`\n\n```\nEligible For: \n * atm\n * event\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * restaurant\n```" salon: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: "Indicates whether the entity has a salon.\n\nFiltering Type: `option`\n\n```\nEligible For: \n * hotel\n```" sauna: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: "Indicates whether the entity has a sauna.\n\nFiltering Type: `option`\n\n```\nEligible For: \n * hotel\n```" scuba: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: "Indicates whether the entity offers scuba diving.\n\nFiltering Type: `option`\n\n```\nEligible For: \n * hotel\n```" selfParking: enum: - SELF_PARKING_AVAILABLE - SELF_PARKING_AVAILABLE_FOR_FREE - NOT_APPLICABLE type: string description: "Indicates whether the entity offers self parking services.\n\nFiltering Type: `option`\n\n```\nEligible For: \n * hotel\n```" 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.\n\nEach 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.\nSimilarly, holiday senior hours are represented by the `holidayHours` sub-field.\nSetting the `reopenDate` sub-field indicates that the business is temporarily closed and will reopen on the specified date.\nSPECIAL CASES:\n* 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.\n* 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.\n* If you are providing `openIntervals`, you may not set `isClosed` to true for that day.\n\nFiltering Type: `hours`\n\n```\nEligible For: \n * location\n * restaurant\n```" serviceArea: additionalProperties: false type: object properties: places: description: "A list of places served by the entity, where each place is either:\n - a postal code, or\n - the name of a city.\n\n\n\nArray must be ordered.\n\nArray may have a maximum of 200 elements.\n\n\nFiltering 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.\n\n**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.\n\nFiltering Type: `object`\n\n```\nEligible For: \n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * restaurant\n```" 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.\n**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.\n\n\nArray may have a maximum of 200 elements.\n\n\nFiltering Type: `list of object`\n\n```\nEligible For: \n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * restaurant\n```" 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\n\nAll strings must be non-empty when trimmed of whitespace.\n\n\n\nArray must be ordered.\n\nArray may have a maximum of 100 elements.\n\nArray item description:\n\n>Cannot Include:\n>* HTML markup\n\nFiltering Type: `list of text`\n\n```\nEligible For: \n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * restaurant\n```" 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.\n\nFiltering Type: `option`\n\n```\nEligible For: \n * hotel\n```" snorkeling: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: "Indicates whether the entity offers snorkeling.\n\nFiltering Type: `option`\n\n```\nEligible For: \n * hotel\n```" socialHour: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: "Indicates whether the entity offers a social hour.\n\nFiltering Type: `option`\n\n```\nEligible For: \n * hotel\n```" spa: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: "Indicates whether the entity has a spa.\n\nFiltering Type: `option`\n\n```\nEligible For: \n * hotel\n```" specialities: description: "Up to 100 of this entity's specialities (e.g., for food and dining: `Chicago style`)\n\nAll strings must be non-empty when trimmed of whitespace.\n\n\n\nArray must be ordered.\n\nArray may have a maximum of 100 elements.\n\nArray item description:\n\n>Cannot Include:\n>* HTML markup\n\nFiltering Type: `list of text`\n\n```\nEligible For: \n * financialProfessional\n * location\n * restaurant\n```" 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.\n\nFiltering Type: `option`\n\n```\nEligible For: \n * hotel\n```" 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.\n\nEach 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.\nSimilarly, holiday takeout hours are represented by the `holidayHours` sub-field.\nSetting the `reopenDate` sub-field indicates that the business is temporarily closed and will reopen on the specified date.\nSPECIAL CASES:\n* 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.\n* 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.\n* If you are providing `openIntervals`, you may not set `isClosed` to true for that day.\n\nFiltering Type: `hours`\n\n```\nEligible For: \n * location\n * restaurant\n```" tennis: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: "Indicates whether the entity has tennis courts.\n\nFiltering Type: `option`\n\n```\nEligible For: \n * hotel\n```" thermalPool: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: "Indicates whether the entity has a thermal pool.\n\nFiltering Type: `option`\n\n```\nEligible For: \n * hotel\n```" ticketAvailability: enum: - IN_STOCK - SOLD_OUT - PRE_ORDER - UNSPECIFIED type: string description: "Information about the availability of tickets for the event\n\nFiltering Type: `option`\n\n```\nEligible For: \n * event\n```" 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\n\nFiltering Type: `object`\n\n```\nEligible For: \n * event\n```" ticketSaleDateTime: format: date-time type: string description: "The date/time tickets are available for sale (local time)\n\nFiltering Type: `datetime`\n\n```\nEligible For: \n * event\n```" ticketUrl: minLength: 0 format: uri type: string description: "URL to purchase tickets for the event (if ticketed)\n\nFiltering Type: `text`\n\n```\nEligible For: \n * event\n```" tikTokUrl: minLength: 0 format: uri type: string description: "URL for your TikTok profile, format should be https://www.tiktok.com/yourUsername\n\nFiltering Type: `text`\n\n```\nEligible For: \n * contactCard\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * organization\n * restaurant\n```" 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\n\nFiltering Type: `object`\n\n```\nEligible For: \n * event\n```" timeZoneUtcOffset: minLength: 0 type: string description: "Represents the time zone offset of the entity from UTC, in `±hh:mm` format.\n\nFor example, if the entity is 4 hours ahead of UTC time, the offset will be `+04:00`.\n\nIf the entity is 15.5 hours behind UTC time, the offset will be `-15:30`.\n\nIf the entity is in UTC time, the offset will be `+00:00`.\n\n\n```\nEligible For: \n * atm\n * event\n * faq\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * job\n * location\n * restaurant\n```" 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\"`\n\nFiltering Type: `option`\n\n```\nEligible For: \n * atm\n * board\n * card\n * contactCard\n * event\n * faq\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * helpArticle\n * hotel\n * hotelRoomType\n * job\n * location\n * organization\n * product\n * restaurant\n```" tollFreePhone: minLength: 0 type: string description: "Must be a valid phone number.\n\nIf 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.\n\nFiltering Type: `text`\n\n```\nEligible For: \n * atm\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * restaurant\n```" treadmill: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: "Indicates whether the entity has a treadmill.\n\nFiltering Type: `option`\n\n```\nEligible For: \n * hotel\n```" ttyPhone: minLength: 0 type: string description: "Must be a valid phone number.\n\nIf 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.\n\nFiltering Type: `text`\n\n```\nEligible For: \n * atm\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * restaurant\n```" turndownService: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: "Indicates whether the entity offers turndown service.\n\nFiltering Type: `option`\n\n```\nEligible For: \n * hotel\n```" twitterHandle: minLength: 0 maxLength: 15 type: string description: "Valid Twitter handle for the entity without the leading \"@\" (e.g., `JohnSmith`)\n\nIf 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.\n\nFiltering Type: `text`\n\n```\nEligible For: \n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * organization\n * restaurant\n```" 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\n\nFiltering Type: `object`\n\n```\nEligible For: \n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * restaurant\n```" 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\n\nFiltering Type: `object`\n\n```\nEligible For: \n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * restaurant\n```" valetParking: enum: - VALET_PARKING_AVAILABLE - VALET_PARKING_AVAILABLE_FOR_FREE - NOT_APPLICABLE type: string description: "Indicates whether the entity offers valet parking services.\n\nFiltering Type: `option`\n\n```\nEligible For: \n * hotel\n```" validThrough: format: date-time type: string description: "The date this entity is valid through.\n\nFiltering Type: `datetime`\n\n```\nEligible For: \n * job\n```" vendingMachine: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: "Indicates whether the entity has a vending machine.\n\nFiltering Type: `option`\n\n```\nEligible For: \n * hotel\n```" venueName: minLength: 0 type: string description: "Name of the venue where the event is being held\n\nFiltering Type: `text`\n\n```\nEligible For: \n * event\n```" videos: description: "Valid YouTube URLs for embedding a video on some publisher sites\n\n**NOTE:** Currently, only the first URL in the Array appears in your listings.\n\n\n\nArray must be ordered.\n\n\nFiltering Type: `list of object`\n\n```\nEligible For: \n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * hotelRoomType\n * location\n * organization\n * product\n * restaurant\n```" 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.\n\nFiltering Type: `option`\n\n```\nEligible For: \n * hotel\n```" wakeUpCalls: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: "Indicates whether the entity offers wake up call services.\n\nFiltering Type: `option`\n\n```\nEligible For: \n * hotel\n```" 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\n\nFiltering Type: `object`\n\n```\nEligible For: \n * atm\n * event\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * restaurant\n```" waterPark: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: "Indicates whether the entity has a water park.\n\nFiltering Type: `option`\n\n```\nEligible For: \n * hotel\n```" waterSkiing: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: "Indicates whether the entity offers water skiing.\n\nFiltering Type: `option`\n\n```\nEligible For: \n * hotel\n```" watercraft: enum: - WATERCRAFT_RENTALS - WATERCRAFT_RENTALS_FOR_FREE - NOT_APPLICABLE type: string description: "Indicates whether the entity offers any kind of watercrafts.\n\nFiltering Type: `option`\n\n```\nEligible For: \n * hotel\n```" waterslide: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: "Indicates whether the entity has a water slide.\n\nFiltering Type: `option`\n\n```\nEligible For: \n * hotel\n```" wavePool: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: "Indicates whether the entity has a wave pool.\n\nFiltering Type: `option`\n\n```\nEligible For: \n * hotel\n```" 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\n\nFiltering Type: `object`\n\n```\nEligible For: \n * atm\n * contactCard\n * event\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * organization\n * restaurant\n```" weightMachine: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: "Indicates whether the entity has a weight machine.\n\nFiltering Type: `option`\n\n```\nEligible For: \n * hotel\n```" wheelchairAccessible: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: "Indicates if the entity is wheelchair accessible.\n\nFiltering Type: `option`\n\n```\nEligible For: \n * hotel\n```" wifiAvailable: enum: - WIFI_AVAILABLE - WIFI_AVAILABLE_FOR_FREE - NOT_APPLICABLE type: string description: "Indicates whether the entity has WiFi available\n\nFiltering Type: `option`\n\n```\nEligible For: \n * hotel\n```" workRemote: type: boolean description: "Indicates whether the job is remote.\n\nFiltering Type: `boolean`\n\n```\nEligible For: \n * job\n```" yearEstablished: multipleOf: 1 minimum: 1000 maximum: 2028 type: number description: "The year the entity was established.\n\nFiltering Type: `integer`\n\n```\nEligible For: \n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * restaurant\n```" yearLastRenovated: multipleOf: 1 minimum: 1000 maximum: 2028 type: number description: "The most recent year the entity was partially or completely renovated.\n\nFiltering Type: `integer`\n\n```\nEligible For: \n * hotel\n```" 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\n\nFiltering Type: `object`\n\n```\nEligible For: \n * atm\n * event\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * job\n * location\n * restaurant\n```" 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\n\nFiltering Type: `object`\n\n```\nEligible For: \n * atm\n * event\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * restaurant\n```" 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\n\nFiltering Type: `object`\n\n```\nEligible For: \n * atm\n * event\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * restaurant\n```" 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\n\nFiltering Type: `object`\n\n```\nEligible For: \n * atm\n * event\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * restaurant\n```" 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\n\nFiltering Type: `object`\n\n```\nEligible For: \n * atm\n * event\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * restaurant\n```" youTubeChannelUrl: minLength: 0 format: uri type: string description: "URL for your YouTube channel, format should be https://www.youtube.com/c/yourUsername\n\nFiltering Type: `text`\n\n```\nEligible For: \n * contactCard\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * organization\n * restaurant\n```" 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}/{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.\n - `false`: **Markdown** fields will be returned as JSON\n - `true`: **Markdown** fields will be returned as HTML\n" name: convertMarkdownToHTML in: query required: false - schema: minLength: 0 type: string description: "Optional parameter to return fields of type **Rich Text** as HTML.\n - `false`: **Rich Text** fields will be returned as JSON\n - `true`: **Rich Text** fields will be returned as HTML\n" 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**.\"\n\nValid values:\n * `markdown`\n * `html`\n * `none`\n" name: format in: query required: false - schema: type: boolean default: 'false' description: '- `false`: The response will only contain overridable or language-specific fields for the requested language. - `true`: The response will contain the full location profile in the requested language, including data that remains the same across languages. ' name: rendered in: query required: false tags: - Knowledge Manager summary: 'Entity Language Profiles: Get' description: 'Retrieve a Language Profile for an Entity **NOTE**: * If the **`v`** parameter is before `20190103`: by default, returned alternate Language Profiles include **`googleAttributes`** and **`categoryIds`** fields * If the **`v`** parameter is `20190103` or later: by default, returned alternate Language Profiles do not include **`googleAttributes`** and **`categoryIds`** fields. However, these fields can still be retrieved if the **`rendered`** parameter in the request is set to `true`. * If the **`v`** parameter is `20240221` or later: returned alternate Language Profiles replace the **`categoryIds`** field with the **`categories`** field. ' 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.\n\n```\nEligible For: \n * atm\n * event\n * faq\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * job\n * location\n * restaurant\n```" name: minLength: 0 maxLength: 5000 type: string description: "\n\n\nCannot Include:\n* HTML markup\n\nFiltering Type: `text`\n\n```\nEligible For: \n * atm\n * board\n * brand\n * card\n * contactCard\n * event\n * faq\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * helpArticle\n * hotel\n * hotelRoomType\n * job\n * location\n * organization\n * product\n * restaurant\n```" 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)\n\nMust be a valid address\nCannot be a P.O. Box\n\nIf the entity is an `event`, either an **`address`** value or a **`linkedLocation`** value can be provided.\n\nFiltering Type: `object`\n\n```\nEligible For: \n * atm\n * event\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * restaurant\n```" acceptingNewPatients: type: boolean description: "Indicates whether the healthcare provider is accepting new patients.\n\nFiltering Type: `boolean`\n\n```\nEligible For: \n * healthcareFacility\n * healthcareProfessional\n```" acceptsReservations: type: boolean description: "Indicates whether the entity accepts reservations.\n\nFiltering Type: `boolean`\n\n```\nEligible For: \n * restaurant\n```" 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.\n\nEach 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.\nSimilarly, holiday access hours are represented by the `holidayHours` sub-field.\nSetting the `reopenDate` sub-field indicates that the business is temporarily closed and will reopen on the specified date.\nSPECIAL CASES:\n* 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.\n* 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.\n* If you are providing `openIntervals`, you may not set `isClosed` to true for that day.\n\nFiltering Type: `hours`\n\n```\nEligible For: \n * atm\n * healthcareFacility\n * hotel\n * location\n * restaurant\n```" additionalHoursText: minLength: 0 maxLength: 255 type: string description: "Additional information about hours that does not fit in **`hours`** (e.g., `\"Closed during the winter\"`)\n\nFiltering Type: `text`\n\n```\nEligible For: \n * atm\n * contactCard\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * restaurant\n```" additionalPromotingLocations: description: "If other locations are promoting this event, a list of those locations' **`id`**s in the Yext Knowledge Manager\n\n\nArray must be ordered.\n\n\nFiltering Type: `list of entityId`\n\n```\nEligible For: \n * event\n```" 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`.\n\nFiltering Type: `boolean`\n\n```\nEligible For: \n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * restaurant\n```" admittingHospitals: description: "A list of hospitals where the healthcare professional admits patients\n\n\nArray must be ordered.\n\nArray may have a maximum of 100 elements.\n\nArray item description:\n\n>Cannot Include:\n>* HTML markup\n\nFiltering Type: `list of text`\n\n```\nEligible For: \n * healthcareProfessional\n```" 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.\n\nFiltering Type: `option`\n\n```\nEligible For: \n * hotel\n```" 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\n\nFiltering Type: `object`\n\n```\nEligible For: \n * event\n```" 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.\n\nFiltering Type: `option`\n\n```\nEligible For: \n * hotel\n```" 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.\n\nFiltering Type: `option`\n\n```\nEligible For: \n * hotel\n```" allInclusive: enum: - ALL_INCLUSIVE_RATES_AVAILABLE - ALL_INCLUSIVE_RATES_ONLY - NOT_APPLICABLE type: string description: "Indicates whether the entity offers all-inclusive rates.\n\nFiltering Type: `option`\n\n```\nEligible For: \n * hotel\n```" alternateNames: description: "Other names for your business that you would like us to use when tracking your search performance\n\n\nArray must be ordered.\n\nArray may have a maximum of 3 elements.\n\nArray item description:\n\n>Cannot Include:\n>* HTML markup\n\nFiltering Type: `list of text`\n\n```\nEligible For: \n * atm\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * organization\n * restaurant\n```" 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.\n\nIf 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.\n\nFiltering Type: `text`\n\n```\nEligible For: \n * atm\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * restaurant\n```" alternateWebsites: description: "Other websites for your business that we should search for when tracking your search performance\n\n\nArray must be ordered.\n\nArray may have a maximum of 3 elements.\n\nArray item description:\n\n>Cannot Include:\n>* common domain names, e.g., google.com, youtube.com, etc.\n\nFiltering Type: `list of text`\n\n```\nEligible For: \n * atm\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * organization\n * restaurant\n```" 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\n\nFiltering Type: `text`\n\n```\nEligible For: \n * brand\n * financialProfessional\n * hotel\n * location\n * restaurant\n```" answer: description: "The answer to the frequently asked question represented by this entity\n\n\nCharacter limit: 0 .. 15000\n\nSupported formats include:\n* BOLD\n* ITALICS\n* UNDERLINE\n* BULLETED_LIST\n* NUMBERED_LIST\n* HYPERLINK\n* IMAGE\n* CODE_SPAN\n* HEADINGS\n\n```\nEligible For: \n * faq\n```" type: string format: rich-text appleActionLinks: description: "Use this field to add action links to your Apple Listings.\n\nThe call to action category will be displayed on the action link button.\n\nThe App Store URL should contain a valid link to the landing page of an App in the Apple App Store.\n\nThe Quick Link URL is where a user is taken when an action link is clicked by a user.\n\nThe 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.\n\n\nArray must be ordered.\n\n\nFiltering Type: `list of object`\n\n```\nEligible For: \n * atm\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * restaurant\n```" 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\n\nFiltering Type: `text`\n\n```\nEligible For: \n * atm\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * restaurant\n```" appleBusinessId: minLength: 0 pattern: ^\d*\.?\d*$ type: string description: "The ID associated with an individual Business Folder in your Apple account\n\nFiltering Type: `text`\n\n```\nEligible For: \n * atm\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * restaurant\n```" appleCompanyId: minLength: 0 pattern: ^\d*\.?\d*$ type: string description: "The ID associated with your Apple account. Numerical values only\n\nFiltering Type: `text`\n\n```\nEligible For: \n * atm\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * restaurant\n```" appleCoverPhoto: required: - url additionalProperties: false type: object description: "The cover photo for the entity''s Apple profile\n\n\nImage must be at least 1600 x 1040 pixels\n\nImage may be no more than 4864 x 3163 pixels\n\nSupported Aspect Ratios:\n* 154 x 100\n\n**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.\n\n\nFiltering Type: `object`\n\n```\nEligible For: \n * atm\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * restaurant\n```" 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.\nNOTE: The names of Brands and their respective Locations within an Apple Business Connect Account must match identically.\nCannot Include:\nHTML markup \n\n\nCannot Include:\n* HTML markup\n\nFiltering Type: `text`\n\n```\nEligible For: \n * atm\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * restaurant\n```" applicationUrl: minLength: 0 format: uri type: string description: "The application URL\n\nFiltering Type: `text`\n\n```\nEligible For: \n * job\n```" associations: description: "Association memberships relevant to the entity (e.g., `\"New York Doctors Association\"`)\nAll strings must be non-empty when trimmed of whitespace.\n\n\n\nArray must be ordered.\n\nArray may have a maximum of 100 elements.\n\nArray item description:\n\n>Cannot Include:\n>* HTML markup\n\nFiltering Type: `list of text`\n\n```\nEligible For: \n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * restaurant\n```" 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.\nA `virtualLocationUrl` must be specified for online and mixed events.\n\nFiltering Type: `object`\n\n```\nEligible For: \n * event\n```" attire: enum: - UNSPECIFIED - DRESSY - CASUAL - FORMAL type: string description: "The formality of clothing typically worn at this restaurant\n\nFiltering Type: `option`\n\n```\nEligible For: \n * restaurant\n```" babysittingOffered: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: "Indicates whether the entity offers babysitting.\n\nFiltering Type: `option`\n\n```\nEligible For: \n * hotel\n```" baggageStorage: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: "Indicates whether the entity offers baggage storage pre check-in and post check-out.\n\nFiltering Type: `option`\n\n```\nEligible For: \n * hotel\n```" bar: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: "Indicates whether the entity has an indoor or outdoor bar onsite.\n\nFiltering Type: `option`\n\n```\nEligible For: \n * hotel\n```" beachAccess: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: "Indicates whether the entity has access to a beach.\n\nFiltering Type: `option`\n\n```\nEligible For: \n * hotel\n```" beachFrontProperty: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: "Indicates whether the entity is physically located next to a beach.\n\nFiltering Type: `option`\n\n```\nEligible For: \n * hotel\n```" bicycles: enum: - BICYCLE_RENTALS - BICYCLE_RENTALS_FOR_FREE - NOT_APPLICABLE type: string description: "Indicates whether the entity offers bicycles for rent or for free.\n\nFiltering Type: `option`\n\n```\nEligible For: \n * hotel\n```" 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\n\nFiltering Type: `object`\n\n```\nEligible For: \n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * organization\n * restaurant\n```" 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.\n\nFiltering Type: `option`\n\n```\nEligible For: \n * hotel\n```" brands: description: "Brands sold by this entity\nAll strings must be non-empty when trimmed of whitespace.\n\n\n\nArray must be ordered.\n\nArray may have a maximum of 100 elements.\n\nArray item description:\n\n>Cannot Include:\n>* HTML markup\n\nFiltering Type: `list of text`\n\n```\nEligible For: \n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * restaurant\n```" 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.\n\nFiltering Type: `option`\n\n```\nEligible For: \n * hotel\n```" 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.\n\nEach 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.\nSimilarly, holiday brunch hours are represented by the `holidayHours` sub-field.\nSetting the `reopenDate` sub-field indicates that the business is temporarily closed and will reopen on the specified date.\nSPECIAL CASES:\n* 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.\n* 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.\n* If you are providing `openIntervals`, you may not set `isClosed` to true for that day.\n\nFiltering Type: `hours`\n\n```\nEligible For: \n * hotel\n * location\n * restaurant\n```" businessCenter: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: "Indicates whether the entity has a business center.\n\nFiltering Type: `option`\n\n```\nEligible For: \n * hotel\n```" 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\n\nFiltering Type: `object`\n\n```\nEligible For: \n * financialProfessional\n * healthcareFacility\n * hotel\n * location\n * restaurant\n```" carRental: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: "Indicates whether the entity offers car rental.\n\nFiltering Type: `option`\n\n```\nEligible For: \n * hotel\n```" casino: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: "Indicates whether the entity has a casino on premise or nearby.\n\nFiltering Type: `option`\n\n```\nEligible For: \n * hotel\n```" categories: additionalProperties: false type: object properties: {} description: "Yext Categories. (Supported for versions > 20240220)\n\nA map of category list external IDs (i.e. \"yext\") to a list of category IDs.\n\nIDs must be valid and selectable (i.e., cannot be parent categories).\n\nPartial updates are accepted, meaning sending only the \"yext\" property will have no effect on any category list except the \"yext\" category. \n\nFiltering Type: `object`\n\n```\nEligible For: \n * atm\n * event\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * restaurant\n```" categoryIds: uniqueItems: false type: array items: minLength: 0 type: string description: 'Filtering Type: `text`' description: "Yext Category IDs. (Deprecated: For versions > 20240220)\n\nIDs must be valid and selectable (i.e., cannot be parent categories).\n\nNOTE: 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.\n\n\nFiltering Type: `list of text`\n\n```\nEligible For: \n * atm\n * event\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * restaurant\n```" catsAllowed: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: "Indicates if the entity is cat friendly.\n\nFiltering Type: `option`\n\n```\nEligible For: \n * hotel\n```" certifications: description: "A list of the certifications held by the healthcare professional\n**NOTE:** This field is only available to locations whose **`entityType`** is `healthcareProfessional`.\n\n\n\nArray must be ordered.\n\nArray may have a maximum of 100 elements.\n\nArray item description:\n\n>Cannot Include:\n>* HTML markup\n\nFiltering Type: `list of text`\n\n```\nEligible For: \n * financialProfessional\n * healthcareProfessional\n```" 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\n\nFiltering Type: `time`\n\n```\nEligible For: \n * hotel\n```" checkOutTime: format: time type: string description: "The check-out time\n\nFiltering Type: `time`\n\n```\nEligible For: \n * hotel\n```" classificationRating: pattern: ^\d*\.?\d*$ type: string description: "The 1 to 5 star rating of the entitiy based on its services and facilities.\n\nFiltering Type: `decimal`\n\n```\nEligible For: \n * hotel\n```" closed: type: boolean description: "Indicates whether the entity is closed\n\nFiltering Type: `boolean`\n\n```\nEligible For: \n * atm\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * restaurant\n```" concierge: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: "Indicates whether the entity offers concierge service.\n\nFiltering Type: `option`\n\n```\nEligible For: \n * hotel\n```" conditionsTreated: description: "A list of the conditions treated by the healthcare provider\n\n\nArray must be ordered.\n\nArray may have a maximum of 100 elements.\n\nArray item description:\n\n>Cannot Include:\n>* HTML markup\n\nFiltering Type: `list of text`\n\n```\nEligible For: \n * healthcareFacility\n * healthcareProfessional\n```" 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.\n\nFiltering Type: `option`\n\n```\nEligible For: \n * hotel\n```" covidMessaging: minLength: 0 maxLength: 15000 type: string description: "Information or messaging related to COVID-19.\n\nFiltering Type: `text`\n\n```\nEligible For: \n * healthcareFacility\n * healthcareProfessional\n * location\n```" covidTestAppointmentUrl: minLength: 0 format: uri type: string description: "An appointment URL for scheduling a COVID-19 test.\n\nFiltering Type: `text`\n\n```\nEligible For: \n * healthcareFacility\n * location\n```" covidTestingAppointmentRequired: type: boolean description: "Indicates whether an appointment is required for a COVID-19 test.\n\nFiltering Type: `boolean`\n\n```\nEligible For: \n * healthcareFacility\n * location\n```" covidTestingDriveThroughSite: type: boolean description: "Indicates whether location is a drive-through site for COVID-19 tests.\n\nFiltering Type: `boolean`\n\n```\nEligible For: \n * healthcareFacility\n * location\n```" covidTestingIsFree: type: boolean description: "Indicates whether location offers free COVID-19 testing.\n\nFiltering Type: `boolean`\n\n```\nEligible For: \n * healthcareFacility\n * location\n```" covidTestingPatientRestrictions: type: boolean description: "Indicates whether there are patient restrictions for COVID-19 testing.\n\nFiltering Type: `boolean`\n\n```\nEligible For: \n * healthcareFacility\n * location\n```" covidTestingReferralRequired: type: boolean description: "Indicates whether a referral is required for COVID-19 testing.\n\nFiltering Type: `boolean`\n\n```\nEligible For: \n * healthcareFacility\n * location\n```" covidTestingSiteInstructions: minLength: 0 maxLength: 15000 type: string description: "Information or instructions for the COVID-19 testing site.\n\nFiltering Type: `text`\n\n```\nEligible For: \n * healthcareFacility\n * location\n```" covidVaccineAppointmentRequired: type: boolean description: "Indicates whether an appointment is required for a COVID-19 vaccine.\n\nFiltering Type: `boolean`\n\n```\nEligible For: \n * healthcareFacility\n * location\n```" covidVaccineDriveThroughSite: type: boolean description: "Indicates whether location is a drive-through site for COVID-19 vaccines.\n\nFiltering Type: `boolean`\n\n```\nEligible For: \n * healthcareFacility\n * location\n```" covidVaccineInformationUrl: minLength: 0 format: uri type: string description: "An information URL for more information about COVID-19 vaccines.\n\nFiltering Type: `text`\n\n```\nEligible For: \n * healthcareFacility\n * location\n```" covidVaccinePatientRestrictions: type: boolean description: "Indicates whether there are patient restrictions for a COVID-19 vaccine.\n\nFiltering Type: `boolean`\n\n```\nEligible For: \n * healthcareFacility\n * location\n```" covidVaccineReferralRequired: type: boolean description: "Indicates whether a referral is required for a COVID-19 vaccine.\n\nFiltering Type: `boolean`\n\n```\nEligible For: \n * healthcareFacility\n * location\n```" covidVaccineSiteInstructions: minLength: 0 maxLength: 15000 type: string description: "Information or instructions for the COVID-19 vaccination site.\n\nFiltering Type: `text`\n\n```\nEligible For: \n * healthcareFacility\n * location\n```" 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.\n\nFiltering Type: `list of option`\n\n```\nEligible For: \n * healthcareFacility\n * location\n```" currencyExchange: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: "Indicates whether the entity offers currency exchange services.\n\nFiltering Type: `option`\n\n```\nEligible For: \n * hotel\n```" customKeywords: description: "Additional keywords you would like us to use when tracking your search performance\n\n\nArray must be ordered.\n\nArray may have a maximum of 5 elements.\n\n\nFiltering Type: `list of text`\n\n```\nEligible For: \n * atm\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * organization\n * restaurant\n```" 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\n\nFiltering Type: `date`\n\n```\nEligible For: \n * job\n```" degrees: description: "A list of the degrees earned by the healthcare professional\n\n\nArray must be ordered.\n\n\nFiltering Type: `list of option`\n\n```\nEligible For: \n * healthcareProfessional\n```" 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.\n\nEach 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.\nSimilarly, holiday delivery hours are represented by the `holidayHours` sub-field.\nSetting the `reopenDate` sub-field indicates that the business is temporarily closed and will reopen on the specified date.\nSPECIAL CASES:\n* 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.\n* 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.\n* If you are providing `openIntervals`, you may not set `isClosed` to true for that day.\n\nFiltering Type: `hours`\n\n```\nEligible For: \n * location\n * restaurant\n```" description: minLength: 10 maxLength: 15000 type: string description: "A description of the entity\n\n\nCannot Include:\n* HTML markup\n\nFiltering Type: `text`\n\n```\nEligible For: \n * atm\n * contactCard\n * event\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * job\n * location\n * organization\n * restaurant\n```" 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\n\nFiltering Type: `object`\n\n```\nEligible For: \n * atm\n * event\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * job\n * location\n * restaurant\n```" doctorOnCall: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: "Indicates whether the entity has a doctor on premise or on call.\n\nFiltering Type: `option`\n\n```\nEligible For: \n * hotel\n```" dogsAllowed: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: "Indicates if the entity is dog friendly.\n\nFiltering Type: `option`\n\n```\nEligible For: \n * hotel\n```" 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.\n\nEach 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.\nSimilarly, holiday drive-through hours are represented by the `holidayHours` sub-field.\nSetting the `reopenDate` sub-field indicates that the business is temporarily closed and will reopen on the specified date.\nSPECIAL CASES:\n* 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.\n* 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.\n* If you are providing `openIntervals`, you may not set `isClosed` to true for that day.\n\nFiltering Type: `hours`\n\n```\nEligible For: \n * atm\n * location\n * restaurant\n```" 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\n\nFiltering Type: `object`\n\n```\nEligible For: \n * atm\n * event\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * restaurant\n```" educationList: description: "Information about the education or training completed by the healthcare professional\n\n\nArray must be ordered.\n\n\nFiltering Type: `list of object`\n\n```\nEligible For: \n * healthcareProfessional\n```" 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.\n\nFiltering Type: `option`\n\n```\nEligible For: \n * hotel\n```" elevator: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: "Indicates whether the entity has an elevator.\n\nFiltering Type: `option`\n\n```\nEligible For: \n * hotel\n```" ellipticalMachine: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: "Indicates whether the entity has an elliptical machine.\n\nFiltering Type: `option`\n\n```\nEligible For: \n * hotel\n```" emails: description: "Emails addresses for this entity's point of contact\n\nMust be valid email addresses\n\n\n\nArray must be ordered.\n\nArray may have a maximum of 5 elements.\n\n\nFiltering Type: `list of text`\n\n```\nEligible For: \n * contactCard\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * organization\n * restaurant\n```" 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.\n\nFiltering Type: `option`\n\n```\nEligible For: \n * job\n```" eventStatus: enum: - SCHEDULED - RESCHEDULED - POSTPONED - CANCELED - EVENT_MOVED_ONLINE type: string description: "Information on whether the event will take place as scheduled\n\nFiltering Type: `option`\n\n```\nEligible For: \n * event\n```" facebookAbout: minLength: 0 maxLength: 255 type: string description: "A description of the entity to be used in the \"About You\" section on Facebook\n\nFiltering Type: `text`\n\n```\nEligible For: \n * atm\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * restaurant\n```" 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\n\nValid contents of **`value`** depends on the Call-to-Action's **`type`**:\n* `NONE`: (optional)\n* `BOOK_NOW`: URL\n* `CALL_NOW`: Phone number\n* `CONTACT_US`: URL\n* `SEND_MESSAGE`: Any string\n* `USE_APP`: URL\n* `PLAY_GAME`: URL\n* `SHOP_NOW`: URL\n* `SIGN_UP`: URL\n* `WATCH_VIDEO`: URL\n* `SEND_EMAIL`: Email address\n* `LEARN_MORE`: URL\n* `PURCHASE_GIFT_CARDS`: URL\n* `ORDER_NOW`: URL\n* `FOLLOW_PAGE`: Any string\n\nFiltering Type: `object`\n\n```\nEligible For: \n * atm\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * restaurant\n```" facebookCoverPhoto: required: - url additionalProperties: false type: object description: "The cover photo for the entity's Facebook profile\n\nDisplayed as a 851 x 315 pixel image\n\nYou may need a cover photo in order for your listing to appear on Facebook. Please check your listings tab to learn more.\n\n\nImage must be at least 400 x 150 pixels\n\nImage area (width x height) may be no more than 41000000 pixels\n\nImage may be no more than 30000 x 30000 pixels\n\nSupported Aspect Ratios:\n* 1 x 1\n* 4 x 3\n* 3 x 2\n* 5 x 3\n* 16 x 9\n* 3 x 1\n* 2 x 3\n* 5 x 7\n* 4 x 5\n* 4 x 1\n\n**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.\n\n\nFiltering Type: `object`\n\n```\nEligible For: \n * atm\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * restaurant\n```" 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.\n\n\nCannot Include:\n* HTML markup\n\nFiltering Type: `text`\n\n```\nEligible For: \n * atm\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * restaurant\n```" 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.\n\nFiltering Type: `text`\n\n```\nEligible For: \n * atm\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * restaurant\n```" facebookOverrideCity: minLength: 0 type: string description: "The city to be displayed on this entity's Facebook profile\n\nFiltering Type: `text`\n\n```\nEligible For: \n * atm\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * restaurant\n```" facebookPageUrl: minLength: 0 type: string description: "URL for the entity's Facebook Page.\n\nValid formats:\n\n- facebook.com/profile.php?id=[numId]\n- facebook.com/group.php?gid=[numId]\n- facebook.com/groups/[numId]\n- facebook.com/[Name]\n- facebook.com/pages/[Name]/[numId]\n- facebook.com/people/[Name]/[numId]\n\nwhere [Name] is a String and [numId] is an Integer\nThe success response will contain a warning message explaining why the URL wasn't stored in the system.\n\nFiltering Type: `text`\n\n```\nEligible For: \n * atm\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * organization\n * restaurant\n```" 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\n\nFiltering Type: `text`\n\n```\nEligible For: \n * atm\n * brand\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * restaurant\n```" facebookProfilePhoto: required: - url additionalProperties: false type: object description: "The profile picture for the entity's Facebook profile\n\nYou must have a profile picture in order for your listing to appear on Facebook.\n\n\nImage must be at least 180 x 180 pixels\n\nImage area (width x height) may be no more than 41000000 pixels\n\nImage may be no more than 30000 x 30000 pixels\n\nSupported Aspect Ratios:\n* 1 x 1\n* 4 x 3\n* 3 x 2\n* 5 x 3\n* 16 x 9\n* 3 x 1\n* 2 x 3\n* 5 x 7\n* 4 x 5\n* 4 x 1\n\n**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.\n\n\nFiltering Type: `object`\n\n```\nEligible For: \n * atm\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * restaurant\n```" 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\n\nFiltering Type: `text`\n\n```\nEligible For: \n * atm\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * restaurant\n```" 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.\n\nFiltering Type: `text`\n\n```\nEligible For: \n * atm\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * restaurant\n```" 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).\n\nFiltering Type: `text`\n\n```\nEligible For: \n * atm\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * restaurant\n```" fax: minLength: 0 type: string description: "Must be a valid fax number.\n\nIf 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.\n\nFiltering Type: `text`\n\n```\nEligible For: \n * atm\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * restaurant\n```" 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\n\nFiltering Type: `object`\n\n```\nEligible For: \n * atm\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * restaurant\n```" firstName: minLength: 0 maxLength: 35 type: string description: "The first name of the healthcare professional\n\n\nCannot Include:\n* a URL or domain name\n* HTML markup\n\nFiltering Type: `text`\n\n```\nEligible For: \n * healthcareProfessional\n```" firstPartyReviewPage: minLength: 0 type: string description: "Link to the review-collection page, where consumers can leave first-party reviews\n\n```\nEligible For: \n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * restaurant\n```" fitnessCenter: enum: - FITNESS_CENTER_AVAILABLE - FITNESS_CENTER_AVAILABLE_FOR_FREE - NOT_APPLICABLE type: string description: "Indicates whether the entity has a fitness center.\n\nFiltering Type: `option`\n\n```\nEligible For: \n * hotel\n```" floorCount: multipleOf: 1 minimum: 0 type: number description: "The number of floors the entity has from ground floor to top floor.\n\nFiltering Type: `integer`\n\n```\nEligible For: \n * hotel\n```" freeWeights: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: "Indicates whether the entity has free weights.\n\nFiltering Type: `option`\n\n```\nEligible For: \n * hotel\n```" frequentlyAskedQuestions: description: "A list of questions that are frequently asked about this entity\n\n\nArray must be ordered.\n\nArray may have a maximum of 100 elements.\n\n\nFiltering Type: `list of object`\n\n```\nEligible For: \n * atm\n * event\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * restaurant\n```" 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.\n\nFiltering Type: `option`\n\n```\nEligible For: \n * hotel\n```" fullyVaccinatedStaff: type: boolean description: "Indicates whether the staff is vaccinated against COVID-19.\n\nFiltering Type: `boolean`\n\n```\nEligible For: \n * healthcareFacility\n * hotel\n * location\n * restaurant\n```" gameRoom: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: "Indicates whether the entity has a game room.\n\nFiltering Type: `option`\n\n```\nEligible For: \n * hotel\n```" gender: enum: - UNSPECIFIED - FEMALE - MALE - NONBINARY - TRANSGENDER_FEMALE - TRANSGENDER_MALE - OTHER - PREFER_NOT_TO_DISCLOSE type: string description: "The gender of the healthcare professional\n\nFiltering Type: `option`\n\n```\nEligible For: \n * healthcareProfessional\n```" geomodifier: minLength: 0 type: string description: "Provides additional information on where the entity can be found (e.g., `Times Square`, `Global Center Mall`)\n\nFiltering Type: `text`\n\n```\nEligible For: \n * atm\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * restaurant\n```" giftShop: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: "Indicates whether the entity has a gift shop.\n\nFiltering Type: `option`\n\n```\nEligible For: \n * hotel\n```" 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.\n\nFiltering Type: `option`\n\n```\nEligible For: \n * hotel\n```" 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.\n\nValid 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.\n\nKeyword 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`).\n\n* 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\" ] }]`)\n* 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\" ]}`)\n\n**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.\n\nFiltering Type: `object`\n\n```\nEligible For: \n * atm\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * restaurant\n```" googleCoverPhoto: required: - url additionalProperties: false type: object description: "The cover photo for the entity's Google profile\n\n\nImage must be at least 250 x 250 pixels\n\n\nFiltering Type: `object`\n\n```\nEligible For: \n * atm\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * restaurant\n```" 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.\nMust be a valid phone number.\nIf 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. \n\nFiltering 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.\n\nNOTE: 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.\n\nFiltering Type: `object`\n\n```\nEligible For: \n * atm\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * restaurant\n```" googleMyBusinessLabels: description: "Google Business Profile Labels help users organize their locations into groups within GBP.\n\n\nArray must be ordered.\n\nArray may have a maximum of 10 elements.\n\nArray item description:\n\n>Cannot Include:\n>* HTML markup\n\nFiltering Type: `list of text`\n\n```\nEligible For: \n * atm\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * restaurant\n```" 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.\n\nFiltering Type: `text`\n\n```\nEligible For: \n * atm\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * restaurant\n```" googleProfilePhoto: required: - url additionalProperties: false type: object description: "The profile photo for the entity's Google profile\n\n\nImage must be at least 250 x 250 pixels\n\nImage may be no more than 5000 x 5000 pixels\n\nSupported Aspect Ratios:\n* 1 x 1\n\n**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.\n\n\nFiltering Type: `object`\n\n```\nEligible For: \n * atm\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * restaurant\n```" 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).\n\nFor 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.\n\nFiltering Type: `text`\n\n```\nEligible For: \n * atm\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * restaurant\n```" 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.\n\nEach 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.\nSimilarly, holiday happy hours are represented by the `holidayHours` sub-field.\nSetting the `reopenDate` sub-field indicates that the business is temporarily closed and will reopen on the specified date.\nSPECIAL CASES:\n* 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.\n* 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.\n* If you are providing `openIntervals`, you may not set `isClosed` to true for that day.\n\nFiltering Type: `hours`\n\n```\nEligible For: \n * hotel\n * location\n * restaurant\n```" headshot: required: - url additionalProperties: false type: object description: "A portrait of the healthcare professional\n\nFiltering Type: `object`\n\n```\nEligible For: \n * contactCard\n * financialProfessional\n * healthcareProfessional\n```" 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\n\nFiltering Type: `text`\n\n```\nEligible For: \n * job\n```" holidayHoursConversationEnabled: type: boolean description: "Indicates whether holiday-hour confirmation alerts are enabled for the Yext Knowledge Assistant for this entity\n\nFiltering Type: `boolean`\n\n```\nEligible For: \n * atm\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * restaurant\n```" horsebackRiding: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: "Indicates whether the entity offers horseback riding.\n\nFiltering Type: `option`\n\n```\nEligible For: \n * hotel\n```" hotTub: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: "Indicates whether the entity has a hot tub.\n\nFiltering Type: `option`\n\n```\nEligible For: \n * hotel\n```" 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.\n\nEach 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.\nSimilarly, holiday hours are represented by the `holidayHours` sub-field.\nSetting the `reopenDate` sub-field indicates that the business is temporarily closed and will reopen on the specified date.\nSPECIAL CASES:\n* 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.\n* 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.\n* If you are providing `openIntervals`, you may not set `isClosed` to true for that day.\n\nFiltering Type: `hours`\n\n```\nEligible For: \n * atm\n * contactCard\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * restaurant\n```" housekeeping: enum: - HOUSEKEEPING_AVAILABLE - HOUSEKEEPING_AVAILABLE_DAILY - NOT_APPLICABLE type: string description: "Indicates whether the entity offers housekeeping services.\n\nFiltering Type: `option`\n\n```\nEligible For: \n * hotel\n```" 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.\n\nFiltering Type: `text`\n\n```\nEligible For: \n * atm\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * restaurant\n```" indoorPoolCount: multipleOf: 1 minimum: 0 type: number description: "A count of the number of indoor pools\n\nFiltering Type: `integer`\n\n```\nEligible For: \n * hotel\n```" instagramHandle: minLength: 0 maxLength: 30 type: string description: "Valid Instagram username for the entity without the leading \"@\" (e.g., `NewCityAuto`)\n\nFiltering Type: `text`\n\n```\nEligible For: \n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * organization\n * restaurant\n```" insuranceAccepted: description: "A list of insurance policies accepted by the healthcare provider\n\n\nArray must be ordered.\n\nArray may have a maximum of 100 elements.\n\nArray item description:\n\n>Cannot Include:\n>* HTML markup\n\nFiltering Type: `list of text`\n\n```\nEligible For: \n * healthcareFacility\n * healthcareProfessional\n```" 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\n\nFiltering Type: `text`\n\n```\nEligible For: \n * brand\n * financialProfessional\n * hotel\n * location\n * restaurant\n```" isClusterPrimary: type: boolean description: "Indicates whether the healthcare entity is the primary entity in its group\n\nFiltering Type: `boolean`\n\n```\nEligible For: \n * healthcareProfessional\n```" isFreeEvent: type: boolean description: "Indicates whether or not the event is free\n\nFiltering Type: `boolean`\n\n```\nEligible For: \n * event\n```" isoRegionCode: minLength: 0 type: string description: "The ISO 3166-2 region code for the entity\n\nYext 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.\n\nFiltering Type: `text`\n\n```\nEligible For: \n * atm\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * restaurant\n```" keywords: description: "Keywords that describe the entity.\n\nAll strings must be non-empty when trimmed of whitespace.\n\n\n\nArray must be ordered.\n\nArray may have a maximum of 100 elements.\n\nArray item description:\n\n>Cannot Include:\n>* HTML markup\n\nFiltering Type: `list of text`\n\n```\nEligible For: \n * atm\n * card\n * event\n * faq\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * helpArticle\n * hotel\n * job\n * location\n * product\n * restaurant\n```" 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.\n\nFiltering Type: `option`\n\n```\nEligible For: \n * hotel\n```" kidsClub: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: "Indicates if the property has a Kids Club.\n\nFiltering Type: `option`\n\n```\nEligible For: \n * hotel\n```" kidsStayFree: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: "Indicates whether the entity allows kids to stay free.\n\nFiltering Type: `option`\n\n```\nEligible For: \n * hotel\n```" 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.\n\nEach 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.\nSimilarly, holiday kitchen hours are represented by the `holidayHours` sub-field.\nSetting the `reopenDate` sub-field indicates that the business is temporarily closed and will reopen on the specified date.\nSPECIAL CASES:\n* 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.\n* 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.\n* If you are providing `openIntervals`, you may not set `isClosed` to true for that day.\n\nFiltering Type: `hours`\n\n```\nEligible For: \n * hotel\n * location\n * restaurant\n```" 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.\n\n**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.\n\nFiltering Type: `opaque`\n\n```\nEligible For: \n * atm\n * board\n * brand\n * card\n * contactCard\n * event\n * faq\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * helpArticle\n * hotel\n * hotelRoomType\n * job\n * location\n * organization\n * product\n * restaurant\n```" landingPageUrl: minLength: 0 format: uri type: string description: "The URL of this entity's Landing Page that was created with Yext Pages\n\nFiltering Type: `text`\n\n```\nEligible For: \n * atm\n * card\n * event\n * faq\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * helpArticle\n * hotel\n * job\n * location\n * product\n * restaurant\n```" languages: description: "The langauges in which consumers can commicate with this entity or its staff members\nAll strings must be non-empty when trimmed of whitespace.\n\n\n\nArray must be ordered.\n\nArray may have a maximum of 100 elements.\n\nArray item description:\n\n>Cannot Include:\n>* HTML markup\n\nFiltering Type: `list of text`\n\n```\nEligible For: \n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * restaurant\n```" 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\n\n\nCannot Include:\n* a URL or domain name\n* HTML markup\n\nFiltering Type: `text`\n\n```\nEligible For: \n * healthcareProfessional\n```" laundry: enum: - FULL_SERVICE - SELF_SERVICE - NOT_APPLICABLE type: string description: "Indicates whether the entity offers laundry services.\n\nFiltering Type: `option`\n\n```\nEligible For: \n * hotel\n```" lazyRiver: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: "Indicates if the property has a lazy river\n\nFiltering Type: `option`\n\n```\nEligible For: \n * hotel\n```" lifeguard: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: "Indicates if the property has a lifeguard on duty\n\nFiltering Type: `option`\n\n```\nEligible For: \n * hotel\n```" linkedInUrl: minLength: 0 format: uri type: string description: "URL for your LinkedIn account, format should be https://www.linkedin.com/in/yourUsername\n\nFiltering Type: `text`\n\n```\nEligible For: \n * contactCard\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * organization\n * restaurant\n```" linkedLocation: type: string description: "location ID of the event location, if the event is held at a location managed in the Yext Knowledge Manager\n\nFiltering Type: `entityId`\n\n```\nEligible For: \n * contactCard\n * event\n```" 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.\n\nFiltering Type: `text`\n\n```\nEligible For: \n * atm\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * restaurant\n```" localShuttle: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: "Indicates whether the entity offers local shuttle services.\n\nFiltering Type: `option`\n\n```\nEligible For: \n * hotel\n```" 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.\n\nFiltering Type: `entityId`\n\n```\nEligible For: \n * atm\n```" 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\n\nFiltering Type: `object`\n\n```\nEligible For: \n * job\n```" locationType: enum: - LOCATION - HEALTHCARE_FACILITY - HEALTHCARE_PROFESSIONAL - ATM - RESTAURANT - HOTEL type: string description: "Indicates the entity's type, if it is not an event\n\nFiltering Type: `option`\n\n```\nEligible For: \n * atm\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * restaurant\n```" logo: required: - image additionalProperties: false type: object description: "An image of the entity's logo\n\n\nSupported Aspect Ratios:\n* 1 x 1\n\n**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.\n\n\nFiltering Type: `object`\n\n```\nEligible For: \n * atm\n * contactCard\n * faq\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * job\n * location\n * organization\n * restaurant\n```" 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\n\nMust be a valid phone number.\n\nIf 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.\n\nFiltering Type: `text`\n\n```\nEligible For: \n * atm\n * contactCard\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * organization\n * restaurant\n```" massage: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: "Indicates whether the entity offers massage services.\n\nFiltering Type: `option`\n\n```\nEligible For: \n * hotel\n```" 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\n\nFiltering Type: `integer`\n\n```\nEligible For: \n * hotel\n```" 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\n\nFiltering Type: `integer`\n\n```\nEligible For: \n * hotel\n```" 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\n\nFiltering Type: `list of option`\n\n```\nEligible For: \n * restaurant\n```" meetingRoomCount: multipleOf: 1 minimum: 0 type: number description: "The number of meeting rooms the entity has.\n\nFiltering Type: `integer`\n\n```\nEligible For: \n * hotel\n```" 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\n\nFiltering Type: `object`\n\n```\nEligible For: \n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * restaurant\n```" 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\n\nFiltering Type: `object`\n\n```\nEligible For: \n * hotel\n * location\n * restaurant\n```" middleName: minLength: 0 maxLength: 35 type: string description: "The middle name of the healthcare professional\n\n\nCannot Include:\n* a URL or domain name\n* HTML markup\n\nFiltering Type: `text`\n\n```\nEligible For: \n * healthcareProfessional\n```" mobilePhone: minLength: 0 type: string description: "Must be a valid phone number.\n\nIf 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.\n\nFiltering Type: `text`\n\n```\nEligible For: \n * atm\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * restaurant\n```" mobilityAccessible: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: "Indicates whether the entity is mobility/wheelchair accessible\n\nFiltering Type: `option`\n\n```\nEligible For: \n * hotel\n```" nightclub: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: "Indicates whether the entity has a nightclub.\n\nFiltering Type: `option`\n\n```\nEligible For: \n * hotel\n```" npi: minLength: 0 type: string description: "The National Provider Identifier (NPI) of the healthcare provider\n\nFiltering Type: `text`\n\n```\nEligible For: \n * healthcareFacility\n * healthcareProfessional\n```" nudgeEnabled: type: boolean description: "Indicates whether Knowledge Nudge is enabled for the Yext Knowledge Assistant for this entity\n\nFiltering Type: `boolean`\n\n```\nEligible For: \n * atm\n * faq\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * helpArticle\n * hotel\n * job\n * location\n * organization\n * product\n * restaurant\n```" officeName: minLength: 0 type: string description: "The name of the office where the healthcare professional works, if different from **`name`**\n\nFiltering Type: `text`\n\n```\nEligible For: \n * healthcareProfessional\n```" 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.\n\nEach 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.\nSimilarly, holiday online service hours are represented by the `holidayHours` sub-field.\nSetting the `reopenDate` sub-field indicates that the business is temporarily closed and will reopen on the specified date.\nSPECIAL CASES:\n* 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.\n* 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.\n* If you are providing `openIntervals`, you may not set `isClosed` to true for that day.\n\nFiltering Type: `hours`\n\n```\nEligible For: \n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * location\n * restaurant\n```" openDate: format: date type: string description: "The date that the entity is set to open for the first time.\nMust be formatted in YYYY-MM-DD format.\n\nDate must be on or after 1970-01-01 Date must be before or on 2038-01-01\n\n\nFiltering Type: `date`\n\n```\nEligible For: \n * atm\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * restaurant\n```" 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\n\nFiltering Type: `list of option`\n\n```\nEligible For: \n * organization\n```" 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\n\nFiltering Type: `object`\n\n```\nEligible For: \n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * restaurant\n```" organizerEmail: minLength: 0 format: email type: string description: "Point of contact for the event organizer (not to be published publicly)\n\nFiltering Type: `text`\n\n```\nEligible For: \n * event\n```" organizerName: minLength: 0 type: string description: "Point of contact for the event organizer (not to be published publicly)\n\nFiltering Type: `text`\n\n```\nEligible For: \n * event\n```" organizerPhone: minLength: 0 type: string description: "Point of contact for the event organizer (not to be published publicly)\n\nFiltering Type: `text`\n\n```\nEligible For: \n * event\n```" outdoorPoolCount: multipleOf: 1 minimum: 0 type: number description: "The number of outdoor pools the entity has.\n\nFiltering Type: `integer`\n\n```\nEligible For: \n * hotel\n```" parking: enum: - PARKING_AVAILABLE - PARKING_AVAILABLE_FOR_FREE - NOT_APPLICABLE type: string description: "Indicates whether the entity offers parking services.\n\nFiltering Type: `option`\n\n```\nEligible For: \n * hotel\n```" 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\n\nValid elements depend on the entity's country.\n\n\nFiltering Type: `list of option`\n\n```\nEligible For: \n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * restaurant\n```" performers: description: "Performers at the event\n\n\nArray must be ordered.\n\nArray may have a maximum of 100 elements.\n\n\nFiltering Type: `list of text`\n\n```\nEligible For: \n * event\n```" 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.\n\nFiltering Type: `option`\n\n```\nEligible For: \n * hotel\n```" photoGallery: description: "\n**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.\n\n\n\nArray must be ordered.\n\nArray may have a maximum of 500 elements.\n\nArray item description:\n\n>Supported Aspect Ratios:\n>* 1 x 1\n>* 4 x 3\n>* 3 x 2\n>* 5 x 3\n>* 16 x 9\n>* 3 x 1\n>* 2 x 3\n>* 5 x 7\n>* 4 x 5\n>* 4 x 1\n>\n>**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.\n>\n\nFiltering Type: `list of object`\n\n```\nEligible For: \n * atm\n * event\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * hotelRoomType\n * location\n * organization\n * product\n * restaurant\n```" 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\n\nFiltering Type: `object`\n\n```\nEligible For: \n * atm\n * event\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * restaurant\n```" 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.\n\nEach 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.\nSimilarly, holiday pickup hours are represented by the `holidayHours` sub-field.\nSetting the `reopenDate` sub-field indicates that the business is temporarily closed and will reopen on the specified date.\nSPECIAL CASES:\n* 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.\n* 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.\n* If you are providing `openIntervals`, you may not set `isClosed` to true for that day.\n\nFiltering Type: `hours`\n\n```\nEligible For: \n * healthcareFacility\n * location\n * restaurant\n```" pinterestUrl: minLength: 0 format: uri type: string description: "URL for your Pinterest account, format should be https://www.pinterest.com/yourUsername\n\nFiltering Type: `text`\n\n```\nEligible For: \n * contactCard\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * organization\n * restaurant\n```" 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)\n\nFiltering Type: `option`\n\n```\nEligible For: \n * atm\n * healthcareFacility\n * healthcareProfessional\n * location\n * restaurant\n```" primaryConversationContact: minLength: 0 type: string description: "ID of the user who is the primary Knowledge Assistant contact for the entity\n\nFiltering Type: `option`\n\n```\nEligible For: \n * atm\n * faq\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * helpArticle\n * hotel\n * job\n * location\n * organization\n * product\n * restaurant\n```" privateBeach: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: "Indicates whether the entity has access to a private beach.\n\nFiltering Type: `option`\n\n```\nEligible For: \n * hotel\n```" privateCarService: enum: - PRIVATE_CAR_SERVICE - PRIVATE_CAR_SERVICE_FOR_FREE - NOT_APPLICABLE type: string description: "Indicates whether the entity offers private car services.\n\nFiltering Type: `option`\n\n```\nEligible For: \n * hotel\n```" 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\n\nFiltering Type: `object`\n\n```\nEligible For: \n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * restaurant\n```" products: description: "Products sold by this entity\n\nAll strings must be non-empty when trimmed of whitespace.\n\n\n\nArray must be ordered.\n\nArray may have a maximum of 100 elements.\n\nArray item description:\n\n>Cannot Include:\n>* HTML markup\n\nFiltering Type: `list of text`\n\n```\nEligible For: \n * financialProfessional\n * location\n```" 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\n\nFiltering Type: `boolean`\n\n```\nEligible For: \n * atm\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * organization\n * restaurant\n```" rankTrackingCompetitors: description: "Information about the competitors whose search performance you would like to compare to your own\n\n\nArray must be ordered.\n\nArray may have a maximum of 5 elements.\n\n\nFiltering Type: `list of object`\n\n```\nEligible For: \n * atm\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * organization\n * restaurant\n```" 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\n\nFiltering Type: `boolean`\n\n```\nEligible For: \n * atm\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * organization\n * restaurant\n```" rankTrackingFrequency: enum: - WEEKLY - MONTHLY - QUARTERLY type: string description: "How often we send search queries to track your search performance\n\nFiltering Type: `option`\n\n```\nEligible For: \n * atm\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * organization\n * restaurant\n```" rankTrackingQueryTemplates: description: "The ways in which your keywords will be arranged in the search queries we use to track your performance\n\n\nArray must have a minimum of 2 elements.\n\nArray may have a maximum of 4 elements.\n\n\nFiltering Type: `list of option`\n\n```\nEligible For: \n * atm\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * organization\n * restaurant\n```" 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\n\nFiltering Type: `list of option`\n\n```\nEligible For: \n * atm\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * organization\n * restaurant\n```" 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\n\nFiltering Type: `object`\n\n```\nEligible For: \n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * restaurant\n```" restaurantCount: multipleOf: 1 minimum: 0 type: number description: "The number of restaurants the entity has.\n\nFiltering Type: `integer`\n\n```\nEligible For: \n * hotel\n```" reviewGenerationUrl: minLength: 0 type: string description: "The URL given Review Invitation emails where consumers can leave a review about the entity\n\n```\nEligible For: \n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * restaurant\n```" reviewResponseConversationEnabled: type: boolean description: "Indicates whether Yext Knowledge Assistant review-response conversations are enabled for this entity\n\nFiltering Type: `boolean`\n\n```\nEligible For: \n * atm\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * restaurant\n```" roomCount: multipleOf: 1 minimum: 0 type: number description: "The number of rooms the entity has.\n\nFiltering Type: `integer`\n\n```\nEligible For: \n * hotel\n```" roomService: enum: - ROOM_SERVICE_AVAILABLE - ROOM_SERVICE_AVAILABLE_24_HOURS - NOT_APPLICABLE type: string description: "Indicates whether the entity offers room service.\n\nFiltering Type: `option`\n\n```\nEligible For: \n * hotel\n```" 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\n\nFiltering Type: `object`\n\n```\nEligible For: \n * atm\n * event\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * restaurant\n```" salon: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: "Indicates whether the entity has a salon.\n\nFiltering Type: `option`\n\n```\nEligible For: \n * hotel\n```" sauna: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: "Indicates whether the entity has a sauna.\n\nFiltering Type: `option`\n\n```\nEligible For: \n * hotel\n```" scuba: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: "Indicates whether the entity offers scuba diving.\n\nFiltering Type: `option`\n\n```\nEligible For: \n * hotel\n```" selfParking: enum: - SELF_PARKING_AVAILABLE - SELF_PARKING_AVAILABLE_FOR_FREE - NOT_APPLICABLE type: string description: "Indicates whether the entity offers self parking services.\n\nFiltering Type: `option`\n\n```\nEligible For: \n * hotel\n```" 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.\n\nEach 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.\nSimilarly, holiday senior hours are represented by the `holidayHours` sub-field.\nSetting the `reopenDate` sub-field indicates that the business is temporarily closed and will reopen on the specified date.\nSPECIAL CASES:\n* 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.\n* 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.\n* If you are providing `openIntervals`, you may not set `isClosed` to true for that day.\n\nFiltering Type: `hours`\n\n```\nEligible For: \n * location\n * restaurant\n```" serviceArea: additionalProperties: false type: object properties: places: description: "A list of places served by the entity, where each place is either:\n - a postal code, or\n - the name of a city.\n\n\n\nArray must be ordered.\n\nArray may have a maximum of 200 elements.\n\n\nFiltering 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.\n\n**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.\n\nFiltering Type: `object`\n\n```\nEligible For: \n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * restaurant\n```" 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.\n**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.\n\n\nArray may have a maximum of 200 elements.\n\n\nFiltering Type: `list of object`\n\n```\nEligible For: \n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * restaurant\n```" 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\n\nAll strings must be non-empty when trimmed of whitespace.\n\n\n\nArray must be ordered.\n\nArray may have a maximum of 100 elements.\n\nArray item description:\n\n>Cannot Include:\n>* HTML markup\n\nFiltering Type: `list of text`\n\n```\nEligible For: \n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * restaurant\n```" 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.\n\nFiltering Type: `option`\n\n```\nEligible For: \n * hotel\n```" snorkeling: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: "Indicates whether the entity offers snorkeling.\n\nFiltering Type: `option`\n\n```\nEligible For: \n * hotel\n```" socialHour: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: "Indicates whether the entity offers a social hour.\n\nFiltering Type: `option`\n\n```\nEligible For: \n * hotel\n```" spa: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: "Indicates whether the entity has a spa.\n\nFiltering Type: `option`\n\n```\nEligible For: \n * hotel\n```" specialities: description: "Up to 100 of this entity's specialities (e.g., for food and dining: `Chicago style`)\n\nAll strings must be non-empty when trimmed of whitespace.\n\n\n\nArray must be ordered.\n\nArray may have a maximum of 100 elements.\n\nArray item description:\n\n>Cannot Include:\n>* HTML markup\n\nFiltering Type: `list of text`\n\n```\nEligible For: \n * financialProfessional\n * location\n * restaurant\n```" 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.\n\nFiltering Type: `option`\n\n```\nEligible For: \n * hotel\n```" 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.\n\nEach 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.\nSimilarly, holiday takeout hours are represented by the `holidayHours` sub-field.\nSetting the `reopenDate` sub-field indicates that the business is temporarily closed and will reopen on the specified date.\nSPECIAL CASES:\n* 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.\n* 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.\n* If you are providing `openIntervals`, you may not set `isClosed` to true for that day.\n\nFiltering Type: `hours`\n\n```\nEligible For: \n * location\n * restaurant\n```" tennis: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: "Indicates whether the entity has tennis courts.\n\nFiltering Type: `option`\n\n```\nEligible For: \n * hotel\n```" thermalPool: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: "Indicates whether the entity has a thermal pool.\n\nFiltering Type: `option`\n\n```\nEligible For: \n * hotel\n```" ticketAvailability: enum: - IN_STOCK - SOLD_OUT - PRE_ORDER - UNSPECIFIED type: string description: "Information about the availability of tickets for the event\n\nFiltering Type: `option`\n\n```\nEligible For: \n * event\n```" 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\n\nFiltering Type: `object`\n\n```\nEligible For: \n * event\n```" ticketSaleDateTime: format: date-time type: string description: "The date/time tickets are available for sale (local time)\n\nFiltering Type: `datetime`\n\n```\nEligible For: \n * event\n```" ticketUrl: minLength: 0 format: uri type: string description: "URL to purchase tickets for the event (if ticketed)\n\nFiltering Type: `text`\n\n```\nEligible For: \n * event\n```" tikTokUrl: minLength: 0 format: uri type: string description: "URL for your TikTok profile, format should be https://www.tiktok.com/yourUsername\n\nFiltering Type: `text`\n\n```\nEligible For: \n * contactCard\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * organization\n * restaurant\n```" 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\n\nFiltering Type: `object`\n\n```\nEligible For: \n * event\n```" timeZoneUtcOffset: minLength: 0 type: string description: "Represents the time zone offset of the entity from UTC, in `±hh:mm` format.\n\nFor example, if the entity is 4 hours ahead of UTC time, the offset will be `+04:00`.\n\nIf the entity is 15.5 hours behind UTC time, the offset will be `-15:30`.\n\nIf the entity is in UTC time, the offset will be `+00:00`.\n\n\n```\nEligible For: \n * atm\n * event\n * faq\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * job\n * location\n * restaurant\n```" 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\"`\n\nFiltering Type: `option`\n\n```\nEligible For: \n * atm\n * board\n * card\n * contactCard\n * event\n * faq\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * helpArticle\n * hotel\n * hotelRoomType\n * job\n * location\n * organization\n * product\n * restaurant\n```" tollFreePhone: minLength: 0 type: string description: "Must be a valid phone number.\n\nIf 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.\n\nFiltering Type: `text`\n\n```\nEligible For: \n * atm\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * restaurant\n```" treadmill: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: "Indicates whether the entity has a treadmill.\n\nFiltering Type: `option`\n\n```\nEligible For: \n * hotel\n```" ttyPhone: minLength: 0 type: string description: "Must be a valid phone number.\n\nIf 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.\n\nFiltering Type: `text`\n\n```\nEligible For: \n * atm\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * restaurant\n```" turndownService: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: "Indicates whether the entity offers turndown service.\n\nFiltering Type: `option`\n\n```\nEligible For: \n * hotel\n```" twitterHandle: minLength: 0 maxLength: 15 type: string description: "Valid Twitter handle for the entity without the leading \"@\" (e.g., `JohnSmith`)\n\nIf 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.\n\nFiltering Type: `text`\n\n```\nEligible For: \n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * organization\n * restaurant\n```" 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\n\nFiltering Type: `object`\n\n```\nEligible For: \n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * restaurant\n```" 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\n\nFiltering Type: `object`\n\n```\nEligible For: \n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * restaurant\n```" valetParking: enum: - VALET_PARKING_AVAILABLE - VALET_PARKING_AVAILABLE_FOR_FREE - NOT_APPLICABLE type: string description: "Indicates whether the entity offers valet parking services.\n\nFiltering Type: `option`\n\n```\nEligible For: \n * hotel\n```" validThrough: format: date-time type: string description: "The date this entity is valid through.\n\nFiltering Type: `datetime`\n\n```\nEligible For: \n * job\n```" vendingMachine: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: "Indicates whether the entity has a vending machine.\n\nFiltering Type: `option`\n\n```\nEligible For: \n * hotel\n```" venueName: minLength: 0 type: string description: "Name of the venue where the event is being held\n\nFiltering Type: `text`\n\n```\nEligible For: \n * event\n```" videos: description: "Valid YouTube URLs for embedding a video on some publisher sites\n\n**NOTE:** Currently, only the first URL in the Array appears in your listings.\n\n\n\nArray must be ordered.\n\n\nFiltering Type: `list of object`\n\n```\nEligible For: \n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * hotelRoomType\n * location\n * organization\n * product\n * restaurant\n```" 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.\n\nFiltering Type: `option`\n\n```\nEligible For: \n * hotel\n```" wakeUpCalls: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: "Indicates whether the entity offers wake up call services.\n\nFiltering Type: `option`\n\n```\nEligible For: \n * hotel\n```" 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\n\nFiltering Type: `object`\n\n```\nEligible For: \n * atm\n * event\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * restaurant\n```" waterPark: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: "Indicates whether the entity has a water park.\n\nFiltering Type: `option`\n\n```\nEligible For: \n * hotel\n```" waterSkiing: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: "Indicates whether the entity offers water skiing.\n\nFiltering Type: `option`\n\n```\nEligible For: \n * hotel\n```" watercraft: enum: - WATERCRAFT_RENTALS - WATERCRAFT_RENTALS_FOR_FREE - NOT_APPLICABLE type: string description: "Indicates whether the entity offers any kind of watercrafts.\n\nFiltering Type: `option`\n\n```\nEligible For: \n * hotel\n```" waterslide: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: "Indicates whether the entity has a water slide.\n\nFiltering Type: `option`\n\n```\nEligible For: \n * hotel\n```" wavePool: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: "Indicates whether the entity has a wave pool.\n\nFiltering Type: `option`\n\n```\nEligible For: \n * hotel\n```" 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\n\nFiltering Type: `object`\n\n```\nEligible For: \n * atm\n * contactCard\n * event\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * organization\n * restaurant\n```" weightMachine: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: "Indicates whether the entity has a weight machine.\n\nFiltering Type: `option`\n\n```\nEligible For: \n * hotel\n```" wheelchairAccessible: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: "Indicates if the entity is wheelchair accessible.\n\nFiltering Type: `option`\n\n```\nEligible For: \n * hotel\n```" wifiAvailable: enum: - WIFI_AVAILABLE - WIFI_AVAILABLE_FOR_FREE - NOT_APPLICABLE type: string description: "Indicates whether the entity has WiFi available\n\nFiltering Type: `option`\n\n```\nEligible For: \n * hotel\n```" workRemote: type: boolean description: "Indicates whether the job is remote.\n\nFiltering Type: `boolean`\n\n```\nEligible For: \n * job\n```" yearEstablished: multipleOf: 1 minimum: 1000 maximum: 2028 type: number description: "The year the entity was established.\n\nFiltering Type: `integer`\n\n```\nEligible For: \n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * restaurant\n```" yearLastRenovated: multipleOf: 1 minimum: 1000 maximum: 2028 type: number description: "The most recent year the entity was partially or completely renovated.\n\nFiltering Type: `integer`\n\n```\nEligible For: \n * hotel\n```" 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\n\nFiltering Type: `object`\n\n```\nEligible For: \n * atm\n * event\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * job\n * location\n * restaurant\n```" 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\n\nFiltering Type: `object`\n\n```\nEligible For: \n * atm\n * event\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * restaurant\n```" 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\n\nFiltering Type: `object`\n\n```\nEligible For: \n * atm\n * event\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * restaurant\n```" 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\n\nFiltering Type: `object`\n\n```\nEligible For: \n * atm\n * event\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * restaurant\n```" 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\n\nFiltering Type: `object`\n\n```\nEligible For: \n * atm\n * event\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * restaurant\n```" youTubeChannelUrl: minLength: 0 format: uri type: string description: "URL for your YouTube channel, format should be https://www.youtube.com/c/yourUsername\n\nFiltering Type: `text`\n\n```\nEligible For: \n * contactCard\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * organization\n * restaurant\n```" 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: {} put: operationId: upsertLanguageProfile requestBody: description: The entity profile to create required: true content: application/json: schema: $ref: '#/components/schemas/EntityWrite' 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 profile that the user wishes to create or update 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: 'The ID of the operation. Leave this blank to create a new operation or supply an ID to continue an existing operation ' name: Update-Operation-Id in: header required: false tags: - Knowledge Manager summary: 'Entity Language Profiles: Upsert' description: 'Add a language profile **NOTE** * If the **`v`** parameter is `20240221` or later: returned Language Profile replaces the **`categoryIds`** field with the **`categories`** field. ' 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.\n\n```\nEligible For: \n * atm\n * event\n * faq\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * job\n * location\n * restaurant\n```" name: minLength: 0 maxLength: 5000 type: string description: "\n\n\nCannot Include:\n* HTML markup\n\nFiltering Type: `text`\n\n```\nEligible For: \n * atm\n * board\n * brand\n * card\n * contactCard\n * event\n * faq\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * helpArticle\n * hotel\n * hotelRoomType\n * job\n * location\n * organization\n * product\n * restaurant\n```" 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)\n\nMust be a valid address\nCannot be a P.O. Box\n\nIf the entity is an `event`, either an **`address`** value or a **`linkedLocation`** value can be provided.\n\nFiltering Type: `object`\n\n```\nEligible For: \n * atm\n * event\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * restaurant\n```" acceptingNewPatients: type: boolean description: "Indicates whether the healthcare provider is accepting new patients.\n\nFiltering Type: `boolean`\n\n```\nEligible For: \n * healthcareFacility\n * healthcareProfessional\n```" acceptsReservations: type: boolean description: "Indicates whether the entity accepts reservations.\n\nFiltering Type: `boolean`\n\n```\nEligible For: \n * restaurant\n```" 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.\n\nEach 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.\nSimilarly, holiday access hours are represented by the `holidayHours` sub-field.\nSetting the `reopenDate` sub-field indicates that the business is temporarily closed and will reopen on the specified date.\nSPECIAL CASES:\n* 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.\n* 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.\n* If you are providing `openIntervals`, you may not set `isClosed` to true for that day.\n\nFiltering Type: `hours`\n\n```\nEligible For: \n * atm\n * healthcareFacility\n * hotel\n * location\n * restaurant\n```" additionalHoursText: minLength: 0 maxLength: 255 type: string description: "Additional information about hours that does not fit in **`hours`** (e.g., `\"Closed during the winter\"`)\n\nFiltering Type: `text`\n\n```\nEligible For: \n * atm\n * contactCard\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * restaurant\n```" additionalPromotingLocations: description: "If other locations are promoting this event, a list of those locations' **`id`**s in the Yext Knowledge Manager\n\n\nArray must be ordered.\n\n\nFiltering Type: `list of entityId`\n\n```\nEligible For: \n * event\n```" 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`.\n\nFiltering Type: `boolean`\n\n```\nEligible For: \n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * restaurant\n```" admittingHospitals: description: "A list of hospitals where the healthcare professional admits patients\n\n\nArray must be ordered.\n\nArray may have a maximum of 100 elements.\n\nArray item description:\n\n>Cannot Include:\n>* HTML markup\n\nFiltering Type: `list of text`\n\n```\nEligible For: \n * healthcareProfessional\n```" 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.\n\nFiltering Type: `option`\n\n```\nEligible For: \n * hotel\n```" 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\n\nFiltering Type: `object`\n\n```\nEligible For: \n * event\n```" 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.\n\nFiltering Type: `option`\n\n```\nEligible For: \n * hotel\n```" 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.\n\nFiltering Type: `option`\n\n```\nEligible For: \n * hotel\n```" allInclusive: enum: - ALL_INCLUSIVE_RATES_AVAILABLE - ALL_INCLUSIVE_RATES_ONLY - NOT_APPLICABLE type: string description: "Indicates whether the entity offers all-inclusive rates.\n\nFiltering Type: `option`\n\n```\nEligible For: \n * hotel\n```" alternateNames: description: "Other names for your business that you would like us to use when tracking your search performance\n\n\nArray must be ordered.\n\nArray may have a maximum of 3 elements.\n\nArray item description:\n\n>Cannot Include:\n>* HTML markup\n\nFiltering Type: `list of text`\n\n```\nEligible For: \n * atm\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * organization\n * restaurant\n```" 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.\n\nIf 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.\n\nFiltering Type: `text`\n\n```\nEligible For: \n * atm\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * restaurant\n```" alternateWebsites: description: "Other websites for your business that we should search for when tracking your search performance\n\n\nArray must be ordered.\n\nArray may have a maximum of 3 elements.\n\nArray item description:\n\n>Cannot Include:\n>* common domain names, e.g., google.com, youtube.com, etc.\n\nFiltering Type: `list of text`\n\n```\nEligible For: \n * atm\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * organization\n * restaurant\n```" 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\n\nFiltering Type: `text`\n\n```\nEligible For: \n * brand\n * financialProfessional\n * hotel\n * location\n * restaurant\n```" answer: description: "The answer to the frequently asked question represented by this entity\n\n\nCharacter limit: 0 .. 15000\n\nSupported formats include:\n* BOLD\n* ITALICS\n* UNDERLINE\n* BULLETED_LIST\n* NUMBERED_LIST\n* HYPERLINK\n* IMAGE\n* CODE_SPAN\n* HEADINGS\n\n```\nEligible For: \n * faq\n```" type: string format: rich-text appleActionLinks: description: "Use this field to add action links to your Apple Listings.\n\nThe call to action category will be displayed on the action link button.\n\nThe App Store URL should contain a valid link to the landing page of an App in the Apple App Store.\n\nThe Quick Link URL is where a user is taken when an action link is clicked by a user.\n\nThe 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.\n\n\nArray must be ordered.\n\n\nFiltering Type: `list of object`\n\n```\nEligible For: \n * atm\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * restaurant\n```" 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\n\nFiltering Type: `text`\n\n```\nEligible For: \n * atm\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * restaurant\n```" appleBusinessId: minLength: 0 pattern: ^\d*\.?\d*$ type: string description: "The ID associated with an individual Business Folder in your Apple account\n\nFiltering Type: `text`\n\n```\nEligible For: \n * atm\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * restaurant\n```" appleCompanyId: minLength: 0 pattern: ^\d*\.?\d*$ type: string description: "The ID associated with your Apple account. Numerical values only\n\nFiltering Type: `text`\n\n```\nEligible For: \n * atm\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * restaurant\n```" appleCoverPhoto: required: - url additionalProperties: false type: object description: "The cover photo for the entity''s Apple profile\n\n\nImage must be at least 1600 x 1040 pixels\n\nImage may be no more than 4864 x 3163 pixels\n\nSupported Aspect Ratios:\n* 154 x 100\n\n**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.\n\n\nFiltering Type: `object`\n\n```\nEligible For: \n * atm\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * restaurant\n```" 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.\nNOTE: The names of Brands and their respective Locations within an Apple Business Connect Account must match identically.\nCannot Include:\nHTML markup \n\n\nCannot Include:\n* HTML markup\n\nFiltering Type: `text`\n\n```\nEligible For: \n * atm\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * restaurant\n```" applicationUrl: minLength: 0 format: uri type: string description: "The application URL\n\nFiltering Type: `text`\n\n```\nEligible For: \n * job\n```" associations: description: "Association memberships relevant to the entity (e.g., `\"New York Doctors Association\"`)\nAll strings must be non-empty when trimmed of whitespace.\n\n\n\nArray must be ordered.\n\nArray may have a maximum of 100 elements.\n\nArray item description:\n\n>Cannot Include:\n>* HTML markup\n\nFiltering Type: `list of text`\n\n```\nEligible For: \n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * restaurant\n```" 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.\nA `virtualLocationUrl` must be specified for online and mixed events.\n\nFiltering Type: `object`\n\n```\nEligible For: \n * event\n```" attire: enum: - UNSPECIFIED - DRESSY - CASUAL - FORMAL type: string description: "The formality of clothing typically worn at this restaurant\n\nFiltering Type: `option`\n\n```\nEligible For: \n * restaurant\n```" babysittingOffered: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: "Indicates whether the entity offers babysitting.\n\nFiltering Type: `option`\n\n```\nEligible For: \n * hotel\n```" baggageStorage: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: "Indicates whether the entity offers baggage storage pre check-in and post check-out.\n\nFiltering Type: `option`\n\n```\nEligible For: \n * hotel\n```" bar: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: "Indicates whether the entity has an indoor or outdoor bar onsite.\n\nFiltering Type: `option`\n\n```\nEligible For: \n * hotel\n```" beachAccess: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: "Indicates whether the entity has access to a beach.\n\nFiltering Type: `option`\n\n```\nEligible For: \n * hotel\n```" beachFrontProperty: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: "Indicates whether the entity is physically located next to a beach.\n\nFiltering Type: `option`\n\n```\nEligible For: \n * hotel\n```" bicycles: enum: - BICYCLE_RENTALS - BICYCLE_RENTALS_FOR_FREE - NOT_APPLICABLE type: string description: "Indicates whether the entity offers bicycles for rent or for free.\n\nFiltering Type: `option`\n\n```\nEligible For: \n * hotel\n```" 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\n\nFiltering Type: `object`\n\n```\nEligible For: \n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * organization\n * restaurant\n```" 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.\n\nFiltering Type: `option`\n\n```\nEligible For: \n * hotel\n```" brands: description: "Brands sold by this entity\nAll strings must be non-empty when trimmed of whitespace.\n\n\n\nArray must be ordered.\n\nArray may have a maximum of 100 elements.\n\nArray item description:\n\n>Cannot Include:\n>* HTML markup\n\nFiltering Type: `list of text`\n\n```\nEligible For: \n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * restaurant\n```" 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.\n\nFiltering Type: `option`\n\n```\nEligible For: \n * hotel\n```" 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.\n\nEach 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.\nSimilarly, holiday brunch hours are represented by the `holidayHours` sub-field.\nSetting the `reopenDate` sub-field indicates that the business is temporarily closed and will reopen on the specified date.\nSPECIAL CASES:\n* 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.\n* 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.\n* If you are providing `openIntervals`, you may not set `isClosed` to true for that day.\n\nFiltering Type: `hours`\n\n```\nEligible For: \n * hotel\n * location\n * restaurant\n```" businessCenter: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: "Indicates whether the entity has a business center.\n\nFiltering Type: `option`\n\n```\nEligible For: \n * hotel\n```" 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\n\nFiltering Type: `object`\n\n```\nEligible For: \n * financialProfessional\n * healthcareFacility\n * hotel\n * location\n * restaurant\n```" carRental: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: "Indicates whether the entity offers car rental.\n\nFiltering Type: `option`\n\n```\nEligible For: \n * hotel\n```" casino: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: "Indicates whether the entity has a casino on premise or nearby.\n\nFiltering Type: `option`\n\n```\nEligible For: \n * hotel\n```" categories: additionalProperties: false type: object properties: {} description: "Yext Categories. (Supported for versions > 20240220)\n\nA map of category list external IDs (i.e. \"yext\") to a list of category IDs.\n\nIDs must be valid and selectable (i.e., cannot be parent categories).\n\nPartial updates are accepted, meaning sending only the \"yext\" property will have no effect on any category list except the \"yext\" category. \n\nFiltering Type: `object`\n\n```\nEligible For: \n * atm\n * event\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * restaurant\n```" categoryIds: uniqueItems: false type: array items: minLength: 0 type: string description: 'Filtering Type: `text`' description: "Yext Category IDs. (Deprecated: For versions > 20240220)\n\nIDs must be valid and selectable (i.e., cannot be parent categories).\n\nNOTE: 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.\n\n\nFiltering Type: `list of text`\n\n```\nEligible For: \n * atm\n * event\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * restaurant\n```" catsAllowed: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: "Indicates if the entity is cat friendly.\n\nFiltering Type: `option`\n\n```\nEligible For: \n * hotel\n```" certifications: description: "A list of the certifications held by the healthcare professional\n**NOTE:** This field is only available to locations whose **`entityType`** is `healthcareProfessional`.\n\n\n\nArray must be ordered.\n\nArray may have a maximum of 100 elements.\n\nArray item description:\n\n>Cannot Include:\n>* HTML markup\n\nFiltering Type: `list of text`\n\n```\nEligible For: \n * financialProfessional\n * healthcareProfessional\n```" 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\n\nFiltering Type: `time`\n\n```\nEligible For: \n * hotel\n```" checkOutTime: format: time type: string description: "The check-out time\n\nFiltering Type: `time`\n\n```\nEligible For: \n * hotel\n```" classificationRating: pattern: ^\d*\.?\d*$ type: string description: "The 1 to 5 star rating of the entitiy based on its services and facilities.\n\nFiltering Type: `decimal`\n\n```\nEligible For: \n * hotel\n```" closed: type: boolean description: "Indicates whether the entity is closed\n\nFiltering Type: `boolean`\n\n```\nEligible For: \n * atm\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * restaurant\n```" concierge: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: "Indicates whether the entity offers concierge service.\n\nFiltering Type: `option`\n\n```\nEligible For: \n * hotel\n```" conditionsTreated: description: "A list of the conditions treated by the healthcare provider\n\n\nArray must be ordered.\n\nArray may have a maximum of 100 elements.\n\nArray item description:\n\n>Cannot Include:\n>* HTML markup\n\nFiltering Type: `list of text`\n\n```\nEligible For: \n * healthcareFacility\n * healthcareProfessional\n```" 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.\n\nFiltering Type: `option`\n\n```\nEligible For: \n * hotel\n```" covidMessaging: minLength: 0 maxLength: 15000 type: string description: "Information or messaging related to COVID-19.\n\nFiltering Type: `text`\n\n```\nEligible For: \n * healthcareFacility\n * healthcareProfessional\n * location\n```" covidTestAppointmentUrl: minLength: 0 format: uri type: string description: "An appointment URL for scheduling a COVID-19 test.\n\nFiltering Type: `text`\n\n```\nEligible For: \n * healthcareFacility\n * location\n```" covidTestingAppointmentRequired: type: boolean description: "Indicates whether an appointment is required for a COVID-19 test.\n\nFiltering Type: `boolean`\n\n```\nEligible For: \n * healthcareFacility\n * location\n```" covidTestingDriveThroughSite: type: boolean description: "Indicates whether location is a drive-through site for COVID-19 tests.\n\nFiltering Type: `boolean`\n\n```\nEligible For: \n * healthcareFacility\n * location\n```" covidTestingIsFree: type: boolean description: "Indicates whether location offers free COVID-19 testing.\n\nFiltering Type: `boolean`\n\n```\nEligible For: \n * healthcareFacility\n * location\n```" covidTestingPatientRestrictions: type: boolean description: "Indicates whether there are patient restrictions for COVID-19 testing.\n\nFiltering Type: `boolean`\n\n```\nEligible For: \n * healthcareFacility\n * location\n```" covidTestingReferralRequired: type: boolean description: "Indicates whether a referral is required for COVID-19 testing.\n\nFiltering Type: `boolean`\n\n```\nEligible For: \n * healthcareFacility\n * location\n```" covidTestingSiteInstructions: minLength: 0 maxLength: 15000 type: string description: "Information or instructions for the COVID-19 testing site.\n\nFiltering Type: `text`\n\n```\nEligible For: \n * healthcareFacility\n * location\n```" covidVaccineAppointmentRequired: type: boolean description: "Indicates whether an appointment is required for a COVID-19 vaccine.\n\nFiltering Type: `boolean`\n\n```\nEligible For: \n * healthcareFacility\n * location\n```" covidVaccineDriveThroughSite: type: boolean description: "Indicates whether location is a drive-through site for COVID-19 vaccines.\n\nFiltering Type: `boolean`\n\n```\nEligible For: \n * healthcareFacility\n * location\n```" covidVaccineInformationUrl: minLength: 0 format: uri type: string description: "An information URL for more information about COVID-19 vaccines.\n\nFiltering Type: `text`\n\n```\nEligible For: \n * healthcareFacility\n * location\n```" covidVaccinePatientRestrictions: type: boolean description: "Indicates whether there are patient restrictions for a COVID-19 vaccine.\n\nFiltering Type: `boolean`\n\n```\nEligible For: \n * healthcareFacility\n * location\n```" covidVaccineReferralRequired: type: boolean description: "Indicates whether a referral is required for a COVID-19 vaccine.\n\nFiltering Type: `boolean`\n\n```\nEligible For: \n * healthcareFacility\n * location\n```" covidVaccineSiteInstructions: minLength: 0 maxLength: 15000 type: string description: "Information or instructions for the COVID-19 vaccination site.\n\nFiltering Type: `text`\n\n```\nEligible For: \n * healthcareFacility\n * location\n```" 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.\n\nFiltering Type: `list of option`\n\n```\nEligible For: \n * healthcareFacility\n * location\n```" currencyExchange: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: "Indicates whether the entity offers currency exchange services.\n\nFiltering Type: `option`\n\n```\nEligible For: \n * hotel\n```" customKeywords: description: "Additional keywords you would like us to use when tracking your search performance\n\n\nArray must be ordered.\n\nArray may have a maximum of 5 elements.\n\n\nFiltering Type: `list of text`\n\n```\nEligible For: \n * atm\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * organization\n * restaurant\n```" 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\n\nFiltering Type: `date`\n\n```\nEligible For: \n * job\n```" degrees: description: "A list of the degrees earned by the healthcare professional\n\n\nArray must be ordered.\n\n\nFiltering Type: `list of option`\n\n```\nEligible For: \n * healthcareProfessional\n```" 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.\n\nEach 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.\nSimilarly, holiday delivery hours are represented by the `holidayHours` sub-field.\nSetting the `reopenDate` sub-field indicates that the business is temporarily closed and will reopen on the specified date.\nSPECIAL CASES:\n* 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.\n* 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.\n* If you are providing `openIntervals`, you may not set `isClosed` to true for that day.\n\nFiltering Type: `hours`\n\n```\nEligible For: \n * location\n * restaurant\n```" description: minLength: 10 maxLength: 15000 type: string description: "A description of the entity\n\n\nCannot Include:\n* HTML markup\n\nFiltering Type: `text`\n\n```\nEligible For: \n * atm\n * contactCard\n * event\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * job\n * location\n * organization\n * restaurant\n```" 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\n\nFiltering Type: `object`\n\n```\nEligible For: \n * atm\n * event\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * job\n * location\n * restaurant\n```" doctorOnCall: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: "Indicates whether the entity has a doctor on premise or on call.\n\nFiltering Type: `option`\n\n```\nEligible For: \n * hotel\n```" dogsAllowed: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: "Indicates if the entity is dog friendly.\n\nFiltering Type: `option`\n\n```\nEligible For: \n * hotel\n```" 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.\n\nEach 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.\nSimilarly, holiday drive-through hours are represented by the `holidayHours` sub-field.\nSetting the `reopenDate` sub-field indicates that the business is temporarily closed and will reopen on the specified date.\nSPECIAL CASES:\n* 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.\n* 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.\n* If you are providing `openIntervals`, you may not set `isClosed` to true for that day.\n\nFiltering Type: `hours`\n\n```\nEligible For: \n * atm\n * location\n * restaurant\n```" 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\n\nFiltering Type: `object`\n\n```\nEligible For: \n * atm\n * event\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * restaurant\n```" educationList: description: "Information about the education or training completed by the healthcare professional\n\n\nArray must be ordered.\n\n\nFiltering Type: `list of object`\n\n```\nEligible For: \n * healthcareProfessional\n```" 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.\n\nFiltering Type: `option`\n\n```\nEligible For: \n * hotel\n```" elevator: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: "Indicates whether the entity has an elevator.\n\nFiltering Type: `option`\n\n```\nEligible For: \n * hotel\n```" ellipticalMachine: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: "Indicates whether the entity has an elliptical machine.\n\nFiltering Type: `option`\n\n```\nEligible For: \n * hotel\n```" emails: description: "Emails addresses for this entity's point of contact\n\nMust be valid email addresses\n\n\n\nArray must be ordered.\n\nArray may have a maximum of 5 elements.\n\n\nFiltering Type: `list of text`\n\n```\nEligible For: \n * contactCard\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * organization\n * restaurant\n```" 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.\n\nFiltering Type: `option`\n\n```\nEligible For: \n * job\n```" eventStatus: enum: - SCHEDULED - RESCHEDULED - POSTPONED - CANCELED - EVENT_MOVED_ONLINE type: string description: "Information on whether the event will take place as scheduled\n\nFiltering Type: `option`\n\n```\nEligible For: \n * event\n```" facebookAbout: minLength: 0 maxLength: 255 type: string description: "A description of the entity to be used in the \"About You\" section on Facebook\n\nFiltering Type: `text`\n\n```\nEligible For: \n * atm\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * restaurant\n```" 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\n\nValid contents of **`value`** depends on the Call-to-Action's **`type`**:\n* `NONE`: (optional)\n* `BOOK_NOW`: URL\n* `CALL_NOW`: Phone number\n* `CONTACT_US`: URL\n* `SEND_MESSAGE`: Any string\n* `USE_APP`: URL\n* `PLAY_GAME`: URL\n* `SHOP_NOW`: URL\n* `SIGN_UP`: URL\n* `WATCH_VIDEO`: URL\n* `SEND_EMAIL`: Email address\n* `LEARN_MORE`: URL\n* `PURCHASE_GIFT_CARDS`: URL\n* `ORDER_NOW`: URL\n* `FOLLOW_PAGE`: Any string\n\nFiltering Type: `object`\n\n```\nEligible For: \n * atm\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * restaurant\n```" facebookCoverPhoto: required: - url additionalProperties: false type: object description: "The cover photo for the entity's Facebook profile\n\nDisplayed as a 851 x 315 pixel image\n\nYou may need a cover photo in order for your listing to appear on Facebook. Please check your listings tab to learn more.\n\n\nImage must be at least 400 x 150 pixels\n\nImage area (width x height) may be no more than 41000000 pixels\n\nImage may be no more than 30000 x 30000 pixels\n\nSupported Aspect Ratios:\n* 1 x 1\n* 4 x 3\n* 3 x 2\n* 5 x 3\n* 16 x 9\n* 3 x 1\n* 2 x 3\n* 5 x 7\n* 4 x 5\n* 4 x 1\n\n**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.\n\n\nFiltering Type: `object`\n\n```\nEligible For: \n * atm\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * restaurant\n```" 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.\n\n\nCannot Include:\n* HTML markup\n\nFiltering Type: `text`\n\n```\nEligible For: \n * atm\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * restaurant\n```" 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.\n\nFiltering Type: `text`\n\n```\nEligible For: \n * atm\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * restaurant\n```" facebookOverrideCity: minLength: 0 type: string description: "The city to be displayed on this entity's Facebook profile\n\nFiltering Type: `text`\n\n```\nEligible For: \n * atm\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * restaurant\n```" facebookPageUrl: minLength: 0 type: string description: "URL for the entity's Facebook Page.\n\nValid formats:\n\n- facebook.com/profile.php?id=[numId]\n- facebook.com/group.php?gid=[numId]\n- facebook.com/groups/[numId]\n- facebook.com/[Name]\n- facebook.com/pages/[Name]/[numId]\n- facebook.com/people/[Name]/[numId]\n\nwhere [Name] is a String and [numId] is an Integer\nThe success response will contain a warning message explaining why the URL wasn't stored in the system.\n\nFiltering Type: `text`\n\n```\nEligible For: \n * atm\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * organization\n * restaurant\n```" 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\n\nFiltering Type: `text`\n\n```\nEligible For: \n * atm\n * brand\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * restaurant\n```" facebookProfilePhoto: required: - url additionalProperties: false type: object description: "The profile picture for the entity's Facebook profile\n\nYou must have a profile picture in order for your listing to appear on Facebook.\n\n\nImage must be at least 180 x 180 pixels\n\nImage area (width x height) may be no more than 41000000 pixels\n\nImage may be no more than 30000 x 30000 pixels\n\nSupported Aspect Ratios:\n* 1 x 1\n* 4 x 3\n* 3 x 2\n* 5 x 3\n* 16 x 9\n* 3 x 1\n* 2 x 3\n* 5 x 7\n* 4 x 5\n* 4 x 1\n\n**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.\n\n\nFiltering Type: `object`\n\n```\nEligible For: \n * atm\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * restaurant\n```" 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\n\nFiltering Type: `text`\n\n```\nEligible For: \n * atm\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * restaurant\n```" 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.\n\nFiltering Type: `text`\n\n```\nEligible For: \n * atm\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * restaurant\n```" 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).\n\nFiltering Type: `text`\n\n```\nEligible For: \n * atm\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * restaurant\n```" fax: minLength: 0 type: string description: "Must be a valid fax number.\n\nIf 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.\n\nFiltering Type: `text`\n\n```\nEligible For: \n * atm\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * restaurant\n```" 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\n\nFiltering Type: `object`\n\n```\nEligible For: \n * atm\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * restaurant\n```" firstName: minLength: 0 maxLength: 35 type: string description: "The first name of the healthcare professional\n\n\nCannot Include:\n* a URL or domain name\n* HTML markup\n\nFiltering Type: `text`\n\n```\nEligible For: \n * healthcareProfessional\n```" firstPartyReviewPage: minLength: 0 type: string description: "Link to the review-collection page, where consumers can leave first-party reviews\n\n```\nEligible For: \n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * restaurant\n```" fitnessCenter: enum: - FITNESS_CENTER_AVAILABLE - FITNESS_CENTER_AVAILABLE_FOR_FREE - NOT_APPLICABLE type: string description: "Indicates whether the entity has a fitness center.\n\nFiltering Type: `option`\n\n```\nEligible For: \n * hotel\n```" floorCount: multipleOf: 1 minimum: 0 type: number description: "The number of floors the entity has from ground floor to top floor.\n\nFiltering Type: `integer`\n\n```\nEligible For: \n * hotel\n```" freeWeights: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: "Indicates whether the entity has free weights.\n\nFiltering Type: `option`\n\n```\nEligible For: \n * hotel\n```" frequentlyAskedQuestions: description: "A list of questions that are frequently asked about this entity\n\n\nArray must be ordered.\n\nArray may have a maximum of 100 elements.\n\n\nFiltering Type: `list of object`\n\n```\nEligible For: \n * atm\n * event\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * restaurant\n```" 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.\n\nFiltering Type: `option`\n\n```\nEligible For: \n * hotel\n```" fullyVaccinatedStaff: type: boolean description: "Indicates whether the staff is vaccinated against COVID-19.\n\nFiltering Type: `boolean`\n\n```\nEligible For: \n * healthcareFacility\n * hotel\n * location\n * restaurant\n```" gameRoom: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: "Indicates whether the entity has a game room.\n\nFiltering Type: `option`\n\n```\nEligible For: \n * hotel\n```" gender: enum: - UNSPECIFIED - FEMALE - MALE - NONBINARY - TRANSGENDER_FEMALE - TRANSGENDER_MALE - OTHER - PREFER_NOT_TO_DISCLOSE type: string description: "The gender of the healthcare professional\n\nFiltering Type: `option`\n\n```\nEligible For: \n * healthcareProfessional\n```" geomodifier: minLength: 0 type: string description: "Provides additional information on where the entity can be found (e.g., `Times Square`, `Global Center Mall`)\n\nFiltering Type: `text`\n\n```\nEligible For: \n * atm\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * restaurant\n```" giftShop: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: "Indicates whether the entity has a gift shop.\n\nFiltering Type: `option`\n\n```\nEligible For: \n * hotel\n```" 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.\n\nFiltering Type: `option`\n\n```\nEligible For: \n * hotel\n```" 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.\n\nValid 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.\n\nKeyword 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`).\n\n* 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\" ] }]`)\n* 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\" ]}`)\n\n**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.\n\nFiltering Type: `object`\n\n```\nEligible For: \n * atm\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * restaurant\n```" googleCoverPhoto: required: - url additionalProperties: false type: object description: "The cover photo for the entity's Google profile\n\n\nImage must be at least 250 x 250 pixels\n\n\nFiltering Type: `object`\n\n```\nEligible For: \n * atm\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * restaurant\n```" 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.\nMust be a valid phone number.\nIf 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. \n\nFiltering 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.\n\nNOTE: 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.\n\nFiltering Type: `object`\n\n```\nEligible For: \n * atm\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * restaurant\n```" googleMyBusinessLabels: description: "Google Business Profile Labels help users organize their locations into groups within GBP.\n\n\nArray must be ordered.\n\nArray may have a maximum of 10 elements.\n\nArray item description:\n\n>Cannot Include:\n>* HTML markup\n\nFiltering Type: `list of text`\n\n```\nEligible For: \n * atm\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * restaurant\n```" 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.\n\nFiltering Type: `text`\n\n```\nEligible For: \n * atm\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * restaurant\n```" googleProfilePhoto: required: - url additionalProperties: false type: object description: "The profile photo for the entity's Google profile\n\n\nImage must be at least 250 x 250 pixels\n\nImage may be no more than 5000 x 5000 pixels\n\nSupported Aspect Ratios:\n* 1 x 1\n\n**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.\n\n\nFiltering Type: `object`\n\n```\nEligible For: \n * atm\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * restaurant\n```" 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).\n\nFor 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.\n\nFiltering Type: `text`\n\n```\nEligible For: \n * atm\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * restaurant\n```" 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.\n\nEach 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.\nSimilarly, holiday happy hours are represented by the `holidayHours` sub-field.\nSetting the `reopenDate` sub-field indicates that the business is temporarily closed and will reopen on the specified date.\nSPECIAL CASES:\n* 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.\n* 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.\n* If you are providing `openIntervals`, you may not set `isClosed` to true for that day.\n\nFiltering Type: `hours`\n\n```\nEligible For: \n * hotel\n * location\n * restaurant\n```" headshot: required: - url additionalProperties: false type: object description: "A portrait of the healthcare professional\n\nFiltering Type: `object`\n\n```\nEligible For: \n * contactCard\n * financialProfessional\n * healthcareProfessional\n```" 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\n\nFiltering Type: `text`\n\n```\nEligible For: \n * job\n```" holidayHoursConversationEnabled: type: boolean description: "Indicates whether holiday-hour confirmation alerts are enabled for the Yext Knowledge Assistant for this entity\n\nFiltering Type: `boolean`\n\n```\nEligible For: \n * atm\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * restaurant\n```" horsebackRiding: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: "Indicates whether the entity offers horseback riding.\n\nFiltering Type: `option`\n\n```\nEligible For: \n * hotel\n```" hotTub: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: "Indicates whether the entity has a hot tub.\n\nFiltering Type: `option`\n\n```\nEligible For: \n * hotel\n```" 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.\n\nEach 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.\nSimilarly, holiday hours are represented by the `holidayHours` sub-field.\nSetting the `reopenDate` sub-field indicates that the business is temporarily closed and will reopen on the specified date.\nSPECIAL CASES:\n* 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.\n* 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.\n* If you are providing `openIntervals`, you may not set `isClosed` to true for that day.\n\nFiltering Type: `hours`\n\n```\nEligible For: \n * atm\n * contactCard\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * restaurant\n```" housekeeping: enum: - HOUSEKEEPING_AVAILABLE - HOUSEKEEPING_AVAILABLE_DAILY - NOT_APPLICABLE type: string description: "Indicates whether the entity offers housekeeping services.\n\nFiltering Type: `option`\n\n```\nEligible For: \n * hotel\n```" 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.\n\nFiltering Type: `text`\n\n```\nEligible For: \n * atm\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * restaurant\n```" indoorPoolCount: multipleOf: 1 minimum: 0 type: number description: "A count of the number of indoor pools\n\nFiltering Type: `integer`\n\n```\nEligible For: \n * hotel\n```" instagramHandle: minLength: 0 maxLength: 30 type: string description: "Valid Instagram username for the entity without the leading \"@\" (e.g., `NewCityAuto`)\n\nFiltering Type: `text`\n\n```\nEligible For: \n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * organization\n * restaurant\n```" insuranceAccepted: description: "A list of insurance policies accepted by the healthcare provider\n\n\nArray must be ordered.\n\nArray may have a maximum of 100 elements.\n\nArray item description:\n\n>Cannot Include:\n>* HTML markup\n\nFiltering Type: `list of text`\n\n```\nEligible For: \n * healthcareFacility\n * healthcareProfessional\n```" 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\n\nFiltering Type: `text`\n\n```\nEligible For: \n * brand\n * financialProfessional\n * hotel\n * location\n * restaurant\n```" isClusterPrimary: type: boolean description: "Indicates whether the healthcare entity is the primary entity in its group\n\nFiltering Type: `boolean`\n\n```\nEligible For: \n * healthcareProfessional\n```" isFreeEvent: type: boolean description: "Indicates whether or not the event is free\n\nFiltering Type: `boolean`\n\n```\nEligible For: \n * event\n```" isoRegionCode: minLength: 0 type: string description: "The ISO 3166-2 region code for the entity\n\nYext 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.\n\nFiltering Type: `text`\n\n```\nEligible For: \n * atm\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * restaurant\n```" keywords: description: "Keywords that describe the entity.\n\nAll strings must be non-empty when trimmed of whitespace.\n\n\n\nArray must be ordered.\n\nArray may have a maximum of 100 elements.\n\nArray item description:\n\n>Cannot Include:\n>* HTML markup\n\nFiltering Type: `list of text`\n\n```\nEligible For: \n * atm\n * card\n * event\n * faq\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * helpArticle\n * hotel\n * job\n * location\n * product\n * restaurant\n```" 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.\n\nFiltering Type: `option`\n\n```\nEligible For: \n * hotel\n```" kidsClub: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: "Indicates if the property has a Kids Club.\n\nFiltering Type: `option`\n\n```\nEligible For: \n * hotel\n```" kidsStayFree: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: "Indicates whether the entity allows kids to stay free.\n\nFiltering Type: `option`\n\n```\nEligible For: \n * hotel\n```" 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.\n\nEach 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.\nSimilarly, holiday kitchen hours are represented by the `holidayHours` sub-field.\nSetting the `reopenDate` sub-field indicates that the business is temporarily closed and will reopen on the specified date.\nSPECIAL CASES:\n* 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.\n* 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.\n* If you are providing `openIntervals`, you may not set `isClosed` to true for that day.\n\nFiltering Type: `hours`\n\n```\nEligible For: \n * hotel\n * location\n * restaurant\n```" 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.\n\n**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.\n\nFiltering Type: `opaque`\n\n```\nEligible For: \n * atm\n * board\n * brand\n * card\n * contactCard\n * event\n * faq\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * helpArticle\n * hotel\n * hotelRoomType\n * job\n * location\n * organization\n * product\n * restaurant\n```" landingPageUrl: minLength: 0 format: uri type: string description: "The URL of this entity's Landing Page that was created with Yext Pages\n\nFiltering Type: `text`\n\n```\nEligible For: \n * atm\n * card\n * event\n * faq\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * helpArticle\n * hotel\n * job\n * location\n * product\n * restaurant\n```" languages: description: "The langauges in which consumers can commicate with this entity or its staff members\nAll strings must be non-empty when trimmed of whitespace.\n\n\n\nArray must be ordered.\n\nArray may have a maximum of 100 elements.\n\nArray item description:\n\n>Cannot Include:\n>* HTML markup\n\nFiltering Type: `list of text`\n\n```\nEligible For: \n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * restaurant\n```" 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\n\n\nCannot Include:\n* a URL or domain name\n* HTML markup\n\nFiltering Type: `text`\n\n```\nEligible For: \n * healthcareProfessional\n```" laundry: enum: - FULL_SERVICE - SELF_SERVICE - NOT_APPLICABLE type: string description: "Indicates whether the entity offers laundry services.\n\nFiltering Type: `option`\n\n```\nEligible For: \n * hotel\n```" lazyRiver: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: "Indicates if the property has a lazy river\n\nFiltering Type: `option`\n\n```\nEligible For: \n * hotel\n```" lifeguard: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: "Indicates if the property has a lifeguard on duty\n\nFiltering Type: `option`\n\n```\nEligible For: \n * hotel\n```" linkedInUrl: minLength: 0 format: uri type: string description: "URL for your LinkedIn account, format should be https://www.linkedin.com/in/yourUsername\n\nFiltering Type: `text`\n\n```\nEligible For: \n * contactCard\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * organization\n * restaurant\n```" linkedLocation: type: string description: "location ID of the event location, if the event is held at a location managed in the Yext Knowledge Manager\n\nFiltering Type: `entityId`\n\n```\nEligible For: \n * contactCard\n * event\n```" 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.\n\nFiltering Type: `text`\n\n```\nEligible For: \n * atm\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * restaurant\n```" localShuttle: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: "Indicates whether the entity offers local shuttle services.\n\nFiltering Type: `option`\n\n```\nEligible For: \n * hotel\n```" 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.\n\nFiltering Type: `entityId`\n\n```\nEligible For: \n * atm\n```" 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\n\nFiltering Type: `object`\n\n```\nEligible For: \n * job\n```" locationType: enum: - LOCATION - HEALTHCARE_FACILITY - HEALTHCARE_PROFESSIONAL - ATM - RESTAURANT - HOTEL type: string description: "Indicates the entity's type, if it is not an event\n\nFiltering Type: `option`\n\n```\nEligible For: \n * atm\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * restaurant\n```" logo: required: - image additionalProperties: false type: object description: "An image of the entity's logo\n\n\nSupported Aspect Ratios:\n* 1 x 1\n\n**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.\n\n\nFiltering Type: `object`\n\n```\nEligible For: \n * atm\n * contactCard\n * faq\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * job\n * location\n * organization\n * restaurant\n```" 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\n\nMust be a valid phone number.\n\nIf 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.\n\nFiltering Type: `text`\n\n```\nEligible For: \n * atm\n * contactCard\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * organization\n * restaurant\n```" massage: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: "Indicates whether the entity offers massage services.\n\nFiltering Type: `option`\n\n```\nEligible For: \n * hotel\n```" 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\n\nFiltering Type: `integer`\n\n```\nEligible For: \n * hotel\n```" 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\n\nFiltering Type: `integer`\n\n```\nEligible For: \n * hotel\n```" 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\n\nFiltering Type: `list of option`\n\n```\nEligible For: \n * restaurant\n```" meetingRoomCount: multipleOf: 1 minimum: 0 type: number description: "The number of meeting rooms the entity has.\n\nFiltering Type: `integer`\n\n```\nEligible For: \n * hotel\n```" 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\n\nFiltering Type: `object`\n\n```\nEligible For: \n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * restaurant\n```" 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\n\nFiltering Type: `object`\n\n```\nEligible For: \n * hotel\n * location\n * restaurant\n```" middleName: minLength: 0 maxLength: 35 type: string description: "The middle name of the healthcare professional\n\n\nCannot Include:\n* a URL or domain name\n* HTML markup\n\nFiltering Type: `text`\n\n```\nEligible For: \n * healthcareProfessional\n```" mobilePhone: minLength: 0 type: string description: "Must be a valid phone number.\n\nIf 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.\n\nFiltering Type: `text`\n\n```\nEligible For: \n * atm\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * restaurant\n```" mobilityAccessible: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: "Indicates whether the entity is mobility/wheelchair accessible\n\nFiltering Type: `option`\n\n```\nEligible For: \n * hotel\n```" nightclub: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: "Indicates whether the entity has a nightclub.\n\nFiltering Type: `option`\n\n```\nEligible For: \n * hotel\n```" npi: minLength: 0 type: string description: "The National Provider Identifier (NPI) of the healthcare provider\n\nFiltering Type: `text`\n\n```\nEligible For: \n * healthcareFacility\n * healthcareProfessional\n```" nudgeEnabled: type: boolean description: "Indicates whether Knowledge Nudge is enabled for the Yext Knowledge Assistant for this entity\n\nFiltering Type: `boolean`\n\n```\nEligible For: \n * atm\n * faq\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * helpArticle\n * hotel\n * job\n * location\n * organization\n * product\n * restaurant\n```" officeName: minLength: 0 type: string description: "The name of the office where the healthcare professional works, if different from **`name`**\n\nFiltering Type: `text`\n\n```\nEligible For: \n * healthcareProfessional\n```" 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.\n\nEach 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.\nSimilarly, holiday online service hours are represented by the `holidayHours` sub-field.\nSetting the `reopenDate` sub-field indicates that the business is temporarily closed and will reopen on the specified date.\nSPECIAL CASES:\n* 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.\n* 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.\n* If you are providing `openIntervals`, you may not set `isClosed` to true for that day.\n\nFiltering Type: `hours`\n\n```\nEligible For: \n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * location\n * restaurant\n```" openDate: format: date type: string description: "The date that the entity is set to open for the first time.\nMust be formatted in YYYY-MM-DD format.\n\nDate must be on or after 1970-01-01 Date must be before or on 2038-01-01\n\n\nFiltering Type: `date`\n\n```\nEligible For: \n * atm\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * restaurant\n```" 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\n\nFiltering Type: `list of option`\n\n```\nEligible For: \n * organization\n```" 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\n\nFiltering Type: `object`\n\n```\nEligible For: \n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * restaurant\n```" organizerEmail: minLength: 0 format: email type: string description: "Point of contact for the event organizer (not to be published publicly)\n\nFiltering Type: `text`\n\n```\nEligible For: \n * event\n```" organizerName: minLength: 0 type: string description: "Point of contact for the event organizer (not to be published publicly)\n\nFiltering Type: `text`\n\n```\nEligible For: \n * event\n```" organizerPhone: minLength: 0 type: string description: "Point of contact for the event organizer (not to be published publicly)\n\nFiltering Type: `text`\n\n```\nEligible For: \n * event\n```" outdoorPoolCount: multipleOf: 1 minimum: 0 type: number description: "The number of outdoor pools the entity has.\n\nFiltering Type: `integer`\n\n```\nEligible For: \n * hotel\n```" parking: enum: - PARKING_AVAILABLE - PARKING_AVAILABLE_FOR_FREE - NOT_APPLICABLE type: string description: "Indicates whether the entity offers parking services.\n\nFiltering Type: `option`\n\n```\nEligible For: \n * hotel\n```" 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\n\nValid elements depend on the entity's country.\n\n\nFiltering Type: `list of option`\n\n```\nEligible For: \n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * restaurant\n```" performers: description: "Performers at the event\n\n\nArray must be ordered.\n\nArray may have a maximum of 100 elements.\n\n\nFiltering Type: `list of text`\n\n```\nEligible For: \n * event\n```" 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.\n\nFiltering Type: `option`\n\n```\nEligible For: \n * hotel\n```" photoGallery: description: "\n**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.\n\n\n\nArray must be ordered.\n\nArray may have a maximum of 500 elements.\n\nArray item description:\n\n>Supported Aspect Ratios:\n>* 1 x 1\n>* 4 x 3\n>* 3 x 2\n>* 5 x 3\n>* 16 x 9\n>* 3 x 1\n>* 2 x 3\n>* 5 x 7\n>* 4 x 5\n>* 4 x 1\n>\n>**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.\n>\n\nFiltering Type: `list of object`\n\n```\nEligible For: \n * atm\n * event\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * hotelRoomType\n * location\n * organization\n * product\n * restaurant\n```" 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\n\nFiltering Type: `object`\n\n```\nEligible For: \n * atm\n * event\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * restaurant\n```" 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.\n\nEach 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.\nSimilarly, holiday pickup hours are represented by the `holidayHours` sub-field.\nSetting the `reopenDate` sub-field indicates that the business is temporarily closed and will reopen on the specified date.\nSPECIAL CASES:\n* 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.\n* 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.\n* If you are providing `openIntervals`, you may not set `isClosed` to true for that day.\n\nFiltering Type: `hours`\n\n```\nEligible For: \n * healthcareFacility\n * location\n * restaurant\n```" pinterestUrl: minLength: 0 format: uri type: string description: "URL for your Pinterest account, format should be https://www.pinterest.com/yourUsername\n\nFiltering Type: `text`\n\n```\nEligible For: \n * contactCard\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * organization\n * restaurant\n```" 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)\n\nFiltering Type: `option`\n\n```\nEligible For: \n * atm\n * healthcareFacility\n * healthcareProfessional\n * location\n * restaurant\n```" primaryConversationContact: minLength: 0 type: string description: "ID of the user who is the primary Knowledge Assistant contact for the entity\n\nFiltering Type: `option`\n\n```\nEligible For: \n * atm\n * faq\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * helpArticle\n * hotel\n * job\n * location\n * organization\n * product\n * restaurant\n```" privateBeach: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: "Indicates whether the entity has access to a private beach.\n\nFiltering Type: `option`\n\n```\nEligible For: \n * hotel\n```" privateCarService: enum: - PRIVATE_CAR_SERVICE - PRIVATE_CAR_SERVICE_FOR_FREE - NOT_APPLICABLE type: string description: "Indicates whether the entity offers private car services.\n\nFiltering Type: `option`\n\n```\nEligible For: \n * hotel\n```" 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\n\nFiltering Type: `object`\n\n```\nEligible For: \n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * restaurant\n```" products: description: "Products sold by this entity\n\nAll strings must be non-empty when trimmed of whitespace.\n\n\n\nArray must be ordered.\n\nArray may have a maximum of 100 elements.\n\nArray item description:\n\n>Cannot Include:\n>* HTML markup\n\nFiltering Type: `list of text`\n\n```\nEligible For: \n * financialProfessional\n * location\n```" 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\n\nFiltering Type: `boolean`\n\n```\nEligible For: \n * atm\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * organization\n * restaurant\n```" rankTrackingCompetitors: description: "Information about the competitors whose search performance you would like to compare to your own\n\n\nArray must be ordered.\n\nArray may have a maximum of 5 elements.\n\n\nFiltering Type: `list of object`\n\n```\nEligible For: \n * atm\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * organization\n * restaurant\n```" 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\n\nFiltering Type: `boolean`\n\n```\nEligible For: \n * atm\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * organization\n * restaurant\n```" rankTrackingFrequency: enum: - WEEKLY - MONTHLY - QUARTERLY type: string description: "How often we send search queries to track your search performance\n\nFiltering Type: `option`\n\n```\nEligible For: \n * atm\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * organization\n * restaurant\n```" rankTrackingQueryTemplates: description: "The ways in which your keywords will be arranged in the search queries we use to track your performance\n\n\nArray must have a minimum of 2 elements.\n\nArray may have a maximum of 4 elements.\n\n\nFiltering Type: `list of option`\n\n```\nEligible For: \n * atm\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * organization\n * restaurant\n```" 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\n\nFiltering Type: `list of option`\n\n```\nEligible For: \n * atm\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * organization\n * restaurant\n```" 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\n\nFiltering Type: `object`\n\n```\nEligible For: \n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * restaurant\n```" restaurantCount: multipleOf: 1 minimum: 0 type: number description: "The number of restaurants the entity has.\n\nFiltering Type: `integer`\n\n```\nEligible For: \n * hotel\n```" reviewGenerationUrl: minLength: 0 type: string description: "The URL given Review Invitation emails where consumers can leave a review about the entity\n\n```\nEligible For: \n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * restaurant\n```" reviewResponseConversationEnabled: type: boolean description: "Indicates whether Yext Knowledge Assistant review-response conversations are enabled for this entity\n\nFiltering Type: `boolean`\n\n```\nEligible For: \n * atm\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * restaurant\n```" roomCount: multipleOf: 1 minimum: 0 type: number description: "The number of rooms the entity has.\n\nFiltering Type: `integer`\n\n```\nEligible For: \n * hotel\n```" roomService: enum: - ROOM_SERVICE_AVAILABLE - ROOM_SERVICE_AVAILABLE_24_HOURS - NOT_APPLICABLE type: string description: "Indicates whether the entity offers room service.\n\nFiltering Type: `option`\n\n```\nEligible For: \n * hotel\n```" 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\n\nFiltering Type: `object`\n\n```\nEligible For: \n * atm\n * event\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * restaurant\n```" salon: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: "Indicates whether the entity has a salon.\n\nFiltering Type: `option`\n\n```\nEligible For: \n * hotel\n```" sauna: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: "Indicates whether the entity has a sauna.\n\nFiltering Type: `option`\n\n```\nEligible For: \n * hotel\n```" scuba: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: "Indicates whether the entity offers scuba diving.\n\nFiltering Type: `option`\n\n```\nEligible For: \n * hotel\n```" selfParking: enum: - SELF_PARKING_AVAILABLE - SELF_PARKING_AVAILABLE_FOR_FREE - NOT_APPLICABLE type: string description: "Indicates whether the entity offers self parking services.\n\nFiltering Type: `option`\n\n```\nEligible For: \n * hotel\n```" 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.\n\nEach 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.\nSimilarly, holiday senior hours are represented by the `holidayHours` sub-field.\nSetting the `reopenDate` sub-field indicates that the business is temporarily closed and will reopen on the specified date.\nSPECIAL CASES:\n* 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.\n* 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.\n* If you are providing `openIntervals`, you may not set `isClosed` to true for that day.\n\nFiltering Type: `hours`\n\n```\nEligible For: \n * location\n * restaurant\n```" serviceArea: additionalProperties: false type: object properties: places: description: "A list of places served by the entity, where each place is either:\n - a postal code, or\n - the name of a city.\n\n\n\nArray must be ordered.\n\nArray may have a maximum of 200 elements.\n\n\nFiltering 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.\n\n**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.\n\nFiltering Type: `object`\n\n```\nEligible For: \n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * restaurant\n```" 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.\n**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.\n\n\nArray may have a maximum of 200 elements.\n\n\nFiltering Type: `list of object`\n\n```\nEligible For: \n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * restaurant\n```" 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\n\nAll strings must be non-empty when trimmed of whitespace.\n\n\n\nArray must be ordered.\n\nArray may have a maximum of 100 elements.\n\nArray item description:\n\n>Cannot Include:\n>* HTML markup\n\nFiltering Type: `list of text`\n\n```\nEligible For: \n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * restaurant\n```" 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.\n\nFiltering Type: `option`\n\n```\nEligible For: \n * hotel\n```" snorkeling: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: "Indicates whether the entity offers snorkeling.\n\nFiltering Type: `option`\n\n```\nEligible For: \n * hotel\n```" socialHour: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: "Indicates whether the entity offers a social hour.\n\nFiltering Type: `option`\n\n```\nEligible For: \n * hotel\n```" spa: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: "Indicates whether the entity has a spa.\n\nFiltering Type: `option`\n\n```\nEligible For: \n * hotel\n```" specialities: description: "Up to 100 of this entity's specialities (e.g., for food and dining: `Chicago style`)\n\nAll strings must be non-empty when trimmed of whitespace.\n\n\n\nArray must be ordered.\n\nArray may have a maximum of 100 elements.\n\nArray item description:\n\n>Cannot Include:\n>* HTML markup\n\nFiltering Type: `list of text`\n\n```\nEligible For: \n * financialProfessional\n * location\n * restaurant\n```" 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.\n\nFiltering Type: `option`\n\n```\nEligible For: \n * hotel\n```" 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.\n\nEach 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.\nSimilarly, holiday takeout hours are represented by the `holidayHours` sub-field.\nSetting the `reopenDate` sub-field indicates that the business is temporarily closed and will reopen on the specified date.\nSPECIAL CASES:\n* 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.\n* 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.\n* If you are providing `openIntervals`, you may not set `isClosed` to true for that day.\n\nFiltering Type: `hours`\n\n```\nEligible For: \n * location\n * restaurant\n```" tennis: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: "Indicates whether the entity has tennis courts.\n\nFiltering Type: `option`\n\n```\nEligible For: \n * hotel\n```" thermalPool: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: "Indicates whether the entity has a thermal pool.\n\nFiltering Type: `option`\n\n```\nEligible For: \n * hotel\n```" ticketAvailability: enum: - IN_STOCK - SOLD_OUT - PRE_ORDER - UNSPECIFIED type: string description: "Information about the availability of tickets for the event\n\nFiltering Type: `option`\n\n```\nEligible For: \n * event\n```" 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\n\nFiltering Type: `object`\n\n```\nEligible For: \n * event\n```" ticketSaleDateTime: format: date-time type: string description: "The date/time tickets are available for sale (local time)\n\nFiltering Type: `datetime`\n\n```\nEligible For: \n * event\n```" ticketUrl: minLength: 0 format: uri type: string description: "URL to purchase tickets for the event (if ticketed)\n\nFiltering Type: `text`\n\n```\nEligible For: \n * event\n```" tikTokUrl: minLength: 0 format: uri type: string description: "URL for your TikTok profile, format should be https://www.tiktok.com/yourUsername\n\nFiltering Type: `text`\n\n```\nEligible For: \n * contactCard\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * organization\n * restaurant\n```" 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\n\nFiltering Type: `object`\n\n```\nEligible For: \n * event\n```" timeZoneUtcOffset: minLength: 0 type: string description: "Represents the time zone offset of the entity from UTC, in `±hh:mm` format.\n\nFor example, if the entity is 4 hours ahead of UTC time, the offset will be `+04:00`.\n\nIf the entity is 15.5 hours behind UTC time, the offset will be `-15:30`.\n\nIf the entity is in UTC time, the offset will be `+00:00`.\n\n\n```\nEligible For: \n * atm\n * event\n * faq\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * job\n * location\n * restaurant\n```" 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\"`\n\nFiltering Type: `option`\n\n```\nEligible For: \n * atm\n * board\n * card\n * contactCard\n * event\n * faq\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * helpArticle\n * hotel\n * hotelRoomType\n * job\n * location\n * organization\n * product\n * restaurant\n```" tollFreePhone: minLength: 0 type: string description: "Must be a valid phone number.\n\nIf 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.\n\nFiltering Type: `text`\n\n```\nEligible For: \n * atm\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * restaurant\n```" treadmill: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: "Indicates whether the entity has a treadmill.\n\nFiltering Type: `option`\n\n```\nEligible For: \n * hotel\n```" ttyPhone: minLength: 0 type: string description: "Must be a valid phone number.\n\nIf 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.\n\nFiltering Type: `text`\n\n```\nEligible For: \n * atm\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * restaurant\n```" turndownService: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: "Indicates whether the entity offers turndown service.\n\nFiltering Type: `option`\n\n```\nEligible For: \n * hotel\n```" twitterHandle: minLength: 0 maxLength: 15 type: string description: "Valid Twitter handle for the entity without the leading \"@\" (e.g., `JohnSmith`)\n\nIf 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.\n\nFiltering Type: `text`\n\n```\nEligible For: \n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * organization\n * restaurant\n```" 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\n\nFiltering Type: `object`\n\n```\nEligible For: \n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * restaurant\n```" 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\n\nFiltering Type: `object`\n\n```\nEligible For: \n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * restaurant\n```" valetParking: enum: - VALET_PARKING_AVAILABLE - VALET_PARKING_AVAILABLE_FOR_FREE - NOT_APPLICABLE type: string description: "Indicates whether the entity offers valet parking services.\n\nFiltering Type: `option`\n\n```\nEligible For: \n * hotel\n```" validThrough: format: date-time type: string description: "The date this entity is valid through.\n\nFiltering Type: `datetime`\n\n```\nEligible For: \n * job\n```" vendingMachine: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: "Indicates whether the entity has a vending machine.\n\nFiltering Type: `option`\n\n```\nEligible For: \n * hotel\n```" venueName: minLength: 0 type: string description: "Name of the venue where the event is being held\n\nFiltering Type: `text`\n\n```\nEligible For: \n * event\n```" videos: description: "Valid YouTube URLs for embedding a video on some publisher sites\n\n**NOTE:** Currently, only the first URL in the Array appears in your listings.\n\n\n\nArray must be ordered.\n\n\nFiltering Type: `list of object`\n\n```\nEligible For: \n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * hotelRoomType\n * location\n * organization\n * product\n * restaurant\n```" 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.\n\nFiltering Type: `option`\n\n```\nEligible For: \n * hotel\n```" wakeUpCalls: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: "Indicates whether the entity offers wake up call services.\n\nFiltering Type: `option`\n\n```\nEligible For: \n * hotel\n```" 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\n\nFiltering Type: `object`\n\n```\nEligible For: \n * atm\n * event\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * restaurant\n```" waterPark: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: "Indicates whether the entity has a water park.\n\nFiltering Type: `option`\n\n```\nEligible For: \n * hotel\n```" waterSkiing: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: "Indicates whether the entity offers water skiing.\n\nFiltering Type: `option`\n\n```\nEligible For: \n * hotel\n```" watercraft: enum: - WATERCRAFT_RENTALS - WATERCRAFT_RENTALS_FOR_FREE - NOT_APPLICABLE type: string description: "Indicates whether the entity offers any kind of watercrafts.\n\nFiltering Type: `option`\n\n```\nEligible For: \n * hotel\n```" waterslide: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: "Indicates whether the entity has a water slide.\n\nFiltering Type: `option`\n\n```\nEligible For: \n * hotel\n```" wavePool: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: "Indicates whether the entity has a wave pool.\n\nFiltering Type: `option`\n\n```\nEligible For: \n * hotel\n```" 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\n\nFiltering Type: `object`\n\n```\nEligible For: \n * atm\n * contactCard\n * event\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * organization\n * restaurant\n```" weightMachine: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: "Indicates whether the entity has a weight machine.\n\nFiltering Type: `option`\n\n```\nEligible For: \n * hotel\n```" wheelchairAccessible: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: "Indicates if the entity is wheelchair accessible.\n\nFiltering Type: `option`\n\n```\nEligible For: \n * hotel\n```" wifiAvailable: enum: - WIFI_AVAILABLE - WIFI_AVAILABLE_FOR_FREE - NOT_APPLICABLE type: string description: "Indicates whether the entity has WiFi available\n\nFiltering Type: `option`\n\n```\nEligible For: \n * hotel\n```" workRemote: type: boolean description: "Indicates whether the job is remote.\n\nFiltering Type: `boolean`\n\n```\nEligible For: \n * job\n```" yearEstablished: multipleOf: 1 minimum: 1000 maximum: 2028 type: number description: "The year the entity was established.\n\nFiltering Type: `integer`\n\n```\nEligible For: \n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * restaurant\n```" yearLastRenovated: multipleOf: 1 minimum: 1000 maximum: 2028 type: number description: "The most recent year the entity was partially or completely renovated.\n\nFiltering Type: `integer`\n\n```\nEligible For: \n * hotel\n```" 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\n\nFiltering Type: `object`\n\n```\nEligible For: \n * atm\n * event\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * job\n * location\n * restaurant\n```" 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\n\nFiltering Type: `object`\n\n```\nEligible For: \n * atm\n * event\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * restaurant\n```" 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\n\nFiltering Type: `object`\n\n```\nEligible For: \n * atm\n * event\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * restaurant\n```" 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\n\nFiltering Type: `object`\n\n```\nEligible For: \n * atm\n * event\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * restaurant\n```" 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\n\nFiltering Type: `object`\n\n```\nEligible For: \n * atm\n * event\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * restaurant\n```" youTubeChannelUrl: minLength: 0 format: uri type: string description: "URL for your YouTube channel, format should be https://www.youtube.com/c/yourUsername\n\nFiltering Type: `text`\n\n```\nEligible For: \n * contactCard\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * organization\n * restaurant\n```" headers: Update-Operation-Id: schema: minLength: 0 type: string description: The ID of the operation '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: {} delete: operationId: deleteLanguageProfile 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 profile that the user wishes to delete 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: 'The ID of the operation. Leave this blank to create a new operation or supply an ID to continue an existing operation ' name: Update-Operation-Id in: header required: false tags: - Knowledge Manager summary: 'Entity Language Profiles: Delete' description: Delete a language profile 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: {} headers: Update-Operation-Id: schema: minLength: 0 type: string description: The ID of the operation '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}/locations: parameters: - $ref: '#/components/parameters/accountId' - $ref: '#/components/parameters/v' get: operationId: getLocations parameters: - $ref: '#/components/parameters/limit' - $ref: '#/components/parameters/offset' - $ref: '#/components/parameters/resolvePlaceholders' - $ref: '#/components/parameters/pageToken' tags: - Knowledge Manager summary: 'Locations (Legacy): List' description: Get multiple Locations (primary profiles only). responses: '200': $ref: '#/components/responses/LocationsResponse' default: $ref: '#/components/responses/ErrorResponse' post: operationId: createLocation tags: - Knowledge Manager requestBody: $ref: '#/components/requestBodies/locationRequest' summary: 'Locations (Legacy): Create' description: "Create a new Location.\n\n ## Required fields\n* **`locationName`**\n* **`address`**\n* **`city`**\n* **`state`**\n* **`zip`**\n\n ## Optional fields that trigger warnings\nSubmitting invalid values for certain optional fields will not trigger an error response. Instead, the success response will contain warning messages explaining why the invalid optional values were not stored in the system. The fields that generate warning messages are:\n

\n* **`logo`**\n* **`photos`**\n* **`twitterHandle`**\n* **`facebookPageUrl`**\n* **`languages`**\n" responses: '201': $ref: '#/components/responses/IdResponse' default: $ref: '#/components/responses/ErrorResponse' /accounts/{accountId}/locationsearch: parameters: - $ref: '#/components/parameters/accountId' - $ref: '#/components/parameters/v' get: operationId: searchLocations parameters: - $ref: '#/components/parameters/limit' - $ref: '#/components/parameters/searchoffset' - $ref: '#/components/parameters/filters' tags: - Knowledge Manager summary: 'Locations (Legacy): Search' description: Get multiple Locations (primary profiles only) that match provided filters. responses: '200': $ref: '#/components/responses/LocationsSearchResponse' default: $ref: '#/components/responses/ErrorResponse' /accounts/{accountId}/locations/{locationId}: parameters: - $ref: '#/components/parameters/accountId' - $ref: '#/components/parameters/locationId' - $ref: '#/components/parameters/v' get: operationId: getLocation parameters: - $ref: '#/components/parameters/resolvePlaceholders' tags: - Knowledge Manager summary: 'Locations (Legacy): Get' description: Gets the primary profile for a single Location. responses: '200': $ref: '#/components/responses/LocationResponse' default: $ref: '#/components/responses/ErrorResponse' put: requestBody: $ref: '#/components/requestBodies/locationRequest' operationId: updateLocation tags: - Knowledge Manager summary: 'Locations (Legacy): Update' description: 'Updates the primary profile for a Location. **NOTE:** Despite using the PUT method, Locations: Update only updates supplied fields. Omitted fields are not modified. **NOTE:** The Location''s primary profile language can be changed by calling this endpoint with a different, but unused, language code. ' responses: '200': $ref: '#/components/responses/IdResponse' default: $ref: '#/components/responses/ErrorResponse' /accounts/{accountId}/folders: parameters: - $ref: '#/components/parameters/accountId' - $ref: '#/components/parameters/offset' - name: limit in: query schema: type: integer default: 100 maximum: 1000 description: Number of results to return. - $ref: '#/components/parameters/v' get: operationId: getLocationFolders tags: - Knowledge Manager summary: 'Folders: List' description: Returns a list of Location Folders in an Account. responses: '200': $ref: '#/components/responses/FoldersResponse' default: $ref: '#/components/responses/ErrorResponse' /accounts/{accountId}/menus: parameters: - $ref: '#/components/parameters/accountId' - $ref: '#/components/parameters/v' get: operationId: getMenus parameters: - $ref: '#/components/parameters/limit' - $ref: '#/components/parameters/offset' tags: - Knowledge Manager summary: 'Menus: List' description: Retrieve all Menus for an account. responses: '200': $ref: '#/components/responses/MenusResponse' default: $ref: '#/components/responses/ErrorResponse' post: operationId: createMenu tags: - Knowledge Manager requestBody: $ref: '#/components/requestBodies/menuRequest' summary: 'Menus: Create' responses: '201': $ref: '#/components/responses/IdResponse' default: $ref: '#/components/responses/ErrorResponse' /accounts/{accountId}/menus/{listId}: parameters: - $ref: '#/components/parameters/accountId' - $ref: '#/components/parameters/listId' - $ref: '#/components/parameters/v' get: operationId: getMenu tags: - Knowledge Manager summary: 'Menus: Get' description: Retrieve a specific Menu. responses: '200': $ref: '#/components/responses/MenuResponse' default: $ref: '#/components/responses/ErrorResponse' put: requestBody: $ref: '#/components/requestBodies/menuRequest' operationId: updateMenu tags: - Knowledge Manager summary: 'Menus: Update' description: Update an existing Menu. responses: '200': $ref: '#/components/responses/MenuResponse' default: $ref: '#/components/responses/ErrorResponse' delete: operationId: deleteMenuList tags: - Knowledge Manager summary: 'Menus: Delete' description: Delete an existing Menu. responses: '200': $ref: '#/components/responses/EmptyResponse' default: $ref: '#/components/responses/ErrorResponse' /accounts/{accountId}/bios: parameters: - $ref: '#/components/parameters/accountId' - $ref: '#/components/parameters/v' get: parameters: - $ref: '#/components/parameters/limit' - $ref: '#/components/parameters/offset' operationId: getBios tags: - Knowledge Manager summary: 'Bios: List' description: Retrieve all Bio Lists for an account. responses: '200': $ref: '#/components/responses/BiosResponse' default: $ref: '#/components/responses/ErrorResponse' post: operationId: createBio tags: - Knowledge Manager requestBody: $ref: '#/components/requestBodies/bioRequest' summary: 'Bios: Create' description: Create new Bio List. responses: '201': $ref: '#/components/responses/IdResponse' default: $ref: '#/components/responses/ErrorResponse' /accounts/{accountId}/bios/{listId}: parameters: - $ref: '#/components/parameters/accountId' - $ref: '#/components/parameters/listId' - $ref: '#/components/parameters/v' get: operationId: getBio tags: - Knowledge Manager summary: 'Bios: Get' description: Retrieve a specific Bios List. responses: '200': $ref: '#/components/responses/BioResponse' default: $ref: '#/components/responses/ErrorResponse' put: requestBody: $ref: '#/components/requestBodies/bioRequest' operationId: updateBio tags: - Knowledge Manager summary: 'Bios: Update' description: Update an existing Bios List. responses: '200': $ref: '#/components/responses/BioResponse' default: $ref: '#/components/responses/ErrorResponse' delete: operationId: deleteBioList tags: - Knowledge Manager summary: 'Bios: Delete' description: Delete an existing Bios List. responses: '200': $ref: '#/components/responses/EmptyResponse' default: $ref: '#/components/responses/ErrorResponse' /accounts/{accountId}/products: parameters: - $ref: '#/components/parameters/accountId' - $ref: '#/components/parameters/v' get: parameters: - $ref: '#/components/parameters/limit' - $ref: '#/components/parameters/offset' operationId: getProducts tags: - Knowledge Manager summary: 'Products: List' description: Retrieve all Product Lists for an account. responses: '200': $ref: '#/components/responses/ProductsResponse' default: $ref: '#/components/responses/ErrorResponse' post: operationId: createProduct tags: - Knowledge Manager requestBody: $ref: '#/components/requestBodies/productRequest' description: Create a new Product List. summary: 'Products: Create' responses: '201': $ref: '#/components/responses/IdResponse' default: $ref: '#/components/responses/ErrorResponse' /accounts/{accountId}/products/{listId}: parameters: - $ref: '#/components/parameters/accountId' - $ref: '#/components/parameters/listId' - $ref: '#/components/parameters/v' get: operationId: getProduct tags: - Knowledge Manager summary: 'Products: Get' description: Retrieve a specific Product List. responses: '200': $ref: '#/components/responses/ProductResponse' default: $ref: '#/components/responses/ErrorResponse' put: requestBody: $ref: '#/components/requestBodies/productRequest' operationId: updateProduct tags: - Knowledge Manager summary: 'Products: Update' description: Update an existing Product List. responses: '200': $ref: '#/components/responses/ProductResponse' default: $ref: '#/components/responses/ErrorResponse' delete: operationId: deleteProductList tags: - Knowledge Manager summary: 'Products: Delete' description: Delete an existing Products List. responses: '200': $ref: '#/components/responses/EmptyResponse' default: $ref: '#/components/responses/ErrorResponse' /accounts/{accountId}/events: parameters: - $ref: '#/components/parameters/accountId' - $ref: '#/components/parameters/v' get: parameters: - $ref: '#/components/parameters/limit' - $ref: '#/components/parameters/offset' operationId: getEvents tags: - Knowledge Manager description: Retrieve all Event Lists for an account. summary: 'Events (Legacy): List' responses: '200': $ref: '#/components/responses/EventsResponse' default: $ref: '#/components/responses/ErrorResponse' post: operationId: createEvent tags: - Knowledge Manager requestBody: $ref: '#/components/requestBodies/eventRequest' description: Create a new Event List. summary: 'Events (Legacy): Create' responses: '201': $ref: '#/components/responses/IdResponse' default: $ref: '#/components/responses/ErrorResponse' /accounts/{accountId}/events/{listId}: parameters: - $ref: '#/components/parameters/accountId' - $ref: '#/components/parameters/listId' - $ref: '#/components/parameters/v' get: operationId: getEvent tags: - Knowledge Manager description: Retrieve a specific Event List. summary: 'Events (Legacy): Get' responses: '200': $ref: '#/components/responses/EventResponse' default: $ref: '#/components/responses/ErrorResponse' put: requestBody: $ref: '#/components/requestBodies/eventRequest' operationId: updateEvent tags: - Knowledge Manager description: Update an existing Event List. summary: 'Events (Legacy): Update' responses: '200': $ref: '#/components/responses/EventResponse' default: $ref: '#/components/responses/ErrorResponse' delete: operationId: deleteEventList tags: - Knowledge Manager description: Delete an existing Event List. summary: 'Events (Legacy): Delete' responses: '200': $ref: '#/components/responses/EmptyResponse' default: $ref: '#/components/responses/ErrorResponse' /categories: parameters: - $ref: '#/components/parameters/v' get: operationId: getBusinessCategories parameters: - name: language in: query schema: type: string description: 'Only categories that apply to this language will be returned. Valid values: ISO 639-1 language codes **Example:** en ' - name: country in: query schema: type: string description: 'Only categories that apply in this country will be returned. Valid values: ISO 3166-1 alpha-2 country codes **Example:** US ' - name: entityType in: query schema: type: string enum: - atm - event - healthcareFacility - healthcareProfessional - location - restaurant description: 'Only categories that apply to the specified entity type will be returned. ' tags: - Knowledge Manager summary: 'Categories: List' description: 'Get available Categories. All Locations are required to have an associated Category to assist with organization and search. Yext provides a hierarchy of business categories for this purpose, exposed by this API. ' responses: '200': $ref: '#/components/responses/CategoriesResponse' default: $ref: '#/components/responses/ErrorResponse' /googlefields: parameters: - $ref: '#/components/parameters/language' - $ref: '#/components/parameters/clientCategoryId' - schema: type: string name: entityId in: query description: 'The external ID of an entity that, if specified, will filter the result to only include any Google Fields that the provided entity has access to. **NOTE:** The **`entityId`** parameter will only be respected for **`v`** parameters of `20241030` or later. ' - $ref: '#/components/parameters/countryCode' - $ref: '#/components/parameters/v' get: operationId: getGoogleKeywords tags: - Knowledge Manager summary: 'Google Fields: List' description: "\nUse the Google Fields endpoint to retrieve a complete list of Google's location attributes for each business category. This list includes attributes that may not apply to all Locations in an account. The set of attributes available to a Location depends on its primary business category and country. You can view and edit the attributes of Locations in the **`googleAttributes`** Location field.\n\n**NOTE:**\n * 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.\n * Only one of **`entityId`** or **`clientCategoryId`** can be specified at a time.\n" responses: '200': $ref: '#/components/responses/GoogleFieldsResponse' default: $ref: '#/components/responses/ErrorResponse' /accounts/{accountId}/customfields: parameters: - $ref: '#/components/parameters/v' - $ref: '#/components/parameters/accountId' get: operationId: getCustomFields parameters: - $ref: '#/components/parameters/offset' - name: limit in: query schema: type: integer default: 100 maximum: 1000 description: Number of results to return. - $ref: '#/components/parameters/entitiesPageToken' tags: - Knowledge Manager summary: 'Custom Fields: List' description: 'Returns a list of Custom Fields in an Account. **NOTE:** Custom Fields of unsupported types will be filtered out. The Custom Fields API will be deprecated in Spring ''24. See [here](https://hitchhikers.yext.com/releases/spring23/?target=announcement---custom-fields-api-deprecation) for more details. ' responses: '200': $ref: '#/components/responses/CustomFieldsResponse' default: $ref: '#/components/responses/ErrorResponse' post: operationId: createCustomField requestBody: required: true content: application/json: schema: type: array items: $ref: '#/components/schemas/Field' tags: - Knowledge Manager summary: 'Custom Fields: Create' description: 'Creates new Custom Field(s) in an Account. **NOTE:** If the **`v`** parameter is on or after `20220615`, the request body must be an array, as to allow multiple field creates per request. The Custom Fields API will be deprecated in Spring ''24. See [here](https://hitchhikers.yext.com/releases/spring23/?target=announcement---custom-fields-api-deprecation) for more details. ' responses: '201': $ref: '#/components/responses/IdsResponse' default: $ref: '#/components/responses/ErrorResponse' /accounts/{accountId}/customfields/{customFieldId}: parameters: - $ref: '#/components/parameters/v' - $ref: '#/components/parameters/accountId' - name: customFieldId in: path required: true schema: type: string description: 'ID that should be used when referencing the field in API calls. This ID will also serve as the Custom Field''s key in our upcoming Entities API endpoints. Note that the Custom Fields can still be accessed using their numeric **`id`** by invoking the endpoints with a **`v`** param before `20180809`. ' get: operationId: getCustomField tags: - Knowledge Manager summary: 'Custom Fields: Get' description: 'Gets a specific Custom Field in an Account. The Custom Fields API will be deprecated in Spring ''24. See [here](https://hitchhikers.yext.com/releases/spring23/?target=announcement---custom-fields-api-deprecation) for more details. ' responses: '200': $ref: '#/components/responses/CustomFieldResponse' default: $ref: '#/components/responses/ErrorResponse' put: requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/FieldUpdate' operationId: updateCustomField tags: - Knowledge Manager summary: 'Custom Fields: Update' description: 'Updates a single Custom Field in an Account. Note that the only updatable values in an existing Custom Field are its name, group, description, alternate language behavior, as well as available options if its `type` is `SINGLE_OPTION` or `MULTI_OPTION`. * If options are modified, every location with that option selected will have the new value. * If options are deleted, all locations with that option will no longer have that option selected. * If the deleted options are the only options selected for a location, the location will no longer have a value set for that Custom Field. The Custom Fields API will be deprecated in Spring ''24. See [here](https://hitchhikers.yext.com/releases/spring23/?target=announcement---custom-fields-api-deprecation) for more details. ' responses: '200': $ref: '#/components/responses/IdResponse' default: $ref: '#/components/responses/ErrorResponse' delete: operationId: deleteCustomField tags: - Knowledge Manager summary: 'Custom Fields: Delete' description: 'Deletes a Custom Field in an Account. The Custom Field will be removed from all locations, and all content entered in the Custom Field will be deleted permanently. The Custom Fields API will be deprecated in Spring ''24. See [here](https://hitchhikers.yext.com/releases/spring23/?target=announcement---custom-fields-api-deprecation) for more details. ' responses: '200': $ref: '#/components/responses/EmptyResponse' default: $ref: '#/components/responses/ErrorResponse' /accounts/{accountId}/locations/{locationId}/profiles: parameters: - $ref: '#/components/parameters/accountId' - $ref: '#/components/parameters/locationId' - $ref: '#/components/parameters/v' get: parameters: - $ref: '#/components/parameters/resolvePlaceholders' operationId: getLanguageProfiles tags: - Knowledge Manager summary: 'Language Profiles (Legacy): List' description: Get Language Profiles for a Location. responses: '200': $ref: '#/components/responses/LanguageProfilesResponse' default: $ref: '#/components/responses/ErrorResponse' /accounts/{accountId}/locations/{locationId}/profiles/{language_code}: parameters: - $ref: '#/components/parameters/accountId' - $ref: '#/components/parameters/locationId' - $ref: '#/components/parameters/language_code' - $ref: '#/components/parameters/v' get: parameters: - $ref: '#/components/parameters/resolvePlaceholders' operationId: getLocationLanguageProfile tags: - Knowledge Manager summary: 'Language Profiles (Legacy): Get' description: Gets the the requested Language Profile for a given Location. responses: '200': $ref: '#/components/responses/LanguageProfileResponse' default: $ref: '#/components/responses/ErrorResponse' put: requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/Location' parameters: - name: primary in: query schema: type: boolean description: When present and set to true, the specified profile will become the location’s primary Language Profile. operationId: upsertLocationLanguageProfile tags: - Knowledge Manager summary: 'Language Profiles (Legacy): Upsert' description: 'Creates and / or sets the fields for a Language Profile **NOTE:** You can change a Language Profile’s language by supplying a different (but unused) language code. ' responses: '200': $ref: '#/components/responses/EmptyResponse' '201': $ref: '#/components/responses/EmptyResponse' default: $ref: '#/components/responses/ErrorResponse' delete: operationId: deleteLocationLanguageProfile tags: - Knowledge Manager description: Remove a Language Profile from a location. summary: 'Language Profiles (Legacy): Delete' responses: '200': $ref: '#/components/responses/EmptyResponse' default: $ref: '#/components/responses/ErrorResponse' /accounts/{accountId}/assets: parameters: - $ref: '#/components/parameters/accountId' - $ref: '#/components/parameters/v' get: operationId: listAssets tags: - Knowledge Manager parameters: - $ref: '#/components/parameters/offset' - name: limit in: query schema: type: integer default: 100 maximum: 1000 description: Number of results to return. - name: pageToken in: query schema: 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. - schema: minLength: 0 type: string default: markdown description: "Present if and only if type of subfield is \"**Rich Text**.\"\n\nValid values:\n * `markdown`\n * `html`\n * `none`\n" required: true name: format in: query summary: 'Assets: List' description: List assets in an account. responses: '200': $ref: '#/components/responses/AssetsResponse' default: $ref: '#/components/responses/ErrorResponse' post: operationId: createAsset tags: - Knowledge Manager summary: 'Assets: Create' description: 'Creates a new asset in an account. **NOTE:** * If the **`v`** parameter is on or before `20190624`: only the first folder the Asset is available for will be returned in the legacy **`folderId`** field. * If the **`v`** parameter is after `20190624`: the complete list of folders the Asset is available to will be returned in the new **`folderIds`** field. **`folderId`** will not be returned. ' requestBody: $ref: '#/components/requestBodies/assetRequest' parameters: - schema: minLength: 0 type: string default: markdown description: "The formatting langauge used to parse rich text field values.\nPresent if and only if type of field is \"**Rich Text**.\"\n\nValid values:\n * `markdown`\n * `html`\n" required: true name: format in: query responses: '201': $ref: '#/components/responses/IdResponse' default: $ref: '#/components/responses/ErrorResponse' /accounts/{accountId}/assets/{assetId}: parameters: - $ref: '#/components/parameters/accountId' - $ref: '#/components/parameters/assetId' - $ref: '#/components/parameters/v' get: operationId: getAsset parameters: - schema: minLength: 0 type: string default: markdown description: "Present if and only if type of subfield is \"**Rich Text**.\"\n\nValid values:\n * `markdown`\n * `html`\n * `none`\n" required: true name: format in: query tags: - Knowledge Manager summary: 'Assets: Get' description: Get a specific asset. responses: '200': $ref: '#/components/responses/AssetResponse' default: $ref: '#/components/responses/ErrorResponse' put: operationId: updateAsset tags: - Knowledge Manager summary: 'Assets: Update' description: 'Update a specific asset. **NOTE**: This endpoint is a true PUT. Fields that are not provided in an update will be cleared. The entire Asset object must be provided in the request, except for its **`id`**, which is given in the path. **NOTE:** * If the **`v`** parameter is on or before `20190624`: only the first folder the Asset is available for will be returned in the legacy **`folderId`** field. * If the **`v`** parameter is after `20190624`: the complete list of folders the Asset is available to will be returned in the new **`folderIds`** field. **`folderId`** will not be returned. ' requestBody: $ref: '#/components/requestBodies/assetRequest' parameters: - schema: minLength: 0 type: string default: markdown description: "The formatting langauge used to parse rich text field values.\nPresent if and only if type of field is \"**Rich Text**.\"\n\nValid values:\n * `markdown`\n * `html`\n" required: true name: format in: query responses: '200': $ref: '#/components/responses/IdResponse' default: $ref: '#/components/responses/ErrorResponse' delete: operationId: deleteAsset tags: - Knowledge Manager summary: 'Assets: Delete' description: Delete a specific asset. responses: '200': $ref: '#/components/responses/EmptyResponse' default: $ref: '#/components/responses/ErrorResponse' /accounts/{accountId}/suggestions: post: operationId: upsertSuggestion requestBody: description: The suggestion to be upserted required: true content: application/json: schema: $ref: '#/components/schemas/UpsertSuggestion' parameters: - $ref: '#/components/parameters/accountId' - $ref: '#/components/parameters/v' - $ref: '#/components/parameters/format' tags: - Knowledge Manager summary: 'Suggestion: Upsert' description: "Create or update a suggestion via API.\n\n**NOTE:**\n * App must have **Create Suggestions: Read/Write** permission to utilize endpoint.\n * If a suggestion already exists from your app on the specified field, the suggestion will be updated.\n * Suggestions on ECLs are not currently supported.\n" responses: '200': $ref: '#/components/responses/IdResponse' default: $ref: '#/components/responses/ErrorResponse' get: operationId: listSuggestions parameters: - $ref: '#/components/parameters/accountId' - $ref: '#/components/parameters/v' - $ref: '#/components/parameters/format' - name: entityIds in: query schema: minLength: 0 type: string description: 'Comma-separated list of entity IDs to pull suggestions for. Defaults to all entities in the account if unspecified. ' required: false - name: entityUids in: query schema: minLength: 0 type: string description: 'Comma-separated list of entity UIDs (formerly known as Yext IDs) to pull suggestions for. Defaults to all entities in the account if unspecified. ' required: false - name: statuses in: query schema: minLength: 0 type: string description: 'Comma-separated list of statuses of suggestions to pull. Defaults to all, but can be any of APPROVED, REJECTED, PENDING, CANCELED. ' required: false - name: limit in: query schema: multipleOf: 1 maximum: 50 type: number default: '10' description: Number of results to return. Default to 10, can go up to 50. required: false - name: pageToken in: query schema: minLength: 0 type: string 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. ' required: false - name: sortBy in: query schema: minLength: 0 type: string description: "Field and sort direction to order results by. The ordering should be a list with one element in the format of **`{\"field_name\": \"sort_direction\"}`**, where **`sort_direction`** is either \"ascending\" or \"descending\".\n\nThis param value needs to be URL encoded.\n\nThe following fields are supported for sorting:\n * uid\n * lastUpdatedDate\n" required: false tags: - Knowledge Manager summary: 'Suggestions: List' description: "Retrieve a list of Suggestions within an account\n\n**NOTE:**\n * App must have either **Create Suggestions: Read** permission or **Manage Suggestions: Read** permission to utilize endpoint.\n * If App only has **Create Suggestions: Read** permission, only Suggestions created by the App in question will be returned.\n * Suggestions on ECLs are not supported.\n * Suggestions to the Categories field are only returned if they are for the Base Category List for your account. This means Suggestions on Category Overrides are not supported in the API today. Unless the Base Category List for your account is specifically set to a different list, the base list used is Yext's; in this default scenario, Publisher Suggestions to Categories will not be available via API, since these suggestions are made on the specific Publisher's Category List.\n" responses: '200': $ref: '#/components/responses/SuggestionsResponse' default: $ref: '#/components/responses/ErrorResponse' /accounts/{accountId}/suggestions/cancel/{suggestionUid}: post: operationId: cancelSuggestion parameters: - $ref: '#/components/parameters/accountId' - $ref: '#/components/parameters/suggestionUid' - $ref: '#/components/parameters/v' tags: - Knowledge Manager summary: 'Suggestion: Cancel' description: "Cancel a suggestion which was submitted by the App.\n\n**NOTE:**\n * App must have **Create Suggestions: Read/Write** permission to utilize endpoint.\n * Suggestions can only be canceled by the submitter.\n" responses: '200': $ref: '#/components/responses/IdResponse' default: $ref: '#/components/responses/ErrorResponse' /accounts/{accountId}/suggestions/{suggestionUid}: get: operationId: getSuggestion parameters: - $ref: '#/components/parameters/accountId' - $ref: '#/components/parameters/suggestionUid' - $ref: '#/components/parameters/v' - $ref: '#/components/parameters/format' tags: - Knowledge Manager summary: 'Suggestion: Get' description: "Retrieve information for a Suggestion with a given ID\n\n**NOTE:**\n * App must have either **Create Suggestions: Read** permission or **Manage Suggestions: Read** permission to utilize endpoint.\n * If App only has **Create Suggestions: Read** permission, only Suggestions created by the App in question will be returned.\n * Suggestions on ECLs are not supported.\n * Suggestions to the Categories field are only returned if they are for the Base Category List for your account. This means Suggestions on Category Overrides are not supported in the API today. Unless the Base Category List for your account is specifically set to a different list, the base list used is Yext's; in this default scenario, Publisher Suggestions to Categories will not be available via API, since these suggestions are made on the specific Publisher's Category List.\n" responses: '200': $ref: '#/components/responses/SuggestionResponse' default: $ref: '#/components/responses/ErrorResponse' /accounts/{accountId}/suggestions/comment/{suggestionUid}: put: operationId: commentSuggestion requestBody: description: Comment to be added to the suggestion. Only the text field of the comment object can be specified. required: true content: application/json: schema: type: object properties: text: type: string parameters: - $ref: '#/components/parameters/accountId' - $ref: '#/components/parameters/suggestionUid' - $ref: '#/components/parameters/v' tags: - Knowledge Manager summary: 'Suggestion: Comment' description: "Add a comment to a suggestion.\n\n**NOTE:**\n * App must have **Manage Suggestions: Read/Write** permission to utilize endpoint.\n" responses: '200': $ref: '#/components/responses/CommentResponse' default: $ref: '#/components/responses/ErrorResponse' /accounts/{accountId}/suggestions/action/{suggestionUid}: put: operationId: updateSuggestion requestBody: description: Actions to take on the suggestion required: true content: application/json: schema: $ref: '#/components/schemas/UpdateSuggestion' parameters: - $ref: '#/components/parameters/accountId' - $ref: '#/components/parameters/suggestionUid' - $ref: '#/components/parameters/v' - $ref: '#/components/parameters/format' tags: - Knowledge Manager summary: 'Suggestion: Action' description: "Perform an action on the Suggestion with the given ID.\n\nThis endpoint allows apps to lock, unlock, reassign, modify the status (approve or reject), and update the content of suggestions. The source of the update will be the Yext App ID of the app making the request.\n\n**NOTE:**\n * App must have **Manage Suggestions: Read/Write** permission to utilize endpoint.\n * Only one of **`locked`**, **`assignee`**, **`status`**, or **`entityFieldSuggestion`** can be provided in the request.\n" responses: '200': $ref: '#/components/responses/IdResponse' default: $ref: '#/components/responses/ErrorResponse' components: parameters: locationId: name: locationId in: path required: true schema: type: string clientCategoryId: name: clientCategoryId in: query required: false schema: type: string description: 'A category id for the business or a Google category ID that, if specified, will filter the result to only include any Google Fields that the provided id maps to. ' 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. ' language: name: language in: query required: false schema: type: string description: 'The language code corresponding to the language in which the user would like to retrieve the Google Fields. Only categories that apply to this language will be returned. ' assetId: name: assetId in: path required: true schema: type: string offset: name: offset in: query required: false schema: type: integer default: 0 description: ' Number of results to skip. Used to page through results. Cannot be used together with **`pageToken`**. ' listId: name: listId in: path required: true schema: type: string description: ID of this List. 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`**.\n\nFor 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`.\n\nNOTE: \"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.\n\nThe filter types are the following. Note there may be multiple available specifications for a given filter type:\n\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
Filter TypeSyntaxDescription
FullfieldName: {contains: $search}$search is the search string
TextfieldName: {$type: [$search,...]}$type is one of [contains,doesNotContain,startsWith,equalTo], $search is an array of search strings, combined with OR
TextfieldName: $type$type is one of [empty,notEmpty]
NumberfieldName: {$type: $value}$type is one of [eq,lt,gt,le,ge], $value is the numeric value
NumberfieldName: {$type: [$value1, $value2]}$type is one of [between], $value1 and $value2 are numeric values
DatefieldName: {$type: $value}$type is one of [eq,lt,gt,le,ge], $value is a string of \"YYYY-MM-DD\" formatted date
DatefieldName: $type$type is one of [empty,notEmpty]
DatefieldName: {$type: [$value1, $value2]}$type is one of [between], $value1 and $value2 are strings of \"YYYY-MM-DD\" formatted date
CategoriesfieldName: {$type: [$id,...]}$type is one of [includes,notIncludes], $id is an array of numeric category IDs, combined with OR
CategoriesfieldName: $type$type is one of [none]
AssetsfieldName: {$type: [$id,...]}$type is one of [includes,notIncludes], $id is an array of numeric category IDs, combined with OR
AssetsfieldName: $type$type is one of [none]
CountryfieldName: {$type: [$country,...]}$type is one of [includes,notIncludes], $country is an array of country code strings, combined with OR
PrimaryLanguagefieldName: {$type: [$language,...]}$type is one of [is,isNot], $language is an array of language code strings, combined with OR
AlternateLanguagefieldName: {$type: [$language,...]}$type is one of [includes, notIncludes], $language is an array of language code strings, combined with OR
StringSinglefieldName: {$type: [$string,...]}$type is one of [is,isNot], $string is an array of strings, combined with OR
StringListfieldName: {$type: [$string,...]}$type is one of [includes,notIncludes], $string is an array of strings, combined with OR
LocationTypefieldName: {$type: [$id,...]}$type is one of [is,isNot], $id is an array of location type IDs, combined with OR
BoolfieldName: $type$type is one of [true,false]
OptionfieldName: {$type: $id}$type is one of [is,isNot], $id is an option ID (For single option custom fields)
OptionfieldName: {$type: [$id,...]}$type is one of [includes,notIncludes], $id is an array of option IDs, combined with OR (For multi option custom fields)
FolderfieldName: [$id,...]$id is a numeric folder ID
FolderfieldName: $id$id is a numeric folder ID
FolderfieldName: {$type: [$id,...]}$id is a numeric folder ID, $type is one of ['isIn', 'isNotIn']
LabelsfieldName: {$type: [$id,...]}$type is one of [includes,notIncludes], $id is an array of label IDs, combined with OR
\n\nThe following fields can be specified in the request (Field name/Filter Type/Example(s)):\n\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
Field NameFilter TypeExample(s)
locationFull\"location\": {\"contains\": \"Atlanta\"}
nameText\"name\": {\"startsWith\": [\"Guitar\"]}, \"name\": {\"contains\": [\"A\",\"B\"]}
addressText\"address\": {\"startsWith\": [\"South\"]}
address2Text\"address2\": {\"contains\": [\"Suite\"]}
cityText\"city\": {\"contains\": [\"Atlanta\"]}
stateText\"state\": {\"contains\": [\"AK\",\"VA\"]}
zipText\"zip\": {\"contains\": [\"M5K 7QB\"]}
phonesText\"phones\": {\"startsWith\": [\"703\",\"571\"]}
specialOfferText\"specialOffer\": \"notEmpty\"
emailsText\"emails\": {\"doesNotContain\": [\"@yext.com\"]}
websiteText\"website\": {\"equalTo\": [\"https://www.yext.com/\"]}
categoriesCategories\"categories\": {\"includes\": [23,755,34]}
closedBool\"closed\": true
storeIdText\"storeId\": {\"equalTo\": [\"MCD0001\"]}
countryCodeCountry\"countryCode\": {\"notIncludes\": [\"US\"]}
productsText\"products\": {\"startsWith\": [\"Burger\",\"Fries\"]}
servicesText\"services\": {\"contains\": [\"Manicures\"]}
specialitiesText\"services\": \"notEmpty\"
associationsText\"associations\": \"empty\"
brandsText\"brands\": {\"equalTo\": [\"North Face\"]}
languagesText\"languages\": {\"equalTo\": [\"English\",\"Spanish\"]}
keywordsText\"keywords\": {\"startsWith\": [\"Franchise\"]}
menuIdsIdList\"menuIds\": {\"includes\": [\"m-23\",\"755\",\"menu34\"]}
productListIdsIdList\"productListIds\": {\"notIncludes\": [\"pl-2\"]}
calendarIdsIdList\"calendarIds\": {\"notIncludes\": [\"cal34\"]}
bioIdsIdList\"bioIds\": {\"includes\": [\"b23\",\"34\"]}
custom###Text (for Multiline Text, URL, Text List, and Text Custom Fields), Number, Date, Bool, or Option\"custom123\": {\"equalTo\": [\"asdf\"]}
folderFolder\"folder\": 123, \"folder\": [123,456]
primary_languagePrimaryLanguage\"primary_language\": {\"is\": \"fr_CA\"}
alternateProfileLanguageAlternateLanguage\"alternateProfileLanguage\": {\"includes\": [\"en\", \"fr\"]}
npiStringSingle\"npi\": {\"is\": [\"1234567890\", \"1111111111\"]}
conditionsTreatedText\"conditionsTreated\": {\"startsWith\": [\"Influenza\"]}, \"conditionsTreated\": {\"contains\": [\"A\",\"B\"]}
lastUpdatedDate\"lastUpdated\": {\"eq\": \"2018-01-01\"}, \"lastUpdated\": {\"between\": [\"2017-01-01\", \"2018-01-01\"]}
fieldsWithDataFields\"fieldsWithData\": [\"email\", \"hours\"]
fieldsWithoutDataFields\"fieldsWithoutData\": [\"logo\", \"video\"]
reviewCountNumber\"review_count\": {\"gt\": 1}, \"review_count \": {\"lt\": 10}
averageRatingNumber\"averageRating\": {\"lt\": 3}
locationTypeLocationType\"locationType\": {\"is\": [1]}, \"locationType\": {\"isNot\": [123]}
genderStringSingle\"gender\": {\"is\": [\"FEMALE\"]}, \"gender\": {\"isNot\": [\"MALE\"]}
degreesStringList\"degrees\": {\"includes\": [\"MD\"]}, \"degrees\": {\"notIncludes\": [\"PHD\"]}
experiencesStringList\"experiences\": {\"includes\": [\"FELLOWSHIP\"]}, \"experiences\": {\"notIncludes\":[\"INTERNSHIP\"]}
yearCompletedNumber\"yearCompleted\": {\"gt\": 2000}, \"yearCompleted\": {\"lt\": 2015}
acceptingNewPatientsBool\"acceptingNewPatients\": true
firstNameText\"firstName\": {\"startsWith\": [\"David\"]}, \"firstName\": {\"contains\": [\"A\",\"B\"]}
middleNameText\"middleName\": {\"startsWith\": [\"P\"]}, \"middleName\": {\"contains\": [\"N\",\"E\"]}
lastNameText\"lastName\": {\"startsWith\": [\"Sm\"]}, \"lastName\": {\"contains\": [\"Y\",\"Z\"]}
officeNameText\"officeName\": {\"startsWith\": [\"Chiropractic\"]}, \"officeName\": {\"contains\":[\"Center\",\"P\"]}
certificationsText\"certifications\": {\"contains\": [\"Radiation Oncology\"]}
institutionNameText\"institutionName\": {\"startsWith\": [\"New York\"]}
insuranceAcceptedText\"insuranceAccepted\": {\"startsWith\": [\"United\"]}, \"insuranceAccepted\":{\"contains\": [\"C\",\"Health\"]}
admittingHospitalsText\"admittingHospitals\": {\"startsWith\": [\"Children's\"]}, \"admittingHospitals\":{\"contains\": [\"Medical\",\"University\"]}
subscriptionsIdList\"subscriptions\": {\"notIncludes\": [\"123\"]}
facebookAccountsIdList\"facebookAccounts\": {\"notIncludes\": [\"1111\"]}
foursquareAccountsIdList\"foursquareAccounts\": {\"notIncludes\": [\"1111\"]}
googleplusAccountsIdList\"googleplusAccounts\": {\"notIncludes\": [\"1111\"]}
labelsLabels\"labels\": {\"includes\": [1, 100]}
\n" language_code: name: language_code in: path schema: type: string required: true description: Locale code. v: name: v in: query required: true schema: type: string description: A date in `YYYYMMDD` format. entitiesPageToken: name: pageToken in: query schema: type: string required: false 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. ' format: name: format in: query schema: minLength: 0 type: string default: markdown description: "The formatting language used to parse rich text field values. Present if and only if the field is of type “**Rich Text**.\"\n\nValid values:\n * `markdown`\n * `html`\n * `none`\n" required: false limit: name: limit in: query schema: type: integer default: 10 maximum: 50 description: Number of results to return. searchoffset: name: offset in: query required: false schema: type: integer default: 0 maximum: 9950 description: Number of results to skip. Used to page through results. resolvePlaceholders: name: resolvePlaceholders in: query schema: type: boolean default: false description: 'Optional parameter to resolve all embedded fields in a Location object response. - `false`: Location object returns placeholder labels, e.g., "Your [[CITY]] store" - `true`: Location object returns placeholder values, e.g., "Your Fairfax store" ' accountId: name: accountId in: path required: true schema: type: string suggestionUid: name: suggestionUid in: path required: true schema: type: string description: The Yext-generated unique identifier for the Suggestion. countryCode: name: countryCode in: query required: false schema: type: string description: 'The two-character ISO 3166-1 country code, if specified, will filter the result to only include any Google Fields that are eligible for that country. ' schemas: Folders: type: object properties: id: type: string description: The Yext Folder ID. parentId: type: string description: The ID of the folder that contains the folder. name: type: string description: The folder's name. EntityTypes: type: string enum: - location - event - healthcareProfessional - healthcareFacility - atm - restaurant 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. \n" 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. LocationType: type: string enum: - LOCATION - HEALTHCARE_PROFESSIONAL - HEALTHCARE_FACILITY - RESTAURANT - ATM HealthcareProfessionalWrite: allOf: - $ref: '#/components/schemas/EntityWrite' - additionalProperties: false type: object properties: meta: additionalProperties: false type: object properties: countryCode: minLength: 0 type: string description: Country code of this Entity's Language Profile (defaults to the country of the account) folderId: minLength: 0 type: string description: The ID of the folder containing this Entity id: minLength: 0 type: string description: ID of this Entity labels: uniqueItems: false type: array items: minLength: 0 type: string description: This Entity's labels. If the **`v`** parameter is before `20211215`, this will be an integer. language: minLength: 0 type: string description: Language code of this Entity's Language Profile (defaults to the language code of the account) description: Contains the metadata about the entity. name: minLength: 0 maxLength: 5000 type: string description: ' Cannot Include: * HTML markup' 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' countryCode: minLength: 0 pattern: ^[a-zA-Z]{2}$ type: string 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`).' line1: minLength: 0 maxLength: 255 type: string description: ' Cannot Include: * a URL or domain name' line2: minLength: 0 maxLength: 255 type: string description: ' Cannot Include: * a URL or domain name' 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' region: minLength: 0 maxLength: 255 type: string description: 'The name of the entity''s region or state. Cannot Include: * a URL or domain name' sublocality: minLength: 0 maxLength: 255 type: string description: 'The name of the entity''s sublocality Cannot Include: * a URL or domain name' 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.' acceptingNewPatients: type: boolean description: Indicates whether the healthcare provider is accepting new patients. additionalHoursText: minLength: 0 maxLength: 255 type: string description: Additional information about hours that does not fit in **`hours`** (e.g., `"Closed during the winter"`) addressHidden: type: boolean description: If `true`, the entity's street address will not be shown on listings. Defaults to `false`. 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' uniqueItems: true type: array items: minLength: 0 maxLength: 100 type: string description: ' Cannot Include: * HTML markup' 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' uniqueItems: true type: array items: minLength: 0 maxLength: 100 type: string description: ' Cannot Include: * HTML markup' 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.' 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.' 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.' 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. ' uniqueItems: true type: array items: required: - category - quickLinkUrl - appName additionalProperties: false type: object properties: appName: minLength: 0 maxLength: 18 type: string appStoreUrl: minLength: 0 maxLength: 2000 format: uri type: string 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 quickLinkUrl: minLength: 0 maxLength: 2000 format: uri type: string appleBusinessDescription: minLength: 0 maxLength: 500 type: string description: The business description to be sent to Apple appleBusinessId: minLength: 0 pattern: ^\d*\.?\d*$ type: string description: The ID associated with an individual Business Folder in your Apple account appleCompanyId: minLength: 0 pattern: ^\d*\.?\d*$ type: string description: The ID associated with your Apple account. Numerical values only 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. ' properties: alternateText: minLength: 0 type: string url: minLength: 0 format: uri type: string appleDisplayName: minLength: 0 maxLength: 5000 type: string description: "The name to be displayed on Apple for the entity.\nNOTE: The names of Brands and their respective Locations within an Apple Business Connect Account must match identically.\nCannot Include:\nHTML markup \n\n\nCannot Include:\n* HTML markup" 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' uniqueItems: true type: array items: minLength: 0 maxLength: 100 type: string description: ' Cannot Include: * HTML markup' 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. ' uniqueItems: true type: array items: minLength: 0 type: string 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. description: Information about the Bio Content Lists associated with this entity 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' uniqueItems: true type: array items: minLength: 0 maxLength: 100 type: string description: ' Cannot Include: * HTML markup' 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. ' categoryIds: uniqueItems: false type: array items: minLength: 0 type: string 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. ' 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' uniqueItems: true type: array items: minLength: 0 maxLength: 200 type: string description: ' Cannot Include: * HTML markup' closed: type: boolean description: Indicates whether the entity is closed 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' uniqueItems: true type: array items: minLength: 0 maxLength: 100 type: string description: ' Cannot Include: * HTML markup' covidMessaging: minLength: 0 maxLength: 15000 type: string description: Information or messaging related to COVID-19. 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. ' uniqueItems: true type: array items: minLength: 0 maxLength: 100 type: string degrees: description: 'A list of the degrees earned by the healthcare professional Array must be ordered. ' 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: minLength: 10 maxLength: 15000 type: string description: 'A description of the entity Cannot Include: * HTML markup' displayCoordinate: additionalProperties: false type: object properties: latitude: minimum: -90 maximum: 90 type: number longitude: minimum: -180 maximum: 180 type: number description: Coordinates where the map pin for the entity should be displayed, as provided by you dropoffCoordinate: additionalProperties: false type: object properties: latitude: minimum: -90 maximum: 90 type: number longitude: minimum: -180 maximum: 180 type: number description: Coordinates of the drop-off area for the entity, as provided by you educationList: description: 'Information about the education or training completed by the healthcare professional Array must be ordered. ' uniqueItems: true type: array items: required: - type - institutionName - yearCompleted additionalProperties: false type: object properties: institutionName: minLength: 0 maxLength: 100 type: string type: enum: - FELLOWSHIP - RESIDENCY - INTERNSHIP - MEDICAL_SCHOOL type: string yearCompleted: multipleOf: 1 minimum: 1900 maximum: 2100 type: number 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. ' uniqueItems: true type: array items: minLength: 0 format: email type: string facebookAbout: minLength: 0 maxLength: 255 type: string description: A description of the entity to be used in the "About You" section on Facebook 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 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.' 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' 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. ' properties: alternateText: minLength: 0 type: string url: minLength: 0 format: uri type: string 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' 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. facebookOverrideCity: minLength: 0 type: string description: The city to be displayed on this entity's Facebook profile 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.' 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 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. ' properties: alternateText: minLength: 0 type: string url: minLength: 0 format: uri type: string facebookStoreId: minLength: 0 type: string description: The Store ID used for this entity in a brand page location structure 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. 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). 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.' 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' url: minLength: 0 maxLength: 255 format: uri type: string description: Valid URL linked to the Featured Message text description: Information about the entity's Featured Message firstName: minLength: 0 maxLength: 35 type: string description: 'The first name of the healthcare professional Cannot Include: * a URL or domain name * HTML markup' firstPartyReviewPage: minLength: 0 type: string description: Link to the review-collection page, where consumers can leave first-party reviews 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. ' uniqueItems: true type: array items: required: - question additionalProperties: false type: object properties: answer: minLength: 1 maxLength: 4096 type: string question: minLength: 1 maxLength: 4096 type: string gender: enum: - UNSPECIFIED - FEMALE - MALE - NONBINARY - TRANSGENDER_FEMALE - TRANSGENDER_MALE - OTHER - PREFER_NOT_TO_DISCLOSE type: string description: The gender of the healthcare professional geomodifier: minLength: 0 type: string description: Provides additional information on where the entity can be found (e.g., `Times Square`, `Global Center Mall`) 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.' 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 ' properties: alternateText: minLength: 0 type: string url: minLength: 0 format: uri type: string 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. ' whatsappMessagingUrl: minLength: 0 maxLength: 2000 format: uri type: string description: 'A valid URL for this entity''s WhatsApp account. Must be a valid URL ' 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.' 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' uniqueItems: true type: array items: minLength: 0 maxLength: 50 type: string description: ' Cannot Include: * HTML markup' googlePlaceId: minLength: 0 type: string description: The unique identifier of this entity on Google Maps. 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. ' properties: alternateText: minLength: 0 type: string url: minLength: 0 format: uri type: string 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.' headshot: required: - url additionalProperties: false type: object description: A portrait of the healthcare professional properties: alternateText: minLength: 0 type: string url: minLength: 0 format: uri type: string holidayHoursConversationEnabled: type: boolean description: Indicates whether holiday-hour confirmation alerts are enabled for the Yext Knowledge Assistant for this entity 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. openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). start: format: time type: string description: The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). 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. 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. ' 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' isClosed: type: boolean description: Indicates if the hours of operation are "closed" on on the given date. 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. openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). start: format: time type: string description: The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). description: Contains the time intervals for which the Entity is open on the specified date. monday: additionalProperties: false type: object properties: isClosed: type: boolean description: Indicates if the hours of operation are "closed" on Monday. openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). start: format: time type: string description: The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). 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. reopenDate: format: date type: string description: ' Date must be on or after 1970-01-01 Date must be before or on 2038-01-01' saturday: additionalProperties: false type: object properties: isClosed: type: boolean description: Indicates if the hours of operation are "closed" on Saturday. openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). start: format: time type: string description: The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). 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. sunday: additionalProperties: false type: object properties: isClosed: type: boolean description: Indicates if the hours of operation are "closed" on Sunday. openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). start: format: time type: string description: The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). 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. thursday: additionalProperties: false type: object properties: isClosed: type: boolean description: Indicates if the hours of operation are "closed" on Thursday. openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). start: format: time type: string description: The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). 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. tuesday: additionalProperties: false type: object properties: isClosed: type: boolean description: Indicates if the hours of operation are "closed" on Tuesday. openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). start: format: time type: string description: The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). 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. wednesday: additionalProperties: false type: object properties: isClosed: type: boolean description: Indicates if the hours of operation are "closed" on Wednesday. openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). start: format: time type: string description: The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). 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. 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.' 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. instagramHandle: minLength: 0 maxLength: 30 type: string description: Valid Instagram username for the entity without the leading "@" (e.g., `NewCityAuto`) 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' uniqueItems: true type: array items: minLength: 0 maxLength: 100 type: string description: ' Cannot Include: * HTML markup' isClusterPrimary: type: boolean description: Indicates whether the healthcare entity is the primary entity in its group 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.' 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' uniqueItems: true type: array items: minLength: 0 maxLength: 100 type: string description: ' Cannot Include: * HTML markup' 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.' landingPageUrl: minLength: 0 format: uri type: string description: The URL of this entity's Landing Page that was created with Yext Pages 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' uniqueItems: true type: array items: minLength: 0 maxLength: 100 type: string description: ' Cannot Include: * HTML markup' lastName: minLength: 0 maxLength: 35 type: string description: 'The last name of the healthcare professional Cannot Include: * a URL or domain name * HTML markup' linkedInUrl: minLength: 0 format: uri type: string description: URL for your LinkedIn account, format should be https://www.linkedin.com/in/yourUsername 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. locationType: enum: - LOCATION - HEALTHCARE_FACILITY - HEALTHCARE_PROFESSIONAL - ATM - RESTAURANT - HOTEL type: string description: Indicates the entity's type, if it is not an event 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. ' properties: clickthroughUrl: minLength: 0 format: uri type: string description: minLength: 0 type: string details: minLength: 0 type: string 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. ' properties: alternateText: minLength: 0 type: string url: minLength: 0 format: uri type: string 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.' 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`**. 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. url: minLength: 0 maxLength: 2000 format: uri type: string description: A valid URL where consumers can view the entity's menu description: Information about the URL where consumers can view the entity's menu middleName: minLength: 0 maxLength: 35 type: string description: 'The middle name of the healthcare professional Cannot Include: * a URL or domain name * HTML markup' 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.' npi: minLength: 0 type: string description: The National Provider Identifier (NPI) of the healthcare provider nudgeEnabled: type: boolean description: Indicates whether Knowledge Nudge is enabled for the Yext Knowledge Assistant for this entity officeName: minLength: 0 type: string description: The name of the office where the healthcare professional works, if different from **`name`** 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. openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). start: format: time type: string description: The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). 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. 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. ' 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' isClosed: type: boolean description: Indicates if the online service hours are "closed" on on the given date. 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. openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). start: format: time type: string description: The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). description: Contains the time intervals for the Entity's online service hours on the specified date. monday: additionalProperties: false type: object properties: isClosed: type: boolean description: Indicates if the online service hours are "closed" on Monday. openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). start: format: time type: string description: The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). 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. reopenDate: format: date type: string description: ' Date must be on or after 1970-01-01 Date must be before or on 2038-01-01' saturday: additionalProperties: false type: object properties: isClosed: type: boolean description: Indicates if the online service hours are "closed" on Saturday. openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). start: format: time type: string description: The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). 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. sunday: additionalProperties: false type: object properties: isClosed: type: boolean description: Indicates if the online service hours are "closed" on Sunday. openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). start: format: time type: string description: The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). 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. thursday: additionalProperties: false type: object properties: isClosed: type: boolean description: Indicates if the online service hours are "closed" on Thursday. openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). start: format: time type: string description: The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). 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. tuesday: additionalProperties: false type: object properties: isClosed: type: boolean description: Indicates if the online service hours are "closed" on Tuesday. openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). start: format: time type: string description: The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). 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. wednesday: additionalProperties: false type: object properties: isClosed: type: boolean description: Indicates if the online service hours are "closed" on Wednesday. openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). start: format: time type: string description: The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). 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. 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.' 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 ' 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`**. 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. url: minLength: 0 maxLength: 2000 format: uri type: string description: A valid URL used to place an order at this entity description: Information about the URL used to place orders that will be fulfilled by the entity 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: 'The payment methods accepted by this entity Valid elements depend on the entity''s country. ' 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. >' 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. ' properties: clickthroughUrl: minLength: 0 format: uri type: string description: minLength: 0 type: string details: minLength: 0 type: string 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. ' properties: alternateText: minLength: 0 type: string url: minLength: 0 format: uri type: string pickupCoordinate: additionalProperties: false type: object properties: latitude: minimum: -90 maximum: 90 type: number longitude: minimum: -180 maximum: 180 type: number description: Coordinates of where consumers can be picked up at the entity, as provided by you pinterestUrl: minLength: 0 format: uri type: string description: URL for your Pinterest account, format should be https://www.pinterest.com/yourUsername 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) primaryConversationContact: minLength: 0 type: string description: ID of the user who is the primary Knowledge Assistant contact for the entity 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. ' uniqueItems: true type: array items: minLength: 0 type: string 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. description: Information about the Products & Services Content Lists associated with this entity questionsAndAnswers: type: boolean description: Indicates whether Yext Knowledge Assistant question-and-answer conversations are enabled for this entity 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. ' 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' 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.' rankTrackingEnabled: type: boolean description: Indicates whether Rank Tracking is enabled rankTrackingFrequency: enum: - WEEKLY - MONTHLY - QUARTERLY type: string description: How often we send search queries to track your search performance rankTrackingKeywords: description: 'The keywords for which you would like to track your search performance ' uniqueItems: true type: array items: enum: - NAME - PRIMARY_CATEGORY - SECONDARY_CATEGORY type: string 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. ' uniqueItems: true type: array items: enum: - KEYWORD - KEYWORD_ZIP - KEYWORD_CITY - KEYWORD_IN_CITY - KEYWORD_NEAR_ME - KEYWORD_CITY_STATE type: string rankTrackingSites: uniqueItems: true type: array items: enum: - GOOGLE_DESKTOP - GOOGLE_MOBILE - BING_DESKTOP - BING_MOBILE - YAHOO_DESKTOP - YAHOO_MOBILE type: string description: The search engines that we will use to track your performance 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`**.' 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. url: minLength: 0 maxLength: 2000 format: uri type: string description: A valid URL used to make reservations at this entity description: Information about the URL consumers can visit to make reservations at this entity reviewGenerationUrl: minLength: 0 type: string description: The URL given Review Invitation emails where consumers can leave a review about the entity reviewResponseConversationEnabled: type: boolean description: Indicates whether Yext Knowledge Assistant review-response conversations are enabled for this entity routableCoordinate: additionalProperties: false type: object properties: latitude: minimum: -90 maximum: 90 type: number longitude: minimum: -180 maximum: 180 type: number description: Destination coordinates to use for driving directions to the entity, as provided by you serviceArea: additionalProperties: false type: object properties: places: description: "A list of places served by the entity, where each place is either:\n - a postal code, or\n - the name of a city.\n\n\n\nArray must be ordered.\n\nArray may have a maximum of 200 elements.\n" uniqueItems: true type: array items: minLength: 0 maxLength: 100 type: string 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.' 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. ' uniqueItems: true type: array items: additionalProperties: false type: object properties: name: minLength: 0 maxLength: 100 type: string googlePlaceId: minLength: 0 type: string type: enum: - POSTAL_CODE - REGION - COUNTY - CITY - SUBLOCALITY type: string 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' uniqueItems: true type: array items: minLength: 0 maxLength: 100 type: string description: ' Cannot Include: * HTML markup' tikTokUrl: minLength: 0 format: uri type: string description: URL for your TikTok profile, format should be https://www.tiktok.com/yourUsername 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"` 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.' 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.' 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.' 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.' 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`.' 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 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`**.' 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`**.' 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`**.' description: Information about the call-to-action consumers will see in the Uber app during a trip to your entity 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. ' uniqueItems: true type: array items: required: - video additionalProperties: false type: object properties: description: minLength: 0 maxLength: 140 type: string description: ' Cannot Include: * HTML markup' video: required: - url additionalProperties: false type: object properties: url: minLength: 0 format: uri type: string walkableCoordinate: additionalProperties: false type: object properties: latitude: minimum: -90 maximum: 90 type: number longitude: minimum: -180 maximum: 180 type: number description: Destination coordinates to use for walking directions to the entity, as provided by you 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`**.' 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. url: minLength: 0 maxLength: 2000 format: uri type: string description: A valid URL for this entity's website description: Information about the website for this entity yearEstablished: multipleOf: 1 minimum: 1000 maximum: 2028 type: number description: The year the entity was established. youTubeChannelUrl: minLength: 0 format: uri type: string description: URL for your YouTube channel, format should be https://www.youtube.com/c/yourUsername BioEcl_Section: allOf: - $ref: '#/components/schemas/BaseEclSection' - type: object properties: items: type: array description: Section Items. items: $ref: '#/components/schemas/BioItem' Translation: type: object properties: languageCode: type: string description: Language code of the translation. value: type: string description: Localized value of the string. Photos: type: array description: List of up to 5 photos. items: $ref: '#/components/schemas/CommonEclDefinitions_Photo' MenuItem: allOf: - $ref: '#/components/schemas/BaseEclItem' - type: object properties: photo: $ref: '#/components/schemas/CommonEclDefinitions_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 ' 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. UpdateSuggestion: type: object properties: status: description: 'The status of the suggestion. Provide **`APPROVED`** to approve the suggestion or **`REJECTED`** to reject the suggestion. ' type: string locked: description: 'Boolean value specifying if the field the suggestion is on is locked or not. Only valid for suggestions where **`status = PENDING`** and **`destinationType = ENTITY`**. ' type: boolean assignee: $ref: '#/components/schemas/Assignee' entityFieldSuggestion: $ref: '#/components/schemas/EntityFieldSuggestionWrite' Assignee: type: object description: 'Object containing information about who the suggestion is assigned to. Omitted if suggestion is unassigned. ' properties: userId: description: 'The Yext User ID of the user to whom the suggestion is assigned. ' type: string userGroupId: description: 'The Yext User Group ID of the user group to which the suggestion is assigned. ' type: string 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. RestaurantWrite: allOf: - $ref: '#/components/schemas/EntityWrite' - additionalProperties: false type: object properties: meta: additionalProperties: false type: object properties: countryCode: minLength: 0 type: string description: Country code of this Entity's Language Profile (defaults to the country of the account) folderId: minLength: 0 type: string description: The ID of the folder containing this Entity id: minLength: 0 type: string description: ID of this Entity labels: uniqueItems: false type: array items: minLength: 0 type: string description: This Entity's labels. If the **`v`** parameter is before `20211215`, this will be an integer. language: minLength: 0 type: string description: Language code of this Entity's Language Profile (defaults to the language code of the account) description: Contains the metadata about the entity. name: minLength: 0 maxLength: 5000 type: string description: ' Cannot Include: * HTML markup' 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' countryCode: minLength: 0 pattern: ^[a-zA-Z]{2}$ type: string 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`).' line1: minLength: 0 maxLength: 255 type: string description: ' Cannot Include: * a URL or domain name' line2: minLength: 0 maxLength: 255 type: string description: ' Cannot Include: * a URL or domain name' 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' region: minLength: 0 maxLength: 255 type: string description: 'The name of the entity''s region or state. Cannot Include: * a URL or domain name' sublocality: minLength: 0 maxLength: 255 type: string description: 'The name of the entity''s sublocality Cannot Include: * a URL or domain name' 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.' acceptsReservations: type: boolean description: Indicates whether the entity accepts reservations. 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. openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). start: format: time type: string description: The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). 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. 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. ' 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' isClosed: type: boolean description: Indicates if the access hours are "closed" on on the given date. 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. openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). start: format: time type: string description: The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). description: Contains the time intervals for which the Entity is open on the specified date. monday: additionalProperties: false type: object properties: isClosed: type: boolean description: Indicates if the access hours are "closed" on Monday. openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). start: format: time type: string description: The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). 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. reopenDate: format: date type: string description: ' Date must be on or after 1970-01-01 Date must be before or on 2038-01-01' saturday: additionalProperties: false type: object properties: isClosed: type: boolean description: Indicates if the access hours are "closed" on Saturday. openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). start: format: time type: string description: The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). 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. sunday: additionalProperties: false type: object properties: isClosed: type: boolean description: Indicates if the access hours are "closed" on Sunday. openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). start: format: time type: string description: The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). 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. thursday: additionalProperties: false type: object properties: isClosed: type: boolean description: Indicates if the access hours are "closed" on Thursday. openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). start: format: time type: string description: The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). 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. tuesday: additionalProperties: false type: object properties: isClosed: type: boolean description: Indicates if the access hours are "closed" on Tuesday. openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). start: format: time type: string description: The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). 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. wednesday: additionalProperties: false type: object properties: isClosed: type: boolean description: Indicates if the access hours are "closed" on Wednesday. openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). start: format: time type: string description: The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). 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. 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.' additionalHoursText: minLength: 0 maxLength: 255 type: string description: Additional information about hours that does not fit in **`hours`** (e.g., `"Closed during the winter"`) addressHidden: type: boolean description: If `true`, the entity's street address will not be shown on listings. Defaults to `false`. 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' uniqueItems: true type: array items: minLength: 0 maxLength: 100 type: string description: ' Cannot Include: * HTML markup' 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.' 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.' 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.' androidAppUrl: minLength: 0 type: string description: The URL where consumers can download the entity's Android app 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. ' uniqueItems: true type: array items: required: - category - quickLinkUrl - appName additionalProperties: false type: object properties: appName: minLength: 0 maxLength: 18 type: string appStoreUrl: minLength: 0 maxLength: 2000 format: uri type: string 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 quickLinkUrl: minLength: 0 maxLength: 2000 format: uri type: string appleBusinessDescription: minLength: 0 maxLength: 500 type: string description: The business description to be sent to Apple appleBusinessId: minLength: 0 pattern: ^\d*\.?\d*$ type: string description: The ID associated with an individual Business Folder in your Apple account appleCompanyId: minLength: 0 pattern: ^\d*\.?\d*$ type: string description: The ID associated with your Apple account. Numerical values only 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. ' properties: alternateText: minLength: 0 type: string url: minLength: 0 format: uri type: string appleDisplayName: minLength: 0 maxLength: 5000 type: string description: "The name to be displayed on Apple for the entity.\nNOTE: The names of Brands and their respective Locations within an Apple Business Connect Account must match identically.\nCannot Include:\nHTML markup \n\n\nCannot Include:\n* HTML markup" 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' uniqueItems: true type: array items: minLength: 0 maxLength: 100 type: string description: ' Cannot Include: * HTML markup' attire: enum: - UNSPECIFIED - DRESSY - CASUAL - FORMAL type: string description: The formality of clothing typically worn at this restaurant 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. ' uniqueItems: true type: array items: minLength: 0 type: string 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. description: Information about the Bio Content Lists associated with this entity 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' uniqueItems: true type: array items: minLength: 0 maxLength: 100 type: string description: ' Cannot Include: * HTML markup' 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. openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). start: format: time type: string description: The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). 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. 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. ' 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' isClosed: type: boolean description: Indicates if the brunch hours are "closed" on on the given date. 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. openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). start: format: time type: string description: The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). description: Contains the time intervals for which the Entity is open on the specified date. monday: additionalProperties: false type: object properties: isClosed: type: boolean description: Indicates if the brunch hours are "closed" on Monday. openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). start: format: time type: string description: The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). 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. reopenDate: format: date type: string description: ' Date must be on or after 1970-01-01 Date must be before or on 2038-01-01' saturday: additionalProperties: false type: object properties: isClosed: type: boolean description: Indicates if the brunch hours are "closed" on Saturday. openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). start: format: time type: string description: The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). 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. sunday: additionalProperties: false type: object properties: isClosed: type: boolean description: Indicates if the brunch hours are "closed" on Sunday. openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). start: format: time type: string description: The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). 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. thursday: additionalProperties: false type: object properties: isClosed: type: boolean description: Indicates if the brunch hours are "closed" on Thursday. openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). start: format: time type: string description: The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). 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. tuesday: additionalProperties: false type: object properties: isClosed: type: boolean description: Indicates if the brunch hours are "closed" on Tuesday. openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). start: format: time type: string description: The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). 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. wednesday: additionalProperties: false type: object properties: isClosed: type: boolean description: Indicates if the brunch hours are "closed" on Wednesday. openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). start: format: time type: string description: The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). 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. 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.' 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. ' uniqueItems: true type: array items: minLength: 0 type: string 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. description: Information about the events Content Lists (Calendars) associated with this entity 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. ' categoryIds: uniqueItems: false type: array items: minLength: 0 type: string 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. ' closed: type: boolean description: Indicates whether the entity is closed 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. ' uniqueItems: true type: array items: minLength: 0 maxLength: 100 type: string 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. openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). start: format: time type: string description: The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). 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. 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. ' 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' isClosed: type: boolean description: Indicates if the delivery hours are "closed" on on the given date. 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. openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). start: format: time type: string description: The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). description: Contains the time intervals for which the Entity is delivering on the specified date. monday: additionalProperties: false type: object properties: isClosed: type: boolean description: Indicates if the delivery hours are "closed" on Monday. openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). start: format: time type: string description: The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). 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. reopenDate: format: date type: string description: ' Date must be on or after 1970-01-01 Date must be before or on 2038-01-01' saturday: additionalProperties: false type: object properties: isClosed: type: boolean description: Indicates if the delivery hours are "closed" on Saturday. openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). start: format: time type: string description: The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). 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. sunday: additionalProperties: false type: object properties: isClosed: type: boolean description: Indicates if the delivery hours are "closed" on Sunday. openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). start: format: time type: string description: The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). 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. thursday: additionalProperties: false type: object properties: isClosed: type: boolean description: Indicates if the delivery hours are "closed" on Thursday. openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). start: format: time type: string description: The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). 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. tuesday: additionalProperties: false type: object properties: isClosed: type: boolean description: Indicates if the delivery hours are "closed" on Tuesday. openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). start: format: time type: string description: The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). 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. wednesday: additionalProperties: false type: object properties: isClosed: type: boolean description: Indicates if the delivery hours are "closed" on Wednesday. openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). start: format: time type: string description: The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). 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. 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.' description: minLength: 10 maxLength: 15000 type: string description: 'A description of the entity Cannot Include: * HTML markup' displayCoordinate: additionalProperties: false type: object properties: latitude: minimum: -90 maximum: 90 type: number longitude: minimum: -180 maximum: 180 type: number description: Coordinates where the map pin for the entity should be displayed, as provided by you 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. openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). start: format: time type: string description: The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). 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. 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. ' 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' isClosed: type: boolean description: Indicates if the drive-through hours are "closed" on on the given date. 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. openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). start: format: time type: string description: The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). description: Contains the time intervals for which the Entity's drive-through is open on the specified date. monday: additionalProperties: false type: object properties: isClosed: type: boolean description: Indicates if the drive-through hours are "closed" on Monday. openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). start: format: time type: string description: The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). 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. reopenDate: format: date type: string description: ' Date must be on or after 1970-01-01 Date must be before or on 2038-01-01' saturday: additionalProperties: false type: object properties: isClosed: type: boolean description: Indicates if the drive-through hours are "closed" on Saturday. openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). start: format: time type: string description: The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). 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. sunday: additionalProperties: false type: object properties: isClosed: type: boolean description: Indicates if the drive-through hours are "closed" on Sunday. openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). start: format: time type: string description: The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). 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. thursday: additionalProperties: false type: object properties: isClosed: type: boolean description: Indicates if the drive-through hours are "closed" on Thursday. openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). start: format: time type: string description: The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). 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. tuesday: additionalProperties: false type: object properties: isClosed: type: boolean description: Indicates if the drive-through hours are "closed" on Tuesday. openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). start: format: time type: string description: The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). 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. wednesday: additionalProperties: false type: object properties: isClosed: type: boolean description: Indicates if the drive-through hours are "closed" on Wednesday. openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). start: format: time type: string description: The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). 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. 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.' dropoffCoordinate: additionalProperties: false type: object properties: latitude: minimum: -90 maximum: 90 type: number longitude: minimum: -180 maximum: 180 type: number description: Coordinates of the drop-off area for the entity, as provided by you 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. ' uniqueItems: true type: array items: minLength: 0 format: email type: string facebookAbout: minLength: 0 maxLength: 255 type: string description: A description of the entity to be used in the "About You" section on Facebook 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 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.' 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' 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. ' properties: alternateText: minLength: 0 type: string url: minLength: 0 format: uri type: string 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' 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. facebookOverrideCity: minLength: 0 type: string description: The city to be displayed on this entity's Facebook profile 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.' 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 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. ' properties: alternateText: minLength: 0 type: string url: minLength: 0 format: uri type: string facebookStoreId: minLength: 0 type: string description: The Store ID used for this entity in a brand page location structure 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. 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). 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.' 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' url: minLength: 0 maxLength: 255 format: uri type: string description: Valid URL linked to the Featured Message text description: Information about the entity's Featured Message firstPartyReviewPage: minLength: 0 type: string description: Link to the review-collection page, where consumers can leave first-party reviews 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. ' uniqueItems: true type: array items: required: - question additionalProperties: false type: object properties: answer: minLength: 1 maxLength: 4096 type: string question: minLength: 1 maxLength: 4096 type: string fullyVaccinatedStaff: type: boolean description: Indicates whether the staff is vaccinated against COVID-19. geomodifier: minLength: 0 type: string description: Provides additional information on where the entity can be found (e.g., `Times Square`, `Global Center Mall`) 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.' 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 ' properties: alternateText: minLength: 0 type: string url: minLength: 0 format: uri type: string 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. ' whatsappMessagingUrl: minLength: 0 maxLength: 2000 format: uri type: string description: 'A valid URL for this entity''s WhatsApp account. Must be a valid URL ' 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.' 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' uniqueItems: true type: array items: minLength: 0 maxLength: 50 type: string description: ' Cannot Include: * HTML markup' googlePlaceId: minLength: 0 type: string description: The unique identifier of this entity on Google Maps. 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. ' properties: alternateText: minLength: 0 type: string url: minLength: 0 format: uri type: string 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.' 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. openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). start: format: time type: string description: The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). 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. 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. ' 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' isClosed: type: boolean description: Indicates if the happy hours are "closed" on on the given date. 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. openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). start: format: time type: string description: The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). description: Contains the time intervals for the Entity's happy hours on the specified date. monday: additionalProperties: false type: object properties: isClosed: type: boolean description: Indicates if the happy hours are "closed" on Monday. openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). start: format: time type: string description: The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). 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. reopenDate: format: date type: string description: ' Date must be on or after 1970-01-01 Date must be before or on 2038-01-01' saturday: additionalProperties: false type: object properties: isClosed: type: boolean description: Indicates if the happy hours are "closed" on Saturday. openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). start: format: time type: string description: The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). 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. sunday: additionalProperties: false type: object properties: isClosed: type: boolean description: Indicates if the happy hours are "closed" on Sunday. openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). start: format: time type: string description: The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). 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. thursday: additionalProperties: false type: object properties: isClosed: type: boolean description: Indicates if the happy hours are "closed" on Thursday. openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). start: format: time type: string description: The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). 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. tuesday: additionalProperties: false type: object properties: isClosed: type: boolean description: Indicates if the happy hours are "closed" on Tuesday. openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). start: format: time type: string description: The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). 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. wednesday: additionalProperties: false type: object properties: isClosed: type: boolean description: Indicates if the happy hours are "closed" on Wednesday. openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). start: format: time type: string description: The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). 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. 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.' holidayHoursConversationEnabled: type: boolean description: Indicates whether holiday-hour confirmation alerts are enabled for the Yext Knowledge Assistant for this entity 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. openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). start: format: time type: string description: The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). 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. 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. ' 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' isClosed: type: boolean description: Indicates if the hours of operation are "closed" on on the given date. 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. openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). start: format: time type: string description: The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). description: Contains the time intervals for which the Entity is open on the specified date. monday: additionalProperties: false type: object properties: isClosed: type: boolean description: Indicates if the hours of operation are "closed" on Monday. openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). start: format: time type: string description: The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). 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. reopenDate: format: date type: string description: ' Date must be on or after 1970-01-01 Date must be before or on 2038-01-01' saturday: additionalProperties: false type: object properties: isClosed: type: boolean description: Indicates if the hours of operation are "closed" on Saturday. openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). start: format: time type: string description: The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). 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. sunday: additionalProperties: false type: object properties: isClosed: type: boolean description: Indicates if the hours of operation are "closed" on Sunday. openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). start: format: time type: string description: The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). 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. thursday: additionalProperties: false type: object properties: isClosed: type: boolean description: Indicates if the hours of operation are "closed" on Thursday. openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). start: format: time type: string description: The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). 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. tuesday: additionalProperties: false type: object properties: isClosed: type: boolean description: Indicates if the hours of operation are "closed" on Tuesday. openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). start: format: time type: string description: The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). 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. wednesday: additionalProperties: false type: object properties: isClosed: type: boolean description: Indicates if the hours of operation are "closed" on Wednesday. openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). start: format: time type: string description: The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). 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. 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.' 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. instagramHandle: minLength: 0 maxLength: 30 type: string description: Valid Instagram username for the entity without the leading "@" (e.g., `NewCityAuto`) iosAppUrl: minLength: 0 type: string description: The URL where consumers can download the entity's app to their iPhone or iPad 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.' 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' uniqueItems: true type: array items: minLength: 0 maxLength: 100 type: string description: ' Cannot Include: * HTML markup' 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. openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). start: format: time type: string description: The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). 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. 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. ' 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' isClosed: type: boolean description: Indicates if the kitchen hours are "closed" on on the given date. 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. openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). start: format: time type: string description: The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). description: Contains the time intervals for which the Entity's kitchen is open on the specified date. monday: additionalProperties: false type: object properties: isClosed: type: boolean description: Indicates if the kitchen hours are "closed" on Monday. openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). start: format: time type: string description: The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). 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. reopenDate: format: date type: string description: ' Date must be on or after 1970-01-01 Date must be before or on 2038-01-01' saturday: additionalProperties: false type: object properties: isClosed: type: boolean description: Indicates if the kitchen hours are "closed" on Saturday. openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). start: format: time type: string description: The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). 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. sunday: additionalProperties: false type: object properties: isClosed: type: boolean description: Indicates if the kitchen hours are "closed" on Sunday. openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). start: format: time type: string description: The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). 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. thursday: additionalProperties: false type: object properties: isClosed: type: boolean description: Indicates if the kitchen hours are "closed" on Thursday. openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). start: format: time type: string description: The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). 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. tuesday: additionalProperties: false type: object properties: isClosed: type: boolean description: Indicates if the kitchen hours are "closed" on Tuesday. openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). start: format: time type: string description: The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). 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. wednesday: additionalProperties: false type: object properties: isClosed: type: boolean description: Indicates if the kitchen hours are "closed" on Wednesday. openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). start: format: time type: string description: The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). 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. 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.' 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.' landingPageUrl: minLength: 0 format: uri type: string description: The URL of this entity's Landing Page that was created with Yext Pages 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' uniqueItems: true type: array items: minLength: 0 maxLength: 100 type: string description: ' Cannot Include: * HTML markup' linkedInUrl: minLength: 0 format: uri type: string description: URL for your LinkedIn account, format should be https://www.linkedin.com/in/yourUsername 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. locationType: enum: - LOCATION - HEALTHCARE_FACILITY - HEALTHCARE_PROFESSIONAL - ATM - RESTAURANT - HOTEL type: string description: Indicates the entity's type, if it is not an event 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. ' properties: clickthroughUrl: minLength: 0 format: uri type: string description: minLength: 0 type: string details: minLength: 0 type: string 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. ' properties: alternateText: minLength: 0 type: string url: minLength: 0 format: uri type: string 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.' mealsServed: uniqueItems: true type: array items: enum: - BREAKFAST - LUNCH - BRUNCH - DINNER - HAPPY_HOUR - LATE_NIGHT type: string description: Types of meals served at this restaurant 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`**. 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. url: minLength: 0 maxLength: 2000 format: uri type: string description: A valid URL where consumers can view the entity's menu description: Information about the URL where consumers can view the entity's menu 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. ' uniqueItems: true type: array items: minLength: 0 type: string 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. description: Information about the Menu Content Lists associated with this entity 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.' nudgeEnabled: type: boolean description: Indicates whether Knowledge Nudge is enabled for the Yext Knowledge Assistant for this entity 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. openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). start: format: time type: string description: The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). 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. 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. ' 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' isClosed: type: boolean description: Indicates if the online service hours are "closed" on on the given date. 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. openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). start: format: time type: string description: The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). description: Contains the time intervals for the Entity's online service hours on the specified date. monday: additionalProperties: false type: object properties: isClosed: type: boolean description: Indicates if the online service hours are "closed" on Monday. openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). start: format: time type: string description: The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). 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. reopenDate: format: date type: string description: ' Date must be on or after 1970-01-01 Date must be before or on 2038-01-01' saturday: additionalProperties: false type: object properties: isClosed: type: boolean description: Indicates if the online service hours are "closed" on Saturday. openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). start: format: time type: string description: The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). 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. sunday: additionalProperties: false type: object properties: isClosed: type: boolean description: Indicates if the online service hours are "closed" on Sunday. openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). start: format: time type: string description: The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). 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. thursday: additionalProperties: false type: object properties: isClosed: type: boolean description: Indicates if the online service hours are "closed" on Thursday. openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). start: format: time type: string description: The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). 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. tuesday: additionalProperties: false type: object properties: isClosed: type: boolean description: Indicates if the online service hours are "closed" on Tuesday. openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). start: format: time type: string description: The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). 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. wednesday: additionalProperties: false type: object properties: isClosed: type: boolean description: Indicates if the online service hours are "closed" on Wednesday. openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). start: format: time type: string description: The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). 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. 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.' 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 ' 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`**. 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. url: minLength: 0 maxLength: 2000 format: uri type: string description: A valid URL used to place an order at this entity description: Information about the URL used to place orders that will be fulfilled by the entity 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: 'The payment methods accepted by this entity Valid elements depend on the entity''s country. ' 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. >' 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. ' properties: clickthroughUrl: minLength: 0 format: uri type: string description: minLength: 0 type: string details: minLength: 0 type: string 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. ' properties: alternateText: minLength: 0 type: string url: minLength: 0 format: uri type: string pickupCoordinate: additionalProperties: false type: object properties: latitude: minimum: -90 maximum: 90 type: number longitude: minimum: -180 maximum: 180 type: number description: Coordinates of where consumers can be picked up at the entity, as provided by you 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. openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). start: format: time type: string description: The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). 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. 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. ' 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' isClosed: type: boolean description: Indicates if the pickup hours are "closed" on on the given date. 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. openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). start: format: time type: string description: The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). description: Contains the time intervals for which the Entity is open for pickup on the specified date. monday: additionalProperties: false type: object properties: isClosed: type: boolean description: Indicates if the pickup hours are "closed" on Monday. openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). start: format: time type: string description: The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). 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. reopenDate: format: date type: string description: ' Date must be on or after 1970-01-01 Date must be before or on 2038-01-01' saturday: additionalProperties: false type: object properties: isClosed: type: boolean description: Indicates if the pickup hours are "closed" on Saturday. openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). start: format: time type: string description: The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). 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. sunday: additionalProperties: false type: object properties: isClosed: type: boolean description: Indicates if the pickup hours are "closed" on Sunday. openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). start: format: time type: string description: The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). 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. thursday: additionalProperties: false type: object properties: isClosed: type: boolean description: Indicates if the pickup hours are "closed" on Thursday. openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). start: format: time type: string description: The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). 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. tuesday: additionalProperties: false type: object properties: isClosed: type: boolean description: Indicates if the pickup hours are "closed" on Tuesday. openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). start: format: time type: string description: The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). 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. wednesday: additionalProperties: false type: object properties: isClosed: type: boolean description: Indicates if the pickup hours are "closed" on Wednesday. openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). start: format: time type: string description: The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). 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. 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.' pinterestUrl: minLength: 0 format: uri type: string description: URL for your Pinterest account, format should be https://www.pinterest.com/yourUsername 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) primaryConversationContact: minLength: 0 type: string description: ID of the user who is the primary Knowledge Assistant contact for the entity 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. ' uniqueItems: true type: array items: minLength: 0 type: string 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. description: Information about the Products & Services Content Lists associated with this entity questionsAndAnswers: type: boolean description: Indicates whether Yext Knowledge Assistant question-and-answer conversations are enabled for this entity 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. ' 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' 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.' rankTrackingEnabled: type: boolean description: Indicates whether Rank Tracking is enabled rankTrackingFrequency: enum: - WEEKLY - MONTHLY - QUARTERLY type: string description: How often we send search queries to track your search performance rankTrackingKeywords: description: 'The keywords for which you would like to track your search performance ' uniqueItems: true type: array items: enum: - NAME - PRIMARY_CATEGORY - SECONDARY_CATEGORY type: string 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. ' uniqueItems: true type: array items: enum: - KEYWORD - KEYWORD_ZIP - KEYWORD_CITY - KEYWORD_IN_CITY - KEYWORD_NEAR_ME - KEYWORD_CITY_STATE type: string rankTrackingSites: uniqueItems: true type: array items: enum: - GOOGLE_DESKTOP - GOOGLE_MOBILE - BING_DESKTOP - BING_MOBILE - YAHOO_DESKTOP - YAHOO_MOBILE type: string description: The search engines that we will use to track your performance 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`**.' 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. url: minLength: 0 maxLength: 2000 format: uri type: string description: A valid URL used to make reservations at this entity description: Information about the URL consumers can visit to make reservations at this entity reviewGenerationUrl: minLength: 0 type: string description: The URL given Review Invitation emails where consumers can leave a review about the entity reviewResponseConversationEnabled: type: boolean description: Indicates whether Yext Knowledge Assistant review-response conversations are enabled for this entity routableCoordinate: additionalProperties: false type: object properties: latitude: minimum: -90 maximum: 90 type: number longitude: minimum: -180 maximum: 180 type: number description: Destination coordinates to use for driving directions to the entity, as provided by you 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. openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). start: format: time type: string description: The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). 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. 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. ' 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' isClosed: type: boolean description: Indicates if the senior hours are "closed" on on the given date. 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. openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). start: format: time type: string description: The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). description: Contains the time intervals for the Entity's senior hours on the specified date. monday: additionalProperties: false type: object properties: isClosed: type: boolean description: Indicates if the senior hours are "closed" on Monday. openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). start: format: time type: string description: The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). 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. reopenDate: format: date type: string description: ' Date must be on or after 1970-01-01 Date must be before or on 2038-01-01' saturday: additionalProperties: false type: object properties: isClosed: type: boolean description: Indicates if the senior hours are "closed" on Saturday. openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). start: format: time type: string description: The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). 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. sunday: additionalProperties: false type: object properties: isClosed: type: boolean description: Indicates if the senior hours are "closed" on Sunday. openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). start: format: time type: string description: The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). 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. thursday: additionalProperties: false type: object properties: isClosed: type: boolean description: Indicates if the senior hours are "closed" on Thursday. openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). start: format: time type: string description: The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). 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. tuesday: additionalProperties: false type: object properties: isClosed: type: boolean description: Indicates if the senior hours are "closed" on Tuesday. openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). start: format: time type: string description: The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). 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. wednesday: additionalProperties: false type: object properties: isClosed: type: boolean description: Indicates if the senior hours are "closed" on Wednesday. openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). start: format: time type: string description: The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). 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. 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.' serviceArea: additionalProperties: false type: object properties: places: description: "A list of places served by the entity, where each place is either:\n - a postal code, or\n - the name of a city.\n\n\n\nArray must be ordered.\n\nArray may have a maximum of 200 elements.\n" uniqueItems: true type: array items: minLength: 0 maxLength: 100 type: string 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.' 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. ' uniqueItems: true type: array items: additionalProperties: false type: object properties: name: minLength: 0 maxLength: 100 type: string googlePlaceId: minLength: 0 type: string type: enum: - POSTAL_CODE - REGION - COUNTY - CITY - SUBLOCALITY type: string 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' uniqueItems: true type: array items: minLength: 0 maxLength: 100 type: string description: ' Cannot Include: * HTML markup' 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' uniqueItems: true type: array items: minLength: 0 maxLength: 100 type: string description: ' Cannot Include: * HTML markup' 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. openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). start: format: time type: string description: The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). 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. 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. ' 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' isClosed: type: boolean description: Indicates if the takeout hours are "closed" on on the given date. 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. openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). start: format: time type: string description: The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). description: Contains the time intervals for which the Entity is open for takeout on the specified date. monday: additionalProperties: false type: object properties: isClosed: type: boolean description: Indicates if the takeout hours are "closed" on Monday. openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). start: format: time type: string description: The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). 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. reopenDate: format: date type: string description: ' Date must be on or after 1970-01-01 Date must be before or on 2038-01-01' saturday: additionalProperties: false type: object properties: isClosed: type: boolean description: Indicates if the takeout hours are "closed" on Saturday. openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). start: format: time type: string description: The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). 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. sunday: additionalProperties: false type: object properties: isClosed: type: boolean description: Indicates if the takeout hours are "closed" on Sunday. openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). start: format: time type: string description: The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). 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. thursday: additionalProperties: false type: object properties: isClosed: type: boolean description: Indicates if the takeout hours are "closed" on Thursday. openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). start: format: time type: string description: The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). 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. tuesday: additionalProperties: false type: object properties: isClosed: type: boolean description: Indicates if the takeout hours are "closed" on Tuesday. openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). start: format: time type: string description: The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). 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. wednesday: additionalProperties: false type: object properties: isClosed: type: boolean description: Indicates if the takeout hours are "closed" on Wednesday. openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). start: format: time type: string description: The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). 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. 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.' tikTokUrl: minLength: 0 format: uri type: string description: URL for your TikTok profile, format should be https://www.tiktok.com/yourUsername 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"` 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.' 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.' 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.' 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.' 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`.' 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 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`**.' 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`**.' 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`**.' description: Information about the call-to-action consumers will see in the Uber app during a trip to your entity 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. ' uniqueItems: true type: array items: required: - video additionalProperties: false type: object properties: description: minLength: 0 maxLength: 140 type: string description: ' Cannot Include: * HTML markup' video: required: - url additionalProperties: false type: object properties: url: minLength: 0 format: uri type: string walkableCoordinate: additionalProperties: false type: object properties: latitude: minimum: -90 maximum: 90 type: number longitude: minimum: -180 maximum: 180 type: number description: Destination coordinates to use for walking directions to the entity, as provided by you 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`**.' 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. url: minLength: 0 maxLength: 2000 format: uri type: string description: A valid URL for this entity's website description: Information about the website for this entity yearEstablished: multipleOf: 1 minimum: 1000 maximum: 2028 type: number description: The year the entity was established. youTubeChannelUrl: minLength: 0 format: uri type: string description: URL for your YouTube channel, format should be https://www.youtube.com/c/yourUsername Attachment: type: object description: Attachment on a Comment on a Suggestion properties: name: description: 'The name of the file. ' type: string downloadUrl: description: 'The download URL of the file. ' type: string HotelWrite: allOf: - $ref: '#/components/schemas/EntityWrite' - additionalProperties: false type: object properties: meta: additionalProperties: false type: object properties: countryCode: minLength: 0 type: string description: Country code of this Entity's Language Profile (defaults to the country of the account) folderId: minLength: 0 type: string description: The ID of the folder containing this Entity id: minLength: 0 type: string description: ID of this Entity labels: uniqueItems: false type: array items: minLength: 0 type: string description: This Entity's labels. If the **`v`** parameter is before `20211215`, this will be an integer. language: minLength: 0 type: string description: Language code of this Entity's Language Profile (defaults to the language code of the account) description: Contains the metadata about the entity. name: minLength: 0 maxLength: 5000 type: string description: ' Cannot Include: * HTML markup' 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' countryCode: minLength: 0 pattern: ^[a-zA-Z]{2}$ type: string 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`).' line1: minLength: 0 maxLength: 255 type: string description: ' Cannot Include: * a URL or domain name' line2: minLength: 0 maxLength: 255 type: string description: ' Cannot Include: * a URL or domain name' 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' region: minLength: 0 maxLength: 255 type: string description: 'The name of the entity''s region or state. Cannot Include: * a URL or domain name' sublocality: minLength: 0 maxLength: 255 type: string description: 'The name of the entity''s sublocality Cannot Include: * a URL or domain name' 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.' 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. openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). start: format: time type: string description: The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). 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. 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. ' 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' isClosed: type: boolean description: Indicates if the access hours are "closed" on on the given date. 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. openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). start: format: time type: string description: The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). description: Contains the time intervals for which the Entity is open on the specified date. monday: additionalProperties: false type: object properties: isClosed: type: boolean description: Indicates if the access hours are "closed" on Monday. openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). start: format: time type: string description: The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). 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. reopenDate: format: date type: string description: ' Date must be on or after 1970-01-01 Date must be before or on 2038-01-01' saturday: additionalProperties: false type: object properties: isClosed: type: boolean description: Indicates if the access hours are "closed" on Saturday. openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). start: format: time type: string description: The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). 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. sunday: additionalProperties: false type: object properties: isClosed: type: boolean description: Indicates if the access hours are "closed" on Sunday. openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). start: format: time type: string description: The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). 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. thursday: additionalProperties: false type: object properties: isClosed: type: boolean description: Indicates if the access hours are "closed" on Thursday. openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). start: format: time type: string description: The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). 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. tuesday: additionalProperties: false type: object properties: isClosed: type: boolean description: Indicates if the access hours are "closed" on Tuesday. openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). start: format: time type: string description: The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). 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. wednesday: additionalProperties: false type: object properties: isClosed: type: boolean description: Indicates if the access hours are "closed" on Wednesday. openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). start: format: time type: string description: The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). 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. 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.' additionalHoursText: minLength: 0 maxLength: 255 type: string description: Additional information about hours that does not fit in **`hours`** (e.g., `"Closed during the winter"`) addressHidden: type: boolean description: If `true`, the entity's street address will not be shown on listings. Defaults to `false`. adultPool: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: Indicates whether the entity has a pool for adults only. 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. 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. allInclusive: enum: - ALL_INCLUSIVE_RATES_AVAILABLE - ALL_INCLUSIVE_RATES_ONLY - NOT_APPLICABLE type: string description: Indicates whether the entity offers all-inclusive rates. 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' uniqueItems: true type: array items: minLength: 0 maxLength: 100 type: string description: ' Cannot Include: * HTML markup' 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.' 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.' 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.' androidAppUrl: minLength: 0 type: string description: The URL where consumers can download the entity's Android app 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. ' uniqueItems: true type: array items: required: - category - quickLinkUrl - appName additionalProperties: false type: object properties: appName: minLength: 0 maxLength: 18 type: string appStoreUrl: minLength: 0 maxLength: 2000 format: uri type: string 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 quickLinkUrl: minLength: 0 maxLength: 2000 format: uri type: string appleBusinessDescription: minLength: 0 maxLength: 500 type: string description: The business description to be sent to Apple appleBusinessId: minLength: 0 pattern: ^\d*\.?\d*$ type: string description: The ID associated with an individual Business Folder in your Apple account appleCompanyId: minLength: 0 pattern: ^\d*\.?\d*$ type: string description: The ID associated with your Apple account. Numerical values only 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. ' properties: alternateText: minLength: 0 type: string url: minLength: 0 format: uri type: string appleDisplayName: minLength: 0 maxLength: 5000 type: string description: "The name to be displayed on Apple for the entity.\nNOTE: The names of Brands and their respective Locations within an Apple Business Connect Account must match identically.\nCannot Include:\nHTML markup \n\n\nCannot Include:\n* HTML markup" 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' uniqueItems: true type: array items: minLength: 0 maxLength: 100 type: string description: ' Cannot Include: * HTML markup' babysittingOffered: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: Indicates whether the entity offers babysitting. baggageStorage: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: Indicates whether the entity offers baggage storage pre check-in and post check-out. bar: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: Indicates whether the entity has an indoor or outdoor bar onsite. beachAccess: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: Indicates whether the entity has access to a beach. beachFrontProperty: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: Indicates whether the entity is physically located next to a beach. bicycles: enum: - BICYCLE_RENTALS - BICYCLE_RENTALS_FOR_FREE - NOT_APPLICABLE type: string description: Indicates whether the entity offers bicycles for rent or for free. 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. ' uniqueItems: true type: array items: minLength: 0 type: string 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. description: Information about the Bio Content Lists associated with this entity 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. 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' uniqueItems: true type: array items: minLength: 0 maxLength: 100 type: string description: ' Cannot Include: * HTML markup' breakfast: enum: - BREAKFAST_AVAILABLE - BREAKFAST_AVAILABLE_FOR_FREE - NOT_APPLICABLE type: string description: Indicates whether the entity offers breakfast. 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. openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). start: format: time type: string description: The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). 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. 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. ' 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' isClosed: type: boolean description: Indicates if the brunch hours are "closed" on on the given date. 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. openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). start: format: time type: string description: The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). description: Contains the time intervals for which the Entity is open on the specified date. monday: additionalProperties: false type: object properties: isClosed: type: boolean description: Indicates if the brunch hours are "closed" on Monday. openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). start: format: time type: string description: The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). 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. reopenDate: format: date type: string description: ' Date must be on or after 1970-01-01 Date must be before or on 2038-01-01' saturday: additionalProperties: false type: object properties: isClosed: type: boolean description: Indicates if the brunch hours are "closed" on Saturday. openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). start: format: time type: string description: The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). 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. sunday: additionalProperties: false type: object properties: isClosed: type: boolean description: Indicates if the brunch hours are "closed" on Sunday. openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). start: format: time type: string description: The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). 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. thursday: additionalProperties: false type: object properties: isClosed: type: boolean description: Indicates if the brunch hours are "closed" on Thursday. openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). start: format: time type: string description: The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). 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. tuesday: additionalProperties: false type: object properties: isClosed: type: boolean description: Indicates if the brunch hours are "closed" on Tuesday. openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). start: format: time type: string description: The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). 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. wednesday: additionalProperties: false type: object properties: isClosed: type: boolean description: Indicates if the brunch hours are "closed" on Wednesday. openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). start: format: time type: string description: The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). 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. 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.' businessCenter: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: Indicates whether the entity has a business center. 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. ' uniqueItems: true type: array items: minLength: 0 type: string 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. description: Information about the events Content Lists (Calendars) associated with this entity carRental: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: Indicates whether the entity offers car rental. casino: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: Indicates whether the entity has a casino on premise or nearby. 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. ' categoryIds: uniqueItems: false type: array items: minLength: 0 type: string 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. ' catsAllowed: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: Indicates if the entity is cat friendly. checkInTime: format: time type: string description: The check-in time checkOutTime: format: time type: string description: The check-out time classificationRating: pattern: ^\d*\.?\d*$ type: string description: The 1 to 5 star rating of the entitiy based on its services and facilities. closed: type: boolean description: Indicates whether the entity is closed concierge: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: Indicates whether the entity offers concierge service. convenienceStore: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: Indicates whether the entity has a convenience store. currencyExchange: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: Indicates whether the entity offers currency exchange services. 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. ' uniqueItems: true type: array items: minLength: 0 maxLength: 100 type: string description: minLength: 10 maxLength: 15000 type: string description: 'A description of the entity Cannot Include: * HTML markup' displayCoordinate: additionalProperties: false type: object properties: latitude: minimum: -90 maximum: 90 type: number longitude: minimum: -180 maximum: 180 type: number description: Coordinates where the map pin for the entity should be displayed, as provided by you doctorOnCall: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: Indicates whether the entity has a doctor on premise or on call. dogsAllowed: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: Indicates if the entity is dog friendly. dropoffCoordinate: additionalProperties: false type: object properties: latitude: minimum: -90 maximum: 90 type: number longitude: minimum: -180 maximum: 180 type: number description: Coordinates of the drop-off area for the entity, as provided by you electricChargingStation: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: Indicates whether the entity has electric car chargine stations on premise. elevator: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: Indicates whether the entity has an elevator. ellipticalMachine: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: Indicates whether the entity has an elliptical machine. 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. ' uniqueItems: true type: array items: minLength: 0 format: email type: string facebookAbout: minLength: 0 maxLength: 255 type: string description: A description of the entity to be used in the "About You" section on Facebook 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 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.' 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' 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. ' properties: alternateText: minLength: 0 type: string url: minLength: 0 format: uri type: string 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' 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. facebookOverrideCity: minLength: 0 type: string description: The city to be displayed on this entity's Facebook profile 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.' 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 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. ' properties: alternateText: minLength: 0 type: string url: minLength: 0 format: uri type: string facebookStoreId: minLength: 0 type: string description: The Store ID used for this entity in a brand page location structure 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. 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). 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.' 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' url: minLength: 0 maxLength: 255 format: uri type: string description: Valid URL linked to the Featured Message text description: Information about the entity's Featured Message firstPartyReviewPage: minLength: 0 type: string description: Link to the review-collection page, where consumers can leave first-party reviews fitnessCenter: enum: - FITNESS_CENTER_AVAILABLE - FITNESS_CENTER_AVAILABLE_FOR_FREE - NOT_APPLICABLE type: string description: Indicates whether the entity has a fitness center. floorCount: multipleOf: 1 minimum: 0 type: number description: The number of floors the entity has from ground floor to top floor. freeWeights: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: Indicates whether the entity has free weights. 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. ' uniqueItems: true type: array items: required: - question additionalProperties: false type: object properties: answer: minLength: 1 maxLength: 4096 type: string question: minLength: 1 maxLength: 4096 type: string frontDesk: enum: - FRONT_DESK_AVAILABLE - FRONT_DESK_AVAILABLE_24_HOURS - NOT_APPLICABLE type: string description: Indicates whether the entity has a front desk. fullyVaccinatedStaff: type: boolean description: Indicates whether the staff is vaccinated against COVID-19. gameRoom: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: Indicates whether the entity has a game room. geomodifier: minLength: 0 type: string description: Provides additional information on where the entity can be found (e.g., `Times Square`, `Global Center Mall`) giftShop: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: Indicates whether the entity has a gift shop. 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. 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.' 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 ' properties: alternateText: minLength: 0 type: string url: minLength: 0 format: uri type: string 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. ' whatsappMessagingUrl: minLength: 0 maxLength: 2000 format: uri type: string description: 'A valid URL for this entity''s WhatsApp account. Must be a valid URL ' 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.' 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' uniqueItems: true type: array items: minLength: 0 maxLength: 50 type: string description: ' Cannot Include: * HTML markup' googlePlaceId: minLength: 0 type: string description: The unique identifier of this entity on Google Maps. 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. ' properties: alternateText: minLength: 0 type: string url: minLength: 0 format: uri type: string 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.' 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. openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). start: format: time type: string description: The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). 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. 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. ' 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' isClosed: type: boolean description: Indicates if the happy hours are "closed" on on the given date. 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. openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). start: format: time type: string description: The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). description: Contains the time intervals for the Entity's happy hours on the specified date. monday: additionalProperties: false type: object properties: isClosed: type: boolean description: Indicates if the happy hours are "closed" on Monday. openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). start: format: time type: string description: The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). 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. reopenDate: format: date type: string description: ' Date must be on or after 1970-01-01 Date must be before or on 2038-01-01' saturday: additionalProperties: false type: object properties: isClosed: type: boolean description: Indicates if the happy hours are "closed" on Saturday. openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). start: format: time type: string description: The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). 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. sunday: additionalProperties: false type: object properties: isClosed: type: boolean description: Indicates if the happy hours are "closed" on Sunday. openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). start: format: time type: string description: The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). 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. thursday: additionalProperties: false type: object properties: isClosed: type: boolean description: Indicates if the happy hours are "closed" on Thursday. openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). start: format: time type: string description: The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). 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. tuesday: additionalProperties: false type: object properties: isClosed: type: boolean description: Indicates if the happy hours are "closed" on Tuesday. openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). start: format: time type: string description: The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). 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. wednesday: additionalProperties: false type: object properties: isClosed: type: boolean description: Indicates if the happy hours are "closed" on Wednesday. openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). start: format: time type: string description: The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). 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. 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.' holidayHoursConversationEnabled: type: boolean description: Indicates whether holiday-hour confirmation alerts are enabled for the Yext Knowledge Assistant for this entity horsebackRiding: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: Indicates whether the entity offers horseback riding. hotTub: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: Indicates whether the entity has a hot tub. 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. openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). start: format: time type: string description: The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). 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. 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. ' 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' isClosed: type: boolean description: Indicates if the hours of operation are "closed" on on the given date. 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. openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). start: format: time type: string description: The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). description: Contains the time intervals for which the Entity is open on the specified date. monday: additionalProperties: false type: object properties: isClosed: type: boolean description: Indicates if the hours of operation are "closed" on Monday. openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). start: format: time type: string description: The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). 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. reopenDate: format: date type: string description: ' Date must be on or after 1970-01-01 Date must be before or on 2038-01-01' saturday: additionalProperties: false type: object properties: isClosed: type: boolean description: Indicates if the hours of operation are "closed" on Saturday. openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). start: format: time type: string description: The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). 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. sunday: additionalProperties: false type: object properties: isClosed: type: boolean description: Indicates if the hours of operation are "closed" on Sunday. openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). start: format: time type: string description: The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). 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. thursday: additionalProperties: false type: object properties: isClosed: type: boolean description: Indicates if the hours of operation are "closed" on Thursday. openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). start: format: time type: string description: The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). 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. tuesday: additionalProperties: false type: object properties: isClosed: type: boolean description: Indicates if the hours of operation are "closed" on Tuesday. openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). start: format: time type: string description: The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). 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. wednesday: additionalProperties: false type: object properties: isClosed: type: boolean description: Indicates if the hours of operation are "closed" on Wednesday. openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). start: format: time type: string description: The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). 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. 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.' housekeeping: enum: - HOUSEKEEPING_AVAILABLE - HOUSEKEEPING_AVAILABLE_DAILY - NOT_APPLICABLE type: string description: Indicates whether the entity offers housekeeping services. 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. indoorPoolCount: multipleOf: 1 minimum: 0 type: number description: A count of the number of indoor pools instagramHandle: minLength: 0 maxLength: 30 type: string description: Valid Instagram username for the entity without the leading "@" (e.g., `NewCityAuto`) iosAppUrl: minLength: 0 type: string description: The URL where consumers can download the entity's app to their iPhone or iPad 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.' 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' uniqueItems: true type: array items: minLength: 0 maxLength: 100 type: string description: ' Cannot Include: * HTML markup' kidFriendly: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: Indicates if the entity is kid friendly. kidsClub: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: Indicates if the property has a Kids Club. kidsStayFree: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: Indicates whether the entity allows kids to stay free. 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. openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). start: format: time type: string description: The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). 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. 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. ' 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' isClosed: type: boolean description: Indicates if the kitchen hours are "closed" on on the given date. 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. openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). start: format: time type: string description: The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). description: Contains the time intervals for which the Entity's kitchen is open on the specified date. monday: additionalProperties: false type: object properties: isClosed: type: boolean description: Indicates if the kitchen hours are "closed" on Monday. openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). start: format: time type: string description: The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). 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. reopenDate: format: date type: string description: ' Date must be on or after 1970-01-01 Date must be before or on 2038-01-01' saturday: additionalProperties: false type: object properties: isClosed: type: boolean description: Indicates if the kitchen hours are "closed" on Saturday. openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). start: format: time type: string description: The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). 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. sunday: additionalProperties: false type: object properties: isClosed: type: boolean description: Indicates if the kitchen hours are "closed" on Sunday. openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). start: format: time type: string description: The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). 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. thursday: additionalProperties: false type: object properties: isClosed: type: boolean description: Indicates if the kitchen hours are "closed" on Thursday. openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). start: format: time type: string description: The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). 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. tuesday: additionalProperties: false type: object properties: isClosed: type: boolean description: Indicates if the kitchen hours are "closed" on Tuesday. openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). start: format: time type: string description: The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). 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. wednesday: additionalProperties: false type: object properties: isClosed: type: boolean description: Indicates if the kitchen hours are "closed" on Wednesday. openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). start: format: time type: string description: The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). 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. 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.' 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.' landingPageUrl: minLength: 0 format: uri type: string description: The URL of this entity's Landing Page that was created with Yext Pages 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' uniqueItems: true type: array items: minLength: 0 maxLength: 100 type: string description: ' Cannot Include: * HTML markup' laundry: enum: - FULL_SERVICE - SELF_SERVICE - NOT_APPLICABLE type: string description: Indicates whether the entity offers laundry services. lazyRiver: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: Indicates if the property has a lazy river lifeguard: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: Indicates if the property has a lifeguard on duty linkedInUrl: minLength: 0 format: uri type: string description: URL for your LinkedIn account, format should be https://www.linkedin.com/in/yourUsername 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. localShuttle: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: Indicates whether the entity offers local shuttle services. locationType: enum: - LOCATION - HEALTHCARE_FACILITY - HEALTHCARE_PROFESSIONAL - ATM - RESTAURANT - HOTEL type: string description: Indicates the entity's type, if it is not an event 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. ' properties: clickthroughUrl: minLength: 0 format: uri type: string description: minLength: 0 type: string details: minLength: 0 type: string 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. ' properties: alternateText: minLength: 0 type: string url: minLength: 0 format: uri type: string 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.' massage: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: Indicates whether the entity offers massage services. 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 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 meetingRoomCount: multipleOf: 1 minimum: 0 type: number description: The number of meeting rooms the entity has. 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`**. 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. url: minLength: 0 maxLength: 2000 format: uri type: string description: A valid URL where consumers can view the entity's menu description: Information about the URL where consumers can view the entity's menu 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. ' uniqueItems: true type: array items: minLength: 0 type: string 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. description: Information about the Menu Content Lists associated with this entity 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.' mobilityAccessible: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: Indicates whether the entity is mobility/wheelchair accessible nightclub: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: Indicates whether the entity has a nightclub. nudgeEnabled: type: boolean description: Indicates whether Knowledge Nudge is enabled for the Yext Knowledge Assistant for this entity 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 ' 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`**. 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. url: minLength: 0 maxLength: 2000 format: uri type: string description: A valid URL used to place an order at this entity description: Information about the URL used to place orders that will be fulfilled by the entity outdoorPoolCount: multipleOf: 1 minimum: 0 type: number description: The number of outdoor pools the entity has. parking: enum: - PARKING_AVAILABLE - PARKING_AVAILABLE_FOR_FREE - NOT_APPLICABLE type: string description: Indicates whether the entity offers parking services. 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: 'The payment methods accepted by this entity Valid elements depend on the entity''s country. ' petsAllowed: enum: - PETS_WELCOME - PETS_WELCOME_FOR_FREE - NOT_APPLICABLE - NOT_ALLOWED type: string description: Indicates if the entity is pet friendly. 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. >' 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. ' properties: clickthroughUrl: minLength: 0 format: uri type: string description: minLength: 0 type: string details: minLength: 0 type: string 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. ' properties: alternateText: minLength: 0 type: string url: minLength: 0 format: uri type: string pickupCoordinate: additionalProperties: false type: object properties: latitude: minimum: -90 maximum: 90 type: number longitude: minimum: -180 maximum: 180 type: number description: Coordinates of where consumers can be picked up at the entity, as provided by you pinterestUrl: minLength: 0 format: uri type: string description: URL for your Pinterest account, format should be https://www.pinterest.com/yourUsername primaryConversationContact: minLength: 0 type: string description: ID of the user who is the primary Knowledge Assistant contact for the entity privateBeach: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: Indicates whether the entity has access to a private beach. privateCarService: enum: - PRIVATE_CAR_SERVICE - PRIVATE_CAR_SERVICE_FOR_FREE - NOT_APPLICABLE type: string description: Indicates whether the entity offers private car services. 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. ' uniqueItems: true type: array items: minLength: 0 type: string 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. description: Information about the Products & Services Content Lists associated with this entity questionsAndAnswers: type: boolean description: Indicates whether Yext Knowledge Assistant question-and-answer conversations are enabled for this entity 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. ' 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' 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.' rankTrackingEnabled: type: boolean description: Indicates whether Rank Tracking is enabled rankTrackingFrequency: enum: - WEEKLY - MONTHLY - QUARTERLY type: string description: How often we send search queries to track your search performance rankTrackingKeywords: description: 'The keywords for which you would like to track your search performance ' uniqueItems: true type: array items: enum: - NAME - PRIMARY_CATEGORY - SECONDARY_CATEGORY type: string 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. ' uniqueItems: true type: array items: enum: - KEYWORD - KEYWORD_ZIP - KEYWORD_CITY - KEYWORD_IN_CITY - KEYWORD_NEAR_ME - KEYWORD_CITY_STATE type: string rankTrackingSites: uniqueItems: true type: array items: enum: - GOOGLE_DESKTOP - GOOGLE_MOBILE - BING_DESKTOP - BING_MOBILE - YAHOO_DESKTOP - YAHOO_MOBILE type: string description: The search engines that we will use to track your performance 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`**.' 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. url: minLength: 0 maxLength: 2000 format: uri type: string description: A valid URL used to make reservations at this entity description: Information about the URL consumers can visit to make reservations at this entity restaurantCount: multipleOf: 1 minimum: 0 type: number description: The number of restaurants the entity has. reviewGenerationUrl: minLength: 0 type: string description: The URL given Review Invitation emails where consumers can leave a review about the entity reviewResponseConversationEnabled: type: boolean description: Indicates whether Yext Knowledge Assistant review-response conversations are enabled for this entity roomCount: multipleOf: 1 minimum: 0 type: number description: The number of rooms the entity has. roomService: enum: - ROOM_SERVICE_AVAILABLE - ROOM_SERVICE_AVAILABLE_24_HOURS - NOT_APPLICABLE type: string description: Indicates whether the entity offers room service. routableCoordinate: additionalProperties: false type: object properties: latitude: minimum: -90 maximum: 90 type: number longitude: minimum: -180 maximum: 180 type: number description: Destination coordinates to use for driving directions to the entity, as provided by you salon: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: Indicates whether the entity has a salon. sauna: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: Indicates whether the entity has a sauna. scuba: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: Indicates whether the entity offers scuba diving. selfParking: enum: - SELF_PARKING_AVAILABLE - SELF_PARKING_AVAILABLE_FOR_FREE - NOT_APPLICABLE type: string description: Indicates whether the entity offers self parking services. serviceArea: additionalProperties: false type: object properties: places: description: "A list of places served by the entity, where each place is either:\n - a postal code, or\n - the name of a city.\n\n\n\nArray must be ordered.\n\nArray may have a maximum of 200 elements.\n" uniqueItems: true type: array items: minLength: 0 maxLength: 100 type: string 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.' 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. ' uniqueItems: true type: array items: additionalProperties: false type: object properties: name: minLength: 0 maxLength: 100 type: string googlePlaceId: minLength: 0 type: string type: enum: - POSTAL_CODE - REGION - COUNTY - CITY - SUBLOCALITY type: string 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' uniqueItems: true type: array items: minLength: 0 maxLength: 100 type: string description: ' Cannot Include: * HTML markup' smokeFreeProperty: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: Indicates if the entity is smoke free. snorkeling: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: Indicates whether the entity offers snorkeling. socialHour: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: Indicates whether the entity offers a social hour. spa: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: Indicates whether the entity has a spa. tableService: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: Indicates whether the entity has a sit-down restaurant. tennis: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: Indicates whether the entity has tennis courts. thermalPool: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: Indicates whether the entity has a thermal pool. tikTokUrl: minLength: 0 format: uri type: string description: URL for your TikTok profile, format should be https://www.tiktok.com/yourUsername 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"` 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.' treadmill: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: Indicates whether the entity has a treadmill. 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.' turndownService: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: Indicates whether the entity offers turndown service. 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.' 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.' 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`.' 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 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`**.' 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`**.' 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`**.' description: Information about the call-to-action consumers will see in the Uber app during a trip to your entity valetParking: enum: - VALET_PARKING_AVAILABLE - VALET_PARKING_AVAILABLE_FOR_FREE - NOT_APPLICABLE type: string description: Indicates whether the entity offers valet parking services. vendingMachine: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: Indicates whether the entity has a vending machine. 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. ' uniqueItems: true type: array items: required: - video additionalProperties: false type: object properties: description: minLength: 0 maxLength: 140 type: string description: ' Cannot Include: * HTML markup' video: required: - url additionalProperties: false type: object properties: url: minLength: 0 format: uri type: string wadingPool: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: Indicates whether the entity has a wading pool. wakeUpCalls: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: Indicates whether the entity offers wake up call services. walkableCoordinate: additionalProperties: false type: object properties: latitude: minimum: -90 maximum: 90 type: number longitude: minimum: -180 maximum: 180 type: number description: Destination coordinates to use for walking directions to the entity, as provided by you waterPark: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: Indicates whether the entity has a water park. waterSkiing: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: Indicates whether the entity offers water skiing. watercraft: enum: - WATERCRAFT_RENTALS - WATERCRAFT_RENTALS_FOR_FREE - NOT_APPLICABLE type: string description: Indicates whether the entity offers any kind of watercrafts. waterslide: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: Indicates whether the entity has a water slide. wavePool: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: Indicates whether the entity has a wave pool. 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`**.' 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. url: minLength: 0 maxLength: 2000 format: uri type: string description: A valid URL for this entity's website description: Information about the website for this entity weightMachine: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: Indicates whether the entity has a weight machine. wheelchairAccessible: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: Indicates if the entity is wheelchair accessible. wifiAvailable: enum: - WIFI_AVAILABLE - WIFI_AVAILABLE_FOR_FREE - NOT_APPLICABLE type: string description: Indicates whether the entity has WiFi available yearEstablished: multipleOf: 1 minimum: 1000 maximum: 2028 type: number description: The year the entity was established. yearLastRenovated: multipleOf: 1 minimum: 1000 maximum: 2028 type: number description: The most recent year the entity was partially or completely renovated. youTubeChannelUrl: minLength: 0 format: uri type: string description: URL for your YouTube channel, format should be https://www.youtube.com/c/yourUsername Bio: allOf: - $ref: '#/components/schemas/BaseEcl' - type: object properties: sections: type: array description: A list of sections. items: $ref: '#/components/schemas/BioEcl_Section' Validation: type: object properties: minCharLength: type: integer description: Minimum character length. maxCharLength: type: integer description: Maximum character length. minItemCount: type: integer description: Minimum item count. maxItemCount: type: integer description: Maximum item count. minValue: type: number description: Minimum value. maxValue: type: number description: Maximum value. minDate: type: string description: Minimum date, accepted as 'YYYY-MM-DD'. maxDate: type: string description: Maximum date, accepted as 'YYYY-MM-DD'. aspectRatio: type: string description: Aspect ratio of a photo. enum: - UNCONSTRAINED - '1:1' - '4:3' - '3:2' - '5:3' - '16:9' - '3:1' - '2:3' - '5:7' - '4:5' - '4:1' minWidth: type: integer description: Minimum photo width, in pixels. minHeight: type: integer description: Minimum photo height, in pixels. entityTypes: type: array description: if **`type`** is `ENTITY_LIST`, the types of entities that the field can contain. items: $ref: '#/components/schemas/EntityTypes' richTextFormats: type: array uniqueItems: true description: if **`type`** is `RICH_TEXT`, the types of text formats that the field can contain. items: type: string enum: - bold - italics - underline - bulletedList - numberedList - hyperlink entityRelationship: type: object description: if **`type`** is `ENTITY_RELATIONSHIP`, the details/validation of the Relationship. In order to create a `TWO_WAY` Relationship with Distinct Fields, both fields must be included in the body of the single create request. properties: type: type: string enum: - ONE_WAY - TWO_WAY description: Whether the relationship type is one-way or two-way. relatedFieldId: type: string description: For two-way relationships with distinct fields, the ID of the related field. supportedDestinationEntityTypes: type: array description: For one-way relationships, the list of entity types which can be selected to be related. description: 'A Custom Field validation object, describing validation rules when a Custom Field value is set or updated. ' ResponseMetaWithError: allOf: - $ref: '#/components/schemas/ResponseMeta' - type: object properties: errors: type: array description: List of errors and warnings. items: $ref: '#/components/schemas/ResponseError' 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. 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' 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' EntityWrite: type: object discriminator: propertyName: EntityType mapping: atm: '#/components/schemas/AtmWrite' event: '#/components/schemas/EventWrite' faq: '#/components/schemas/FaqWrite' financialProfessional: '#/components/schemas/FinancialProfessionalWrite' healthcareFacility: '#/components/schemas/HealthcareFacilityWrite' healthcareProfessional: '#/components/schemas/HealthcareProfessionalWrite' helpArticle: '#/components/schemas/HelpArticleWrite' hotel: '#/components/schemas/HotelWrite' hotelRoomType: '#/components/schemas/HotelRoomTypeWrite' job: '#/components/schemas/JobWrite' location: '#/components/schemas/LocationWrite' organization: '#/components/schemas/OrganizationWrite' product: '#/components/schemas/ProductWrite' restaurant: '#/components/schemas/RestaurantWrite' properties: EntityType: description: '**This is used only to filter the fields below and should NOT be included in any API calls. If create, specify the entity type in the query parameter. If update, specify the entity type in the request body in the `meta` object.** ' type: string JobWrite: allOf: - $ref: '#/components/schemas/EntityWrite' - additionalProperties: false type: object properties: meta: additionalProperties: false type: object properties: countryCode: minLength: 0 type: string description: Country code of this Entity's Language Profile (defaults to the country of the account) folderId: minLength: 0 type: string description: The ID of the folder containing this Entity id: minLength: 0 type: string description: ID of this Entity labels: uniqueItems: false type: array items: minLength: 0 type: string description: This Entity's labels. If the **`v`** parameter is before `20211215`, this will be an integer. language: minLength: 0 type: string description: Language code of this Entity's Language Profile (defaults to the language code of the account) description: Contains the metadata about the entity. name: minLength: 0 maxLength: 5000 type: string description: ' Cannot Include: * HTML markup' applicationUrl: minLength: 0 format: uri type: string description: The application URL datePosted: format: date type: string description: The date this entity was posted description: minLength: 10 maxLength: 15000 type: string description: 'A description of the entity Cannot Include: * HTML markup' displayCoordinate: additionalProperties: false type: object properties: latitude: minimum: -90 maximum: 90 type: number longitude: minimum: -180 maximum: 180 type: number description: Coordinates where the map pin for the entity should be displayed, as provided by you 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. hiringOrganization: minLength: 0 type: string description: The organization that is hiring for the open job 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' uniqueItems: true type: array items: minLength: 0 maxLength: 100 type: string description: ' Cannot Include: * HTML markup' 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.' landingPageUrl: minLength: 0 format: uri type: string description: The URL of this entity's Landing Page that was created with Yext Pages 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 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' description: The location where this job opening exists as either an existing location or an external location 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. ' properties: clickthroughUrl: minLength: 0 format: uri type: string description: minLength: 0 type: string details: minLength: 0 type: string 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. ' properties: alternateText: minLength: 0 type: string url: minLength: 0 format: uri type: string nudgeEnabled: type: boolean description: Indicates whether Knowledge Nudge is enabled for the Yext Knowledge Assistant for this entity primaryConversationContact: minLength: 0 type: string description: ID of the user who is the primary Knowledge Assistant contact for the entity 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"` validThrough: format: date-time type: string description: The date this entity is valid through. workRemote: type: boolean description: Indicates whether the job is remote. FieldUpdate: type: object required: - name properties: name: type: object description: "The Custom Field's name (including default value and translations).\n\n After March 19th 2020, if users **Update** Custom Field's name using older versions of the API without explicitly specifiying translations, any existing translations will be cleared.\n\n**Example:**\n\"name\": {\n \"value\": \"The promotions\",\n \"translations\": [\n {\n \"languageCode\": \"fr\",\n \"value\": \"Les promotions\"\n }\n ]\n}\n" properties: value: type: string description: The field's default name. translations: type: array description: Localized variations of **`value`**. items: $ref: '#/components/schemas/Translation' options: type: array description: "Present if and only if `type` is `SINGLE_OPTION` or `MULTI_OPTION`.\n\nList of options (key, value, and translations) for the Custom Field.\n\n**Example:**\n{\n {\n \"key\": \"TEMPORARILY_CLOSED\",\n \"value\": \"Temporarily Closed\"\n },\n {\n \"key\": \"COMING_SOON\",\n \"value\": \"Coming Soon\"\n },\n {\n \"key\": \"CLOSED\",\n \"value\": \"Closed\"\n \"translations\": [\n {\n \"languageCode\": \"fr\",\n \"value\": \"Fermé\"\n }\n ]\n },\n {\n \"key\": \"OPEN\",\n \"value\": \"Open\"\n }\n}\n\nThe behavior of the options' keys depends on which Custom Fields endpoint you are using:\n* Get and List: The options' keys will be included in the response.\n* Create: Do not specify option keys. They will be automatically assigned when the field is created.\n* Update: If you include an option with an existing key, the option with that key will be updated with the value you specify. If you would like to add an option, specify its value but not its key, as the key will be automatically assigned when the option is added.\n * **NOTE:** If you do not include an existing option in your Update request, it will be deleted.\n" items: $ref: '#/components/schemas/Option' group: type: string description: 'The Custom Field''s group. ' enum: - NONE - GROUP_1 - GROUP_2 - GROUP_3 - GROUP_4 - GROUP_5 - GROUP_6 - GROUP_7 - GROUP_8 - GROUP_9 - GROUP_10 - GROUP_11 - GROUP_12 - GROUP_13 - GROUP_14 - GROUP_15 - GROUP_16 - GROUP_17 - GROUP_18 - GROUP_19 - GROUP_20 - GROUP_21 - GROUP_22 - GROUP_23 - GROUP_24 - GROUP_25 - GROUP_26 - GROUP_27 - GROUP_28 - GROUP_29 - GROUP_30 default: NONE description: type: object description: "The Custom Field's description (including value and translations) which, if provided, will be shown as a tooltip next to the Custom Field in the Knowledge Manager. Providing a description is highly recommended when creating apps for the App Directory.\n\n After March 19th 2020, if users **Update** Custom Field's description using older versions of the API without explicitly specifiying translations, any existing translations will be cleared.\n\n**Example:**\n\"description\": {\n \"value\": \"This is the list of promotions\",\n \"translations\": [\n {\n \"languageCode\": \"fr\",\n \"value\": \"Ceci est la liste des promotions\"\n }\n ]\n}\n" properties: value: type: string description: The field's default description value. translations: type: array description: Localized variations of **`value`**. items: $ref: '#/components/schemas/Translation' alternateLanguageBehavior: type: string description: 'Custom Field multi-language profile behavior, which is one of: `PRIMARY_ONLY`: The Custom Field can only have a value set on its primary language profile. `OVERRIDABLE`: The Custom Field can have a value set on any alternate language profiles, which will override the primary language profile value when the alternate language profile is requested. When requested, if a value is not set for an alternate language profile, the primary language profile value will be returned. `LANGUAGE_SPECIFIC`: The Custom Field can have a value set on any alternate language profiles. When requested, if a value is not set for an alternate language profile, no value will be returned. ' default: PRIMARY_ONLY validation: $ref: '#/components/schemas/Validation' entityAvailability: type: array description: 'A list of entity types that the Custom Field is available to. ' items: $ref: '#/components/schemas/EntityTypes' Category: type: object properties: id: type: string name: type: string description: Name of the category. fullName: type: string description: The name of the Category, including parent Categories. ("Grandparent > Parent > Category") selectable: type: boolean description: Set to true if the Category is allowed to be selected by a Location. (Some Categories are too broad to apply to one Location.) parentId: type: string description: The ID of the parent category, if any. entityTypeAvailability: type: object description: 'The entity types the category is available to. ' properties: mode: type: string description: ' Possible values: * `OPT_IN` Entity types can only be opted in to this category. * `OPT_OUT` Entity types must be specifically opted out of this category. ' entityTypes: type: array description: ' List of entity types that are either opted in or opted out of the category, based on the value of **`mode`**. **Example**: If **`mode`** is `OPT_IN` and **`entityTypes`** is `“location”` then only Entities whose **`entityType`** is `location` can have the category assigned to it. If **`mode`** is `OPT_OUT` and **`entityTypes`** is `[“location”, “atm”]` then the category can be assigned to Entities of any **`entityType`** except `location` or `atm`. ' items: type: string countryAvailability: type: object description: ' The ISO 3166-1 alpha-2 codes of the countries the category is available to. In order for the category to be applied to an Entity, the Entity''s **`countryCode`** (found in its **`meta`** data) must be included in this list. ' properties: mode: type: string description: ' Possible values: * `OPT_IN` Countries can only be opted in to this category. * `OPT_OUT` Countries must be specifically opted out of this category. ' countryCodes: type: array items: type: string description: ' List of ISO 3166-1 alpha-2 codes for the countries that are either opted in or opted out of the category, based on the value of **`mode`**. **Example**: If **`mode`** is `OPT_IN` and **`countryCodes`** is `[“US”, “GB”]`, then only Entities whose **`countryCode`** is `US` or `GB` can have this category assigned to it. If **`mode`** is `OPT_OUT` and **`countryCodes`** is `[“GB”, “FR”]`, then the category can be assigned to Entities with any **`countryCode`** value except `GB` or `FR`. ' CommonEclDefinitions_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. Section: allOf: - $ref: '#/components/schemas/BaseEclSection' - type: object properties: items: type: array description: Section Items. items: $ref: '#/components/schemas/MenuItem' SuggestedContentWrite: type: object discriminator: propertyName: EntityType mapping: atm: '#/components/schemas/AtmWrite' event: '#/components/schemas/EventWrite' faq: '#/components/schemas/FaqWrite' healthcareFacility: '#/components/schemas/HealthcareFacilityWrite' healthcareProfessional: '#/components/schemas/HealthcareProfessionalWrite' hotel: '#/components/schemas/HotelWrite' job: '#/components/schemas/JobWrite' location: '#/components/schemas/LocationWrite' restaurant: '#/components/schemas/RestaurantWrite' oneOf: - $ref: '#/components/schemas/AtmWrite' - $ref: '#/components/schemas/EventWrite' - $ref: '#/components/schemas/FaqWrite' - $ref: '#/components/schemas/HealthcareFacilityWrite' - $ref: '#/components/schemas/HealthcareProfessionalWrite' - $ref: '#/components/schemas/HotelWrite' - $ref: '#/components/schemas/JobWrite' - $ref: '#/components/schemas/LocationWrite' - $ref: '#/components/schemas/RestaurantWrite' properties: EntityType: description: '**This is used only to filter the fields below and should NOT be included in any API calls.** ' type: string 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. Commenter: type: object description: Provides information about the user/system responsible for creating the comment. properties: userId: description: 'The Yext User ID of the user responsible for the comment. Only included when the commenter is a Yext User. ' type: string appId: description: 'The Yext App ID of the app responsible for the comment. Only included when the commenter is an App. ' type: string yextSource: description: "A string identifier denoting the source of the comment when a Yext system is responsible.\n\nFor now, the only valid value here will be:\n * employee\n" 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 ' 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: '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. EventEcl_Section: allOf: - $ref: '#/components/schemas/BaseEclSection' - type: object properties: items: type: array description: Section Items. items: $ref: '#/components/schemas/EventItem' AssetUsage: type: object required: - usageType properties: type: type: string description: 'The type of asset usage that is being defined. Can have one of the following values: * `ALL` * `PROFILE_FIELDS` * `REVIEW_RESPONSE` * `SOCIAL_POSTING` * `ALL_PROFILE_FIELDS` * `REVIEW_RESPONSE_GREETING` * `REVIEW_RESPONSE_VALUE_STATEMENT` * `REVIEW_RESPONSE_POSITIVE_SENTIMENT` * `REVIEW_RESPONSE_NEGATIVE_SENTIMENT` * `REVIEW_RESPONSE_CLOSING` `ALL` Indicates that the asset is available to services that use assets, including any that may be added in the future. `PROFILE_FIELDS` Indicates that the asset is available to the fields specified in the **`fieldNames`** subfield. `REVIEW_RESPONSE` Indicates that the asset can be used in responses to reviews. `SOCIAL_POSTING` Indicates that the asset can be used in social posts. `ALL_PROFILE_FIELDS` Indicates that the asset is available to all profile fields and any fields that may be added to the account in the future (e.g., custom fields). `REVIEW_RESPONSE_GREETING` Indicates that the asset can be used as a greeting in Intelligent Review Responses. `REVIEW_RESPONSE_VALUE_STATEMENT` Indicates that the asset can be used as a value statement in Intelligent Review Responses. `REVIEW_RESPONSE_POSITIVE_SENTIMENT` Indicates that the asset can be used as a positive sentiment keyword in Intelligent Review Responses. `REVIEW_RESPONSE_NEGATIVE_SENTIMENT` Indicates that the asset can be used as a negative sentiment keyword in Intelligent Review Responses. `REVIEW_RESPONSE_CLOSING` Indicates that the asset can be used as closing remarks in Intelligent Review Responses. ' fieldNames: type: array items: type: string description: 'The names of the fields the asset is available to. Only applicable if **`usageType`** is `PROFILE_FIELDS`. A field''s name in **`fieldNames`** matches its name in the API. For example, if an asset can be used for Business Name and Description, the **`fieldNames`** array will be: `[“name”, “description”]` The **`fieldNames`** value for a custom field matches its **`name`**. ' SuggestionRead: type: object properties: uid: description: 'The Yext-generated unique identifier for the Suggestion. ' type: string accountId: description: 'The ID of the account in which the Suggestion exists. ' type: string createdDate: description: 'Timestamp for when the Suggestion was created. The format is ISO 8601 standard in UTC, e.g. **`yyyy-MM-ddTHH:mm:ssZ`**. ' type: string lastUpdatedDate: description: 'Timestamp for when the Suggestion was last updated. The format is ISO 8601 standard in UTC, e.g. **`yyyy-MM-ddTHH:mm:ssZ`**. ' type: string resolvedDate: description: 'Timestamp for when the Suggestion was approved, rejected, or canceled. The format is ISO 8601 standard in UTC, e.g. **`yyyy-MM-ddTHH:mm:ssZ`**. Only included if the suggestion has been resolved. ' type: string source: $ref: '#/components/schemas/Source' entityFieldSuggestion: description: 'An object containing suggestion content and data for the entity and field the suggestion is on. ' type: object $ref: '#/components/schemas/EntityFieldSuggestionRead' status: description: 'The status of the suggestion. One of: PENDING, APPROVED, REJECTED, CANCELED. ' type: string locked: description: 'Boolean value specifying if the suggestion is locked or not. ' type: boolean assignee: $ref: '#/components/schemas/Assignee' comments: description: 'List of objects representing comments on a given Suggestion. ' type: array items: $ref: '#/components/schemas/Comment-2' approver: $ref: '#/components/schemas/Approver' Option: type: object properties: key: type: string description: 'ID that should be used when referencing the option in API calls. Note that in Locations endpoints, Custom Field options are still referenced by their numeric **`id`**, which can be obtained by calling the Custom Fields: List endpoint with a **`v`** param before `20180809`. ' value: type: string description: The option's text. translations: type: array description: Localized variations of **`value`**. items: $ref: '#/components/schemas/Translation' HealthcareFacilityWrite: allOf: - $ref: '#/components/schemas/EntityWrite' - additionalProperties: false type: object properties: meta: additionalProperties: false type: object properties: countryCode: minLength: 0 type: string description: Country code of this Entity's Language Profile (defaults to the country of the account) folderId: minLength: 0 type: string description: The ID of the folder containing this Entity id: minLength: 0 type: string description: ID of this Entity labels: uniqueItems: false type: array items: minLength: 0 type: string description: This Entity's labels. If the **`v`** parameter is before `20211215`, this will be an integer. language: minLength: 0 type: string description: Language code of this Entity's Language Profile (defaults to the language code of the account) description: Contains the metadata about the entity. name: minLength: 0 maxLength: 5000 type: string description: ' Cannot Include: * HTML markup' 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' countryCode: minLength: 0 pattern: ^[a-zA-Z]{2}$ type: string 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`).' line1: minLength: 0 maxLength: 255 type: string description: ' Cannot Include: * a URL or domain name' line2: minLength: 0 maxLength: 255 type: string description: ' Cannot Include: * a URL or domain name' 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' region: minLength: 0 maxLength: 255 type: string description: 'The name of the entity''s region or state. Cannot Include: * a URL or domain name' sublocality: minLength: 0 maxLength: 255 type: string description: 'The name of the entity''s sublocality Cannot Include: * a URL or domain name' 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.' acceptingNewPatients: type: boolean description: Indicates whether the healthcare provider is accepting new patients. 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. openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). start: format: time type: string description: The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). 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. 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. ' 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' isClosed: type: boolean description: Indicates if the access hours are "closed" on on the given date. 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. openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). start: format: time type: string description: The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). description: Contains the time intervals for which the Entity is open on the specified date. monday: additionalProperties: false type: object properties: isClosed: type: boolean description: Indicates if the access hours are "closed" on Monday. openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). start: format: time type: string description: The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). 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. reopenDate: format: date type: string description: ' Date must be on or after 1970-01-01 Date must be before or on 2038-01-01' saturday: additionalProperties: false type: object properties: isClosed: type: boolean description: Indicates if the access hours are "closed" on Saturday. openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). start: format: time type: string description: The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). 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. sunday: additionalProperties: false type: object properties: isClosed: type: boolean description: Indicates if the access hours are "closed" on Sunday. openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). start: format: time type: string description: The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). 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. thursday: additionalProperties: false type: object properties: isClosed: type: boolean description: Indicates if the access hours are "closed" on Thursday. openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). start: format: time type: string description: The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). 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. tuesday: additionalProperties: false type: object properties: isClosed: type: boolean description: Indicates if the access hours are "closed" on Tuesday. openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). start: format: time type: string description: The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). 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. wednesday: additionalProperties: false type: object properties: isClosed: type: boolean description: Indicates if the access hours are "closed" on Wednesday. openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). start: format: time type: string description: The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). 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. 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.' additionalHoursText: minLength: 0 maxLength: 255 type: string description: Additional information about hours that does not fit in **`hours`** (e.g., `"Closed during the winter"`) addressHidden: type: boolean description: If `true`, the entity's street address will not be shown on listings. Defaults to `false`. 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' uniqueItems: true type: array items: minLength: 0 maxLength: 100 type: string description: ' Cannot Include: * HTML markup' 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.' 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.' 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.' 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. ' uniqueItems: true type: array items: required: - category - quickLinkUrl - appName additionalProperties: false type: object properties: appName: minLength: 0 maxLength: 18 type: string appStoreUrl: minLength: 0 maxLength: 2000 format: uri type: string 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 quickLinkUrl: minLength: 0 maxLength: 2000 format: uri type: string appleBusinessDescription: minLength: 0 maxLength: 500 type: string description: The business description to be sent to Apple appleBusinessId: minLength: 0 pattern: ^\d*\.?\d*$ type: string description: The ID associated with an individual Business Folder in your Apple account appleCompanyId: minLength: 0 pattern: ^\d*\.?\d*$ type: string description: The ID associated with your Apple account. Numerical values only 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. ' properties: alternateText: minLength: 0 type: string url: minLength: 0 format: uri type: string appleDisplayName: minLength: 0 maxLength: 5000 type: string description: "The name to be displayed on Apple for the entity.\nNOTE: The names of Brands and their respective Locations within an Apple Business Connect Account must match identically.\nCannot Include:\nHTML markup \n\n\nCannot Include:\n* HTML markup" 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' uniqueItems: true type: array items: minLength: 0 maxLength: 100 type: string description: ' Cannot Include: * HTML markup' 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. ' uniqueItems: true type: array items: minLength: 0 type: string 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. description: Information about the Bio Content Lists associated with this entity 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' uniqueItems: true type: array items: minLength: 0 maxLength: 100 type: string description: ' Cannot Include: * HTML markup' 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. ' uniqueItems: true type: array items: minLength: 0 type: string 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. description: Information about the events Content Lists (Calendars) associated with this entity 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. ' categoryIds: uniqueItems: false type: array items: minLength: 0 type: string 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. ' closed: type: boolean description: Indicates whether the entity is closed 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' uniqueItems: true type: array items: minLength: 0 maxLength: 100 type: string description: ' Cannot Include: * HTML markup' covidMessaging: minLength: 0 maxLength: 15000 type: string description: Information or messaging related to COVID-19. covidTestAppointmentUrl: minLength: 0 format: uri type: string description: An appointment URL for scheduling a COVID-19 test. covidTestingAppointmentRequired: type: boolean description: Indicates whether an appointment is required for a COVID-19 test. covidTestingDriveThroughSite: type: boolean description: Indicates whether location is a drive-through site for COVID-19 tests. covidTestingIsFree: type: boolean description: Indicates whether location offers free COVID-19 testing. covidTestingPatientRestrictions: type: boolean description: Indicates whether there are patient restrictions for COVID-19 testing. covidTestingReferralRequired: type: boolean description: Indicates whether a referral is required for COVID-19 testing. covidTestingSiteInstructions: minLength: 0 maxLength: 15000 type: string description: Information or instructions for the COVID-19 testing site. covidVaccineAppointmentRequired: type: boolean description: Indicates whether an appointment is required for a COVID-19 vaccine. covidVaccineDriveThroughSite: type: boolean description: Indicates whether location is a drive-through site for COVID-19 vaccines. covidVaccineInformationUrl: minLength: 0 format: uri type: string description: An information URL for more information about COVID-19 vaccines. covidVaccinePatientRestrictions: type: boolean description: Indicates whether there are patient restrictions for a COVID-19 vaccine. covidVaccineReferralRequired: type: boolean description: Indicates whether a referral is required for a COVID-19 vaccine. covidVaccineSiteInstructions: minLength: 0 maxLength: 15000 type: string description: Information or instructions for the COVID-19 vaccination site. covidVaccinesOffered: uniqueItems: true type: array items: enum: - PFIZER - MODERNA - JOHNSON_&_JOHNSON type: string description: Indicates which COVID-19 vaccines the location offers. 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. ' uniqueItems: true type: array items: minLength: 0 maxLength: 100 type: string description: minLength: 10 maxLength: 15000 type: string description: 'A description of the entity Cannot Include: * HTML markup' displayCoordinate: additionalProperties: false type: object properties: latitude: minimum: -90 maximum: 90 type: number longitude: minimum: -180 maximum: 180 type: number description: Coordinates where the map pin for the entity should be displayed, as provided by you dropoffCoordinate: additionalProperties: false type: object properties: latitude: minimum: -90 maximum: 90 type: number longitude: minimum: -180 maximum: 180 type: number description: Coordinates of the drop-off area for the entity, as provided by you 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. ' uniqueItems: true type: array items: minLength: 0 format: email type: string facebookAbout: minLength: 0 maxLength: 255 type: string description: A description of the entity to be used in the "About You" section on Facebook 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 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.' 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' 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. ' properties: alternateText: minLength: 0 type: string url: minLength: 0 format: uri type: string 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' 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. facebookOverrideCity: minLength: 0 type: string description: The city to be displayed on this entity's Facebook profile 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.' 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 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. ' properties: alternateText: minLength: 0 type: string url: minLength: 0 format: uri type: string facebookStoreId: minLength: 0 type: string description: The Store ID used for this entity in a brand page location structure 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. 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). 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.' 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' url: minLength: 0 maxLength: 255 format: uri type: string description: Valid URL linked to the Featured Message text description: Information about the entity's Featured Message firstPartyReviewPage: minLength: 0 type: string description: Link to the review-collection page, where consumers can leave first-party reviews 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. ' uniqueItems: true type: array items: required: - question additionalProperties: false type: object properties: answer: minLength: 1 maxLength: 4096 type: string question: minLength: 1 maxLength: 4096 type: string fullyVaccinatedStaff: type: boolean description: Indicates whether the staff is vaccinated against COVID-19. geomodifier: minLength: 0 type: string description: Provides additional information on where the entity can be found (e.g., `Times Square`, `Global Center Mall`) 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.' 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 ' properties: alternateText: minLength: 0 type: string url: minLength: 0 format: uri type: string 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. ' whatsappMessagingUrl: minLength: 0 maxLength: 2000 format: uri type: string description: 'A valid URL for this entity''s WhatsApp account. Must be a valid URL ' 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.' 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' uniqueItems: true type: array items: minLength: 0 maxLength: 50 type: string description: ' Cannot Include: * HTML markup' googlePlaceId: minLength: 0 type: string description: The unique identifier of this entity on Google Maps. 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. ' properties: alternateText: minLength: 0 type: string url: minLength: 0 format: uri type: string 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.' holidayHoursConversationEnabled: type: boolean description: Indicates whether holiday-hour confirmation alerts are enabled for the Yext Knowledge Assistant for this entity 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. openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). start: format: time type: string description: The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). 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. 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. ' 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' isClosed: type: boolean description: Indicates if the hours of operation are "closed" on on the given date. 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. openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). start: format: time type: string description: The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). description: Contains the time intervals for which the Entity is open on the specified date. monday: additionalProperties: false type: object properties: isClosed: type: boolean description: Indicates if the hours of operation are "closed" on Monday. openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). start: format: time type: string description: The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). 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. reopenDate: format: date type: string description: ' Date must be on or after 1970-01-01 Date must be before or on 2038-01-01' saturday: additionalProperties: false type: object properties: isClosed: type: boolean description: Indicates if the hours of operation are "closed" on Saturday. openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). start: format: time type: string description: The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). 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. sunday: additionalProperties: false type: object properties: isClosed: type: boolean description: Indicates if the hours of operation are "closed" on Sunday. openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). start: format: time type: string description: The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). 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. thursday: additionalProperties: false type: object properties: isClosed: type: boolean description: Indicates if the hours of operation are "closed" on Thursday. openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). start: format: time type: string description: The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). 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. tuesday: additionalProperties: false type: object properties: isClosed: type: boolean description: Indicates if the hours of operation are "closed" on Tuesday. openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). start: format: time type: string description: The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). 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. wednesday: additionalProperties: false type: object properties: isClosed: type: boolean description: Indicates if the hours of operation are "closed" on Wednesday. openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). start: format: time type: string description: The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). 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. 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.' 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. instagramHandle: minLength: 0 maxLength: 30 type: string description: Valid Instagram username for the entity without the leading "@" (e.g., `NewCityAuto`) 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' uniqueItems: true type: array items: minLength: 0 maxLength: 100 type: string description: ' Cannot Include: * HTML markup' 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.' 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' uniqueItems: true type: array items: minLength: 0 maxLength: 100 type: string description: ' Cannot Include: * HTML markup' 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.' landingPageUrl: minLength: 0 format: uri type: string description: The URL of this entity's Landing Page that was created with Yext Pages 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' uniqueItems: true type: array items: minLength: 0 maxLength: 100 type: string description: ' Cannot Include: * HTML markup' linkedInUrl: minLength: 0 format: uri type: string description: URL for your LinkedIn account, format should be https://www.linkedin.com/in/yourUsername 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. locationType: enum: - LOCATION - HEALTHCARE_FACILITY - HEALTHCARE_PROFESSIONAL - ATM - RESTAURANT - HOTEL type: string description: Indicates the entity's type, if it is not an event 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. ' properties: clickthroughUrl: minLength: 0 format: uri type: string description: minLength: 0 type: string details: minLength: 0 type: string 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. ' properties: alternateText: minLength: 0 type: string url: minLength: 0 format: uri type: string 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.' 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`**. 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. url: minLength: 0 maxLength: 2000 format: uri type: string description: A valid URL where consumers can view the entity's menu description: Information about the URL where consumers can view the entity's menu 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.' npi: minLength: 0 type: string description: The National Provider Identifier (NPI) of the healthcare provider nudgeEnabled: type: boolean description: Indicates whether Knowledge Nudge is enabled for the Yext Knowledge Assistant for this entity 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. openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). start: format: time type: string description: The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). 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. 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. ' 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' isClosed: type: boolean description: Indicates if the online service hours are "closed" on on the given date. 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. openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). start: format: time type: string description: The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). description: Contains the time intervals for the Entity's online service hours on the specified date. monday: additionalProperties: false type: object properties: isClosed: type: boolean description: Indicates if the online service hours are "closed" on Monday. openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). start: format: time type: string description: The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). 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. reopenDate: format: date type: string description: ' Date must be on or after 1970-01-01 Date must be before or on 2038-01-01' saturday: additionalProperties: false type: object properties: isClosed: type: boolean description: Indicates if the online service hours are "closed" on Saturday. openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). start: format: time type: string description: The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). 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. sunday: additionalProperties: false type: object properties: isClosed: type: boolean description: Indicates if the online service hours are "closed" on Sunday. openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). start: format: time type: string description: The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). 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. thursday: additionalProperties: false type: object properties: isClosed: type: boolean description: Indicates if the online service hours are "closed" on Thursday. openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). start: format: time type: string description: The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). 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. tuesday: additionalProperties: false type: object properties: isClosed: type: boolean description: Indicates if the online service hours are "closed" on Tuesday. openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). start: format: time type: string description: The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). 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. wednesday: additionalProperties: false type: object properties: isClosed: type: boolean description: Indicates if the online service hours are "closed" on Wednesday. openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). start: format: time type: string description: The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). 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. 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.' 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 ' 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`**. 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. url: minLength: 0 maxLength: 2000 format: uri type: string description: A valid URL used to place an order at this entity description: Information about the URL used to place orders that will be fulfilled by the entity 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: 'The payment methods accepted by this entity Valid elements depend on the entity''s country. ' 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. >' 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. ' properties: clickthroughUrl: minLength: 0 format: uri type: string description: minLength: 0 type: string details: minLength: 0 type: string 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. ' properties: alternateText: minLength: 0 type: string url: minLength: 0 format: uri type: string pickupCoordinate: additionalProperties: false type: object properties: latitude: minimum: -90 maximum: 90 type: number longitude: minimum: -180 maximum: 180 type: number description: Coordinates of where consumers can be picked up at the entity, as provided by you 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. openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). start: format: time type: string description: The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). 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. 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. ' 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' isClosed: type: boolean description: Indicates if the pickup hours are "closed" on on the given date. 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. openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). start: format: time type: string description: The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). description: Contains the time intervals for which the Entity is open for pickup on the specified date. monday: additionalProperties: false type: object properties: isClosed: type: boolean description: Indicates if the pickup hours are "closed" on Monday. openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). start: format: time type: string description: The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). 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. reopenDate: format: date type: string description: ' Date must be on or after 1970-01-01 Date must be before or on 2038-01-01' saturday: additionalProperties: false type: object properties: isClosed: type: boolean description: Indicates if the pickup hours are "closed" on Saturday. openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). start: format: time type: string description: The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). 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. sunday: additionalProperties: false type: object properties: isClosed: type: boolean description: Indicates if the pickup hours are "closed" on Sunday. openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). start: format: time type: string description: The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). 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. thursday: additionalProperties: false type: object properties: isClosed: type: boolean description: Indicates if the pickup hours are "closed" on Thursday. openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). start: format: time type: string description: The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). 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. tuesday: additionalProperties: false type: object properties: isClosed: type: boolean description: Indicates if the pickup hours are "closed" on Tuesday. openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). start: format: time type: string description: The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). 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. wednesday: additionalProperties: false type: object properties: isClosed: type: boolean description: Indicates if the pickup hours are "closed" on Wednesday. openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). start: format: time type: string description: The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). 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. 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.' pinterestUrl: minLength: 0 format: uri type: string description: URL for your Pinterest account, format should be https://www.pinterest.com/yourUsername 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) primaryConversationContact: minLength: 0 type: string description: ID of the user who is the primary Knowledge Assistant contact for the entity 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. ' uniqueItems: true type: array items: minLength: 0 type: string 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. description: Information about the Products & Services Content Lists associated with this entity questionsAndAnswers: type: boolean description: Indicates whether Yext Knowledge Assistant question-and-answer conversations are enabled for this entity 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. ' 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' 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.' rankTrackingEnabled: type: boolean description: Indicates whether Rank Tracking is enabled rankTrackingFrequency: enum: - WEEKLY - MONTHLY - QUARTERLY type: string description: How often we send search queries to track your search performance rankTrackingKeywords: description: 'The keywords for which you would like to track your search performance ' uniqueItems: true type: array items: enum: - NAME - PRIMARY_CATEGORY - SECONDARY_CATEGORY type: string 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. ' uniqueItems: true type: array items: enum: - KEYWORD - KEYWORD_ZIP - KEYWORD_CITY - KEYWORD_IN_CITY - KEYWORD_NEAR_ME - KEYWORD_CITY_STATE type: string rankTrackingSites: uniqueItems: true type: array items: enum: - GOOGLE_DESKTOP - GOOGLE_MOBILE - BING_DESKTOP - BING_MOBILE - YAHOO_DESKTOP - YAHOO_MOBILE type: string description: The search engines that we will use to track your performance 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`**.' 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. url: minLength: 0 maxLength: 2000 format: uri type: string description: A valid URL used to make reservations at this entity description: Information about the URL consumers can visit to make reservations at this entity reviewGenerationUrl: minLength: 0 type: string description: The URL given Review Invitation emails where consumers can leave a review about the entity reviewResponseConversationEnabled: type: boolean description: Indicates whether Yext Knowledge Assistant review-response conversations are enabled for this entity routableCoordinate: additionalProperties: false type: object properties: latitude: minimum: -90 maximum: 90 type: number longitude: minimum: -180 maximum: 180 type: number description: Destination coordinates to use for driving directions to the entity, as provided by you serviceArea: additionalProperties: false type: object properties: places: description: "A list of places served by the entity, where each place is either:\n - a postal code, or\n - the name of a city.\n\n\n\nArray must be ordered.\n\nArray may have a maximum of 200 elements.\n" uniqueItems: true type: array items: minLength: 0 maxLength: 100 type: string 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.' 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. ' uniqueItems: true type: array items: additionalProperties: false type: object properties: name: minLength: 0 maxLength: 100 type: string googlePlaceId: minLength: 0 type: string type: enum: - POSTAL_CODE - REGION - COUNTY - CITY - SUBLOCALITY type: string 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' uniqueItems: true type: array items: minLength: 0 maxLength: 100 type: string description: ' Cannot Include: * HTML markup' tikTokUrl: minLength: 0 format: uri type: string description: URL for your TikTok profile, format should be https://www.tiktok.com/yourUsername 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"` 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.' 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.' 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.' 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.' 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`.' 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 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`**.' 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`**.' 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`**.' description: Information about the call-to-action consumers will see in the Uber app during a trip to your entity 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. ' uniqueItems: true type: array items: required: - video additionalProperties: false type: object properties: description: minLength: 0 maxLength: 140 type: string description: ' Cannot Include: * HTML markup' video: required: - url additionalProperties: false type: object properties: url: minLength: 0 format: uri type: string walkableCoordinate: additionalProperties: false type: object properties: latitude: minimum: -90 maximum: 90 type: number longitude: minimum: -180 maximum: 180 type: number description: Destination coordinates to use for walking directions to the entity, as provided by you 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`**.' 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. url: minLength: 0 maxLength: 2000 format: uri type: string description: A valid URL for this entity's website description: Information about the website for this entity yearEstablished: multipleOf: 1 minimum: 1000 maximum: 2028 type: number description: The year the entity was established. youTubeChannelUrl: minLength: 0 format: uri type: string description: URL for your YouTube channel, format should be https://www.youtube.com/c/yourUsername Entity-2: 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.\n\n```\nEligible For: \n * atm\n * event\n * faq\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * job\n * location\n * restaurant\n```" name: minLength: 0 maxLength: 5000 type: string description: "\n\n\nCannot Include:\n* HTML markup\n\nFiltering Type: `text`\n\n```\nEligible For: \n * atm\n * board\n * brand\n * card\n * contactCard\n * event\n * faq\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * helpArticle\n * hotel\n * hotelRoomType\n * job\n * location\n * organization\n * product\n * restaurant\n```" 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)\n\nMust be a valid address\nCannot be a P.O. Box\n\nIf the entity is an `event`, either an **`address`** value or a **`linkedLocation`** value can be provided.\n\nFiltering Type: `object`\n\n```\nEligible For: \n * atm\n * event\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * restaurant\n```" acceptingNewPatients: type: boolean description: "Indicates whether the healthcare provider is accepting new patients.\n\nFiltering Type: `boolean`\n\n```\nEligible For: \n * healthcareFacility\n * healthcareProfessional\n```" acceptsReservations: type: boolean description: "Indicates whether the entity accepts reservations.\n\nFiltering Type: `boolean`\n\n```\nEligible For: \n * restaurant\n```" 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.\n\nEach 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.\nSimilarly, holiday access hours are represented by the `holidayHours` sub-field.\nSetting the `reopenDate` sub-field indicates that the business is temporarily closed and will reopen on the specified date.\nSPECIAL CASES:\n* 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.\n* 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.\n* If you are providing `openIntervals`, you may not set `isClosed` to true for that day.\n\nFiltering Type: `hours`\n\n```\nEligible For: \n * atm\n * healthcareFacility\n * hotel\n * location\n * restaurant\n```" additionalHoursText: minLength: 0 maxLength: 255 type: string description: "Additional information about hours that does not fit in **`hours`** (e.g., `\"Closed during the winter\"`)\n\nFiltering Type: `text`\n\n```\nEligible For: \n * atm\n * contactCard\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * restaurant\n```" additionalPromotingLocations: description: "If other locations are promoting this event, a list of those locations' **`id`**s in the Yext Knowledge Manager\n\n\nArray must be ordered.\n\n\nFiltering Type: `list of entityId`\n\n```\nEligible For: \n * event\n```" 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`.\n\nFiltering Type: `boolean`\n\n```\nEligible For: \n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * restaurant\n```" admittingHospitals: description: "A list of hospitals where the healthcare professional admits patients\n\n\nArray must be ordered.\n\nArray may have a maximum of 100 elements.\n\nArray item description:\n\n>Cannot Include:\n>* HTML markup\n\nFiltering Type: `list of text`\n\n```\nEligible For: \n * healthcareProfessional\n```" 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.\n\nFiltering Type: `option`\n\n```\nEligible For: \n * hotel\n```" 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\n\nFiltering Type: `object`\n\n```\nEligible For: \n * event\n```" 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.\n\nFiltering Type: `option`\n\n```\nEligible For: \n * hotel\n```" 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.\n\nFiltering Type: `option`\n\n```\nEligible For: \n * hotel\n```" allInclusive: enum: - ALL_INCLUSIVE_RATES_AVAILABLE - ALL_INCLUSIVE_RATES_ONLY - NOT_APPLICABLE type: string description: "Indicates whether the entity offers all-inclusive rates.\n\nFiltering Type: `option`\n\n```\nEligible For: \n * hotel\n```" alternateNames: description: "Other names for your business that you would like us to use when tracking your search performance\n\n\nArray must be ordered.\n\nArray may have a maximum of 3 elements.\n\nArray item description:\n\n>Cannot Include:\n>* HTML markup\n\nFiltering Type: `list of text`\n\n```\nEligible For: \n * atm\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * organization\n * restaurant\n```" 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.\n\nIf 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.\n\nFiltering Type: `text`\n\n```\nEligible For: \n * atm\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * restaurant\n```" alternateWebsites: description: "Other websites for your business that we should search for when tracking your search performance\n\n\nArray must be ordered.\n\nArray may have a maximum of 3 elements.\n\nArray item description:\n\n>Cannot Include:\n>* common domain names, e.g., google.com, youtube.com, etc.\n\nFiltering Type: `list of text`\n\n```\nEligible For: \n * atm\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * organization\n * restaurant\n```" 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\n\nFiltering Type: `text`\n\n```\nEligible For: \n * brand\n * financialProfessional\n * hotel\n * location\n * restaurant\n```" answer: description: "The answer to the frequently asked question represented by this entity\n\n\nCharacter limit: 0 .. 15000\n\nSupported formats include:\n* BOLD\n* ITALICS\n* UNDERLINE\n* BULLETED_LIST\n* NUMBERED_LIST\n* HYPERLINK\n* IMAGE\n* CODE_SPAN\n* HEADINGS\n\n```\nEligible For: \n * faq\n```" type: string format: rich-text appleActionLinks: description: "Use this field to add action links to your Apple Listings.\n\nThe call to action category will be displayed on the action link button.\n\nThe App Store URL should contain a valid link to the landing page of an App in the Apple App Store.\n\nThe Quick Link URL is where a user is taken when an action link is clicked by a user.\n\nThe 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.\n\n\nArray must be ordered.\n\n\nFiltering Type: `list of object`\n\n```\nEligible For: \n * atm\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * restaurant\n```" 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\n\nFiltering Type: `text`\n\n```\nEligible For: \n * atm\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * restaurant\n```" appleBusinessId: minLength: 0 pattern: ^\d*\.?\d*$ type: string description: "The ID associated with an individual Business Folder in your Apple account\n\nFiltering Type: `text`\n\n```\nEligible For: \n * atm\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * restaurant\n```" appleCompanyId: minLength: 0 pattern: ^\d*\.?\d*$ type: string description: "The ID associated with your Apple account. Numerical values only\n\nFiltering Type: `text`\n\n```\nEligible For: \n * atm\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * restaurant\n```" appleCoverPhoto: required: - url additionalProperties: false type: object description: "The cover photo for the entity''s Apple profile\n\n\nImage must be at least 1600 x 1040 pixels\n\nImage may be no more than 4864 x 3163 pixels\n\nSupported Aspect Ratios:\n* 154 x 100\n\n**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.\n\n\nFiltering Type: `object`\n\n```\nEligible For: \n * atm\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * restaurant\n```" 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.\nNOTE: The names of Brands and their respective Locations within an Apple Business Connect Account must match identically.\nCannot Include:\nHTML markup \n\n\nCannot Include:\n* HTML markup\n\nFiltering Type: `text`\n\n```\nEligible For: \n * atm\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * restaurant\n```" applicationUrl: minLength: 0 format: uri type: string description: "The application URL\n\nFiltering Type: `text`\n\n```\nEligible For: \n * job\n```" associations: description: "Association memberships relevant to the entity (e.g., `\"New York Doctors Association\"`)\nAll strings must be non-empty when trimmed of whitespace.\n\n\n\nArray must be ordered.\n\nArray may have a maximum of 100 elements.\n\nArray item description:\n\n>Cannot Include:\n>* HTML markup\n\nFiltering Type: `list of text`\n\n```\nEligible For: \n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * restaurant\n```" 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.\nA `virtualLocationUrl` must be specified for online and mixed events.\n\nFiltering Type: `object`\n\n```\nEligible For: \n * event\n```" attire: enum: - UNSPECIFIED - DRESSY - CASUAL - FORMAL type: string description: "The formality of clothing typically worn at this restaurant\n\nFiltering Type: `option`\n\n```\nEligible For: \n * restaurant\n```" babysittingOffered: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: "Indicates whether the entity offers babysitting.\n\nFiltering Type: `option`\n\n```\nEligible For: \n * hotel\n```" baggageStorage: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: "Indicates whether the entity offers baggage storage pre check-in and post check-out.\n\nFiltering Type: `option`\n\n```\nEligible For: \n * hotel\n```" bar: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: "Indicates whether the entity has an indoor or outdoor bar onsite.\n\nFiltering Type: `option`\n\n```\nEligible For: \n * hotel\n```" beachAccess: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: "Indicates whether the entity has access to a beach.\n\nFiltering Type: `option`\n\n```\nEligible For: \n * hotel\n```" beachFrontProperty: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: "Indicates whether the entity is physically located next to a beach.\n\nFiltering Type: `option`\n\n```\nEligible For: \n * hotel\n```" bicycles: enum: - BICYCLE_RENTALS - BICYCLE_RENTALS_FOR_FREE - NOT_APPLICABLE type: string description: "Indicates whether the entity offers bicycles for rent or for free.\n\nFiltering Type: `option`\n\n```\nEligible For: \n * hotel\n```" 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\n\nFiltering Type: `object`\n\n```\nEligible For: \n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * organization\n * restaurant\n```" 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.\n\nFiltering Type: `option`\n\n```\nEligible For: \n * hotel\n```" brands: description: "Brands sold by this entity\nAll strings must be non-empty when trimmed of whitespace.\n\n\n\nArray must be ordered.\n\nArray may have a maximum of 100 elements.\n\nArray item description:\n\n>Cannot Include:\n>* HTML markup\n\nFiltering Type: `list of text`\n\n```\nEligible For: \n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * restaurant\n```" 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.\n\nFiltering Type: `option`\n\n```\nEligible For: \n * hotel\n```" 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.\n\nEach 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.\nSimilarly, holiday brunch hours are represented by the `holidayHours` sub-field.\nSetting the `reopenDate` sub-field indicates that the business is temporarily closed and will reopen on the specified date.\nSPECIAL CASES:\n* 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.\n* 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.\n* If you are providing `openIntervals`, you may not set `isClosed` to true for that day.\n\nFiltering Type: `hours`\n\n```\nEligible For: \n * hotel\n * location\n * restaurant\n```" businessCenter: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: "Indicates whether the entity has a business center.\n\nFiltering Type: `option`\n\n```\nEligible For: \n * hotel\n```" 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\n\nFiltering Type: `object`\n\n```\nEligible For: \n * financialProfessional\n * healthcareFacility\n * hotel\n * location\n * restaurant\n```" carRental: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: "Indicates whether the entity offers car rental.\n\nFiltering Type: `option`\n\n```\nEligible For: \n * hotel\n```" casino: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: "Indicates whether the entity has a casino on premise or nearby.\n\nFiltering Type: `option`\n\n```\nEligible For: \n * hotel\n```" categories: additionalProperties: false type: object properties: {} description: "Yext Categories. (Supported for versions > 20240220)\n\nA map of category list external IDs (i.e. \"yext\") to a list of category IDs.\n\nIDs must be valid and selectable (i.e., cannot be parent categories).\n\nPartial updates are accepted, meaning sending only the \"yext\" property will have no effect on any category list except the \"yext\" category. \n\nFiltering Type: `object`\n\n```\nEligible For: \n * atm\n * event\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * restaurant\n```" categoryIds: uniqueItems: false type: array items: minLength: 0 type: string description: 'Filtering Type: `text`' description: "Yext Category IDs. (Deprecated: For versions > 20240220)\n\nIDs must be valid and selectable (i.e., cannot be parent categories).\n\nNOTE: 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.\n\n\nFiltering Type: `list of text`\n\n```\nEligible For: \n * atm\n * event\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * restaurant\n```" catsAllowed: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: "Indicates if the entity is cat friendly.\n\nFiltering Type: `option`\n\n```\nEligible For: \n * hotel\n```" certifications: description: "A list of the certifications held by the healthcare professional\n**NOTE:** This field is only available to locations whose **`entityType`** is `healthcareProfessional`.\n\n\n\nArray must be ordered.\n\nArray may have a maximum of 100 elements.\n\nArray item description:\n\n>Cannot Include:\n>* HTML markup\n\nFiltering Type: `list of text`\n\n```\nEligible For: \n * financialProfessional\n * healthcareProfessional\n```" 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\n\nFiltering Type: `time`\n\n```\nEligible For: \n * hotel\n```" checkOutTime: format: time type: string description: "The check-out time\n\nFiltering Type: `time`\n\n```\nEligible For: \n * hotel\n```" classificationRating: pattern: ^\d*\.?\d*$ type: string description: "The 1 to 5 star rating of the entitiy based on its services and facilities.\n\nFiltering Type: `decimal`\n\n```\nEligible For: \n * hotel\n```" closed: type: boolean description: "Indicates whether the entity is closed\n\nFiltering Type: `boolean`\n\n```\nEligible For: \n * atm\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * restaurant\n```" concierge: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: "Indicates whether the entity offers concierge service.\n\nFiltering Type: `option`\n\n```\nEligible For: \n * hotel\n```" conditionsTreated: description: "A list of the conditions treated by the healthcare provider\n\n\nArray must be ordered.\n\nArray may have a maximum of 100 elements.\n\nArray item description:\n\n>Cannot Include:\n>* HTML markup\n\nFiltering Type: `list of text`\n\n```\nEligible For: \n * healthcareFacility\n * healthcareProfessional\n```" 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.\n\nFiltering Type: `option`\n\n```\nEligible For: \n * hotel\n```" covidMessaging: minLength: 0 maxLength: 15000 type: string description: "Information or messaging related to COVID-19.\n\nFiltering Type: `text`\n\n```\nEligible For: \n * healthcareFacility\n * healthcareProfessional\n * location\n```" covidTestAppointmentUrl: minLength: 0 format: uri type: string description: "An appointment URL for scheduling a COVID-19 test.\n\nFiltering Type: `text`\n\n```\nEligible For: \n * healthcareFacility\n * location\n```" covidTestingAppointmentRequired: type: boolean description: "Indicates whether an appointment is required for a COVID-19 test.\n\nFiltering Type: `boolean`\n\n```\nEligible For: \n * healthcareFacility\n * location\n```" covidTestingDriveThroughSite: type: boolean description: "Indicates whether location is a drive-through site for COVID-19 tests.\n\nFiltering Type: `boolean`\n\n```\nEligible For: \n * healthcareFacility\n * location\n```" covidTestingIsFree: type: boolean description: "Indicates whether location offers free COVID-19 testing.\n\nFiltering Type: `boolean`\n\n```\nEligible For: \n * healthcareFacility\n * location\n```" covidTestingPatientRestrictions: type: boolean description: "Indicates whether there are patient restrictions for COVID-19 testing.\n\nFiltering Type: `boolean`\n\n```\nEligible For: \n * healthcareFacility\n * location\n```" covidTestingReferralRequired: type: boolean description: "Indicates whether a referral is required for COVID-19 testing.\n\nFiltering Type: `boolean`\n\n```\nEligible For: \n * healthcareFacility\n * location\n```" covidTestingSiteInstructions: minLength: 0 maxLength: 15000 type: string description: "Information or instructions for the COVID-19 testing site.\n\nFiltering Type: `text`\n\n```\nEligible For: \n * healthcareFacility\n * location\n```" covidVaccineAppointmentRequired: type: boolean description: "Indicates whether an appointment is required for a COVID-19 vaccine.\n\nFiltering Type: `boolean`\n\n```\nEligible For: \n * healthcareFacility\n * location\n```" covidVaccineDriveThroughSite: type: boolean description: "Indicates whether location is a drive-through site for COVID-19 vaccines.\n\nFiltering Type: `boolean`\n\n```\nEligible For: \n * healthcareFacility\n * location\n```" covidVaccineInformationUrl: minLength: 0 format: uri type: string description: "An information URL for more information about COVID-19 vaccines.\n\nFiltering Type: `text`\n\n```\nEligible For: \n * healthcareFacility\n * location\n```" covidVaccinePatientRestrictions: type: boolean description: "Indicates whether there are patient restrictions for a COVID-19 vaccine.\n\nFiltering Type: `boolean`\n\n```\nEligible For: \n * healthcareFacility\n * location\n```" covidVaccineReferralRequired: type: boolean description: "Indicates whether a referral is required for a COVID-19 vaccine.\n\nFiltering Type: `boolean`\n\n```\nEligible For: \n * healthcareFacility\n * location\n```" covidVaccineSiteInstructions: minLength: 0 maxLength: 15000 type: string description: "Information or instructions for the COVID-19 vaccination site.\n\nFiltering Type: `text`\n\n```\nEligible For: \n * healthcareFacility\n * location\n```" 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.\n\nFiltering Type: `list of option`\n\n```\nEligible For: \n * healthcareFacility\n * location\n```" currencyExchange: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: "Indicates whether the entity offers currency exchange services.\n\nFiltering Type: `option`\n\n```\nEligible For: \n * hotel\n```" customKeywords: description: "Additional keywords you would like us to use when tracking your search performance\n\n\nArray must be ordered.\n\nArray may have a maximum of 5 elements.\n\n\nFiltering Type: `list of text`\n\n```\nEligible For: \n * atm\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * organization\n * restaurant\n```" 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\n\nFiltering Type: `date`\n\n```\nEligible For: \n * job\n```" degrees: description: "A list of the degrees earned by the healthcare professional\n\n\nArray must be ordered.\n\n\nFiltering Type: `list of option`\n\n```\nEligible For: \n * healthcareProfessional\n```" 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.\n\nEach 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.\nSimilarly, holiday delivery hours are represented by the `holidayHours` sub-field.\nSetting the `reopenDate` sub-field indicates that the business is temporarily closed and will reopen on the specified date.\nSPECIAL CASES:\n* 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.\n* 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.\n* If you are providing `openIntervals`, you may not set `isClosed` to true for that day.\n\nFiltering Type: `hours`\n\n```\nEligible For: \n * location\n * restaurant\n```" description: minLength: 10 maxLength: 15000 type: string description: "A description of the entity\n\n\nCannot Include:\n* HTML markup\n\nFiltering Type: `text`\n\n```\nEligible For: \n * atm\n * contactCard\n * event\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * job\n * location\n * organization\n * restaurant\n```" 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\n\nFiltering Type: `object`\n\n```\nEligible For: \n * atm\n * event\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * job\n * location\n * restaurant\n```" doctorOnCall: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: "Indicates whether the entity has a doctor on premise or on call.\n\nFiltering Type: `option`\n\n```\nEligible For: \n * hotel\n```" dogsAllowed: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: "Indicates if the entity is dog friendly.\n\nFiltering Type: `option`\n\n```\nEligible For: \n * hotel\n```" 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.\n\nEach 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.\nSimilarly, holiday drive-through hours are represented by the `holidayHours` sub-field.\nSetting the `reopenDate` sub-field indicates that the business is temporarily closed and will reopen on the specified date.\nSPECIAL CASES:\n* 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.\n* 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.\n* If you are providing `openIntervals`, you may not set `isClosed` to true for that day.\n\nFiltering Type: `hours`\n\n```\nEligible For: \n * atm\n * location\n * restaurant\n```" 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\n\nFiltering Type: `object`\n\n```\nEligible For: \n * atm\n * event\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * restaurant\n```" educationList: description: "Information about the education or training completed by the healthcare professional\n\n\nArray must be ordered.\n\n\nFiltering Type: `list of object`\n\n```\nEligible For: \n * healthcareProfessional\n```" 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.\n\nFiltering Type: `option`\n\n```\nEligible For: \n * hotel\n```" elevator: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: "Indicates whether the entity has an elevator.\n\nFiltering Type: `option`\n\n```\nEligible For: \n * hotel\n```" ellipticalMachine: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: "Indicates whether the entity has an elliptical machine.\n\nFiltering Type: `option`\n\n```\nEligible For: \n * hotel\n```" emails: description: "Emails addresses for this entity's point of contact\n\nMust be valid email addresses\n\n\n\nArray must be ordered.\n\nArray may have a maximum of 5 elements.\n\n\nFiltering Type: `list of text`\n\n```\nEligible For: \n * contactCard\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * organization\n * restaurant\n```" 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.\n\nFiltering Type: `option`\n\n```\nEligible For: \n * job\n```" eventStatus: enum: - SCHEDULED - RESCHEDULED - POSTPONED - CANCELED - EVENT_MOVED_ONLINE type: string description: "Information on whether the event will take place as scheduled\n\nFiltering Type: `option`\n\n```\nEligible For: \n * event\n```" facebookAbout: minLength: 0 maxLength: 255 type: string description: "A description of the entity to be used in the \"About You\" section on Facebook\n\nFiltering Type: `text`\n\n```\nEligible For: \n * atm\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * restaurant\n```" 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\n\nValid contents of **`value`** depends on the Call-to-Action's **`type`**:\n* `NONE`: (optional)\n* `BOOK_NOW`: URL\n* `CALL_NOW`: Phone number\n* `CONTACT_US`: URL\n* `SEND_MESSAGE`: Any string\n* `USE_APP`: URL\n* `PLAY_GAME`: URL\n* `SHOP_NOW`: URL\n* `SIGN_UP`: URL\n* `WATCH_VIDEO`: URL\n* `SEND_EMAIL`: Email address\n* `LEARN_MORE`: URL\n* `PURCHASE_GIFT_CARDS`: URL\n* `ORDER_NOW`: URL\n* `FOLLOW_PAGE`: Any string\n\nFiltering Type: `object`\n\n```\nEligible For: \n * atm\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * restaurant\n```" facebookCoverPhoto: required: - url additionalProperties: false type: object description: "The cover photo for the entity's Facebook profile\n\nDisplayed as a 851 x 315 pixel image\n\nYou may need a cover photo in order for your listing to appear on Facebook. Please check your listings tab to learn more.\n\n\nImage must be at least 400 x 150 pixels\n\nImage area (width x height) may be no more than 41000000 pixels\n\nImage may be no more than 30000 x 30000 pixels\n\nSupported Aspect Ratios:\n* 1 x 1\n* 4 x 3\n* 3 x 2\n* 5 x 3\n* 16 x 9\n* 3 x 1\n* 2 x 3\n* 5 x 7\n* 4 x 5\n* 4 x 1\n\n**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.\n\n\nFiltering Type: `object`\n\n```\nEligible For: \n * atm\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * restaurant\n```" 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.\n\n\nCannot Include:\n* HTML markup\n\nFiltering Type: `text`\n\n```\nEligible For: \n * atm\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * restaurant\n```" 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.\n\nFiltering Type: `text`\n\n```\nEligible For: \n * atm\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * restaurant\n```" facebookOverrideCity: minLength: 0 type: string description: "The city to be displayed on this entity's Facebook profile\n\nFiltering Type: `text`\n\n```\nEligible For: \n * atm\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * restaurant\n```" facebookPageUrl: minLength: 0 type: string description: "URL for the entity's Facebook Page.\n\nValid formats:\n\n- facebook.com/profile.php?id=[numId]\n- facebook.com/group.php?gid=[numId]\n- facebook.com/groups/[numId]\n- facebook.com/[Name]\n- facebook.com/pages/[Name]/[numId]\n- facebook.com/people/[Name]/[numId]\n\nwhere [Name] is a String and [numId] is an Integer\nThe success response will contain a warning message explaining why the URL wasn't stored in the system.\n\nFiltering Type: `text`\n\n```\nEligible For: \n * atm\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * organization\n * restaurant\n```" 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\n\nFiltering Type: `text`\n\n```\nEligible For: \n * atm\n * brand\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * restaurant\n```" facebookProfilePhoto: required: - url additionalProperties: false type: object description: "The profile picture for the entity's Facebook profile\n\nYou must have a profile picture in order for your listing to appear on Facebook.\n\n\nImage must be at least 180 x 180 pixels\n\nImage area (width x height) may be no more than 41000000 pixels\n\nImage may be no more than 30000 x 30000 pixels\n\nSupported Aspect Ratios:\n* 1 x 1\n* 4 x 3\n* 3 x 2\n* 5 x 3\n* 16 x 9\n* 3 x 1\n* 2 x 3\n* 5 x 7\n* 4 x 5\n* 4 x 1\n\n**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.\n\n\nFiltering Type: `object`\n\n```\nEligible For: \n * atm\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * restaurant\n```" 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\n\nFiltering Type: `text`\n\n```\nEligible For: \n * atm\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * restaurant\n```" 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.\n\nFiltering Type: `text`\n\n```\nEligible For: \n * atm\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * restaurant\n```" 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).\n\nFiltering Type: `text`\n\n```\nEligible For: \n * atm\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * restaurant\n```" fax: minLength: 0 type: string description: "Must be a valid fax number.\n\nIf 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.\n\nFiltering Type: `text`\n\n```\nEligible For: \n * atm\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * restaurant\n```" 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\n\nFiltering Type: `object`\n\n```\nEligible For: \n * atm\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * restaurant\n```" firstName: minLength: 0 maxLength: 35 type: string description: "The first name of the healthcare professional\n\n\nCannot Include:\n* a URL or domain name\n* HTML markup\n\nFiltering Type: `text`\n\n```\nEligible For: \n * healthcareProfessional\n```" firstPartyReviewPage: minLength: 0 type: string description: "Link to the review-collection page, where consumers can leave first-party reviews\n\n```\nEligible For: \n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * restaurant\n```" fitnessCenter: enum: - FITNESS_CENTER_AVAILABLE - FITNESS_CENTER_AVAILABLE_FOR_FREE - NOT_APPLICABLE type: string description: "Indicates whether the entity has a fitness center.\n\nFiltering Type: `option`\n\n```\nEligible For: \n * hotel\n```" floorCount: multipleOf: 1 minimum: 0 type: number description: "The number of floors the entity has from ground floor to top floor.\n\nFiltering Type: `integer`\n\n```\nEligible For: \n * hotel\n```" freeWeights: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: "Indicates whether the entity has free weights.\n\nFiltering Type: `option`\n\n```\nEligible For: \n * hotel\n```" frequentlyAskedQuestions: description: "A list of questions that are frequently asked about this entity\n\n\nArray must be ordered.\n\nArray may have a maximum of 100 elements.\n\n\nFiltering Type: `list of object`\n\n```\nEligible For: \n * atm\n * event\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * restaurant\n```" 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.\n\nFiltering Type: `option`\n\n```\nEligible For: \n * hotel\n```" fullyVaccinatedStaff: type: boolean description: "Indicates whether the staff is vaccinated against COVID-19.\n\nFiltering Type: `boolean`\n\n```\nEligible For: \n * healthcareFacility\n * hotel\n * location\n * restaurant\n```" gameRoom: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: "Indicates whether the entity has a game room.\n\nFiltering Type: `option`\n\n```\nEligible For: \n * hotel\n```" gender: enum: - UNSPECIFIED - FEMALE - MALE - NONBINARY - TRANSGENDER_FEMALE - TRANSGENDER_MALE - OTHER - PREFER_NOT_TO_DISCLOSE type: string description: "The gender of the healthcare professional\n\nFiltering Type: `option`\n\n```\nEligible For: \n * healthcareProfessional\n```" geomodifier: minLength: 0 type: string description: "Provides additional information on where the entity can be found (e.g., `Times Square`, `Global Center Mall`)\n\nFiltering Type: `text`\n\n```\nEligible For: \n * atm\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * restaurant\n```" giftShop: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: "Indicates whether the entity has a gift shop.\n\nFiltering Type: `option`\n\n```\nEligible For: \n * hotel\n```" 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.\n\nFiltering Type: `option`\n\n```\nEligible For: \n * hotel\n```" 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.\n\nValid 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.\n\nKeyword 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`).\n\n* 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\" ] }]`)\n* 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\" ]}`)\n\n**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.\n\nFiltering Type: `object`\n\n```\nEligible For: \n * atm\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * restaurant\n```" googleCoverPhoto: required: - url additionalProperties: false type: object description: "The cover photo for the entity's Google profile\n\n\nImage must be at least 250 x 250 pixels\n\n\nFiltering Type: `object`\n\n```\nEligible For: \n * atm\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * restaurant\n```" 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.\nMust be a valid phone number.\nIf 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. \n\nFiltering 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.\n\nNOTE: 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.\n\nFiltering Type: `object`\n\n```\nEligible For: \n * atm\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * restaurant\n```" googleMyBusinessLabels: description: "Google Business Profile Labels help users organize their locations into groups within GBP.\n\n\nArray must be ordered.\n\nArray may have a maximum of 10 elements.\n\nArray item description:\n\n>Cannot Include:\n>* HTML markup\n\nFiltering Type: `list of text`\n\n```\nEligible For: \n * atm\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * restaurant\n```" 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.\n\nFiltering Type: `text`\n\n```\nEligible For: \n * atm\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * restaurant\n```" googleProfilePhoto: required: - url additionalProperties: false type: object description: "The profile photo for the entity's Google profile\n\n\nImage must be at least 250 x 250 pixels\n\nImage may be no more than 5000 x 5000 pixels\n\nSupported Aspect Ratios:\n* 1 x 1\n\n**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.\n\n\nFiltering Type: `object`\n\n```\nEligible For: \n * atm\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * restaurant\n```" 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).\n\nFor 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.\n\nFiltering Type: `text`\n\n```\nEligible For: \n * atm\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * restaurant\n```" 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.\n\nEach 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.\nSimilarly, holiday happy hours are represented by the `holidayHours` sub-field.\nSetting the `reopenDate` sub-field indicates that the business is temporarily closed and will reopen on the specified date.\nSPECIAL CASES:\n* 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.\n* 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.\n* If you are providing `openIntervals`, you may not set `isClosed` to true for that day.\n\nFiltering Type: `hours`\n\n```\nEligible For: \n * hotel\n * location\n * restaurant\n```" headshot: required: - url additionalProperties: false type: object description: "A portrait of the healthcare professional\n\nFiltering Type: `object`\n\n```\nEligible For: \n * contactCard\n * financialProfessional\n * healthcareProfessional\n```" 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\n\nFiltering Type: `text`\n\n```\nEligible For: \n * job\n```" holidayHoursConversationEnabled: type: boolean description: "Indicates whether holiday-hour confirmation alerts are enabled for the Yext Knowledge Assistant for this entity\n\nFiltering Type: `boolean`\n\n```\nEligible For: \n * atm\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * restaurant\n```" horsebackRiding: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: "Indicates whether the entity offers horseback riding.\n\nFiltering Type: `option`\n\n```\nEligible For: \n * hotel\n```" hotTub: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: "Indicates whether the entity has a hot tub.\n\nFiltering Type: `option`\n\n```\nEligible For: \n * hotel\n```" 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.\n\nEach 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.\nSimilarly, holiday hours are represented by the `holidayHours` sub-field.\nSetting the `reopenDate` sub-field indicates that the business is temporarily closed and will reopen on the specified date.\nSPECIAL CASES:\n* 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.\n* 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.\n* If you are providing `openIntervals`, you may not set `isClosed` to true for that day.\n\nFiltering Type: `hours`\n\n```\nEligible For: \n * atm\n * contactCard\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * restaurant\n```" housekeeping: enum: - HOUSEKEEPING_AVAILABLE - HOUSEKEEPING_AVAILABLE_DAILY - NOT_APPLICABLE type: string description: "Indicates whether the entity offers housekeeping services.\n\nFiltering Type: `option`\n\n```\nEligible For: \n * hotel\n```" 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.\n\nFiltering Type: `text`\n\n```\nEligible For: \n * atm\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * restaurant\n```" indoorPoolCount: multipleOf: 1 minimum: 0 type: number description: "A count of the number of indoor pools\n\nFiltering Type: `integer`\n\n```\nEligible For: \n * hotel\n```" instagramHandle: minLength: 0 maxLength: 30 type: string description: "Valid Instagram username for the entity without the leading \"@\" (e.g., `NewCityAuto`)\n\nFiltering Type: `text`\n\n```\nEligible For: \n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * organization\n * restaurant\n```" insuranceAccepted: description: "A list of insurance policies accepted by the healthcare provider\n\n\nArray must be ordered.\n\nArray may have a maximum of 100 elements.\n\nArray item description:\n\n>Cannot Include:\n>* HTML markup\n\nFiltering Type: `list of text`\n\n```\nEligible For: \n * healthcareFacility\n * healthcareProfessional\n```" 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\n\nFiltering Type: `text`\n\n```\nEligible For: \n * brand\n * financialProfessional\n * hotel\n * location\n * restaurant\n```" isClusterPrimary: type: boolean description: "Indicates whether the healthcare entity is the primary entity in its group\n\nFiltering Type: `boolean`\n\n```\nEligible For: \n * healthcareProfessional\n```" isFreeEvent: type: boolean description: "Indicates whether or not the event is free\n\nFiltering Type: `boolean`\n\n```\nEligible For: \n * event\n```" isoRegionCode: minLength: 0 type: string description: "The ISO 3166-2 region code for the entity\n\nYext 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.\n\nFiltering Type: `text`\n\n```\nEligible For: \n * atm\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * restaurant\n```" keywords: description: "Keywords that describe the entity.\n\nAll strings must be non-empty when trimmed of whitespace.\n\n\n\nArray must be ordered.\n\nArray may have a maximum of 100 elements.\n\nArray item description:\n\n>Cannot Include:\n>* HTML markup\n\nFiltering Type: `list of text`\n\n```\nEligible For: \n * atm\n * card\n * event\n * faq\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * helpArticle\n * hotel\n * job\n * location\n * product\n * restaurant\n```" 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.\n\nFiltering Type: `option`\n\n```\nEligible For: \n * hotel\n```" kidsClub: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: "Indicates if the property has a Kids Club.\n\nFiltering Type: `option`\n\n```\nEligible For: \n * hotel\n```" kidsStayFree: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: "Indicates whether the entity allows kids to stay free.\n\nFiltering Type: `option`\n\n```\nEligible For: \n * hotel\n```" 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.\n\nEach 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.\nSimilarly, holiday kitchen hours are represented by the `holidayHours` sub-field.\nSetting the `reopenDate` sub-field indicates that the business is temporarily closed and will reopen on the specified date.\nSPECIAL CASES:\n* 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.\n* 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.\n* If you are providing `openIntervals`, you may not set `isClosed` to true for that day.\n\nFiltering Type: `hours`\n\n```\nEligible For: \n * hotel\n * location\n * restaurant\n```" 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.\n\n**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.\n\nFiltering Type: `opaque`\n\n```\nEligible For: \n * atm\n * board\n * brand\n * card\n * contactCard\n * event\n * faq\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * helpArticle\n * hotel\n * hotelRoomType\n * job\n * location\n * organization\n * product\n * restaurant\n```" landingPageUrl: minLength: 0 format: uri type: string description: "The URL of this entity's Landing Page that was created with Yext Pages\n\nFiltering Type: `text`\n\n```\nEligible For: \n * atm\n * card\n * event\n * faq\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * helpArticle\n * hotel\n * job\n * location\n * product\n * restaurant\n```" languages: description: "The langauges in which consumers can commicate with this entity or its staff members\nAll strings must be non-empty when trimmed of whitespace.\n\n\n\nArray must be ordered.\n\nArray may have a maximum of 100 elements.\n\nArray item description:\n\n>Cannot Include:\n>* HTML markup\n\nFiltering Type: `list of text`\n\n```\nEligible For: \n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * restaurant\n```" 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\n\n\nCannot Include:\n* a URL or domain name\n* HTML markup\n\nFiltering Type: `text`\n\n```\nEligible For: \n * healthcareProfessional\n```" laundry: enum: - FULL_SERVICE - SELF_SERVICE - NOT_APPLICABLE type: string description: "Indicates whether the entity offers laundry services.\n\nFiltering Type: `option`\n\n```\nEligible For: \n * hotel\n```" lazyRiver: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: "Indicates if the property has a lazy river\n\nFiltering Type: `option`\n\n```\nEligible For: \n * hotel\n```" lifeguard: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: "Indicates if the property has a lifeguard on duty\n\nFiltering Type: `option`\n\n```\nEligible For: \n * hotel\n```" linkedInUrl: minLength: 0 format: uri type: string description: "URL for your LinkedIn account, format should be https://www.linkedin.com/in/yourUsername\n\nFiltering Type: `text`\n\n```\nEligible For: \n * contactCard\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * organization\n * restaurant\n```" linkedLocation: type: string description: "location ID of the event location, if the event is held at a location managed in the Yext Knowledge Manager\n\nFiltering Type: `entityId`\n\n```\nEligible For: \n * contactCard\n * event\n```" 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.\n\nFiltering Type: `text`\n\n```\nEligible For: \n * atm\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * restaurant\n```" localShuttle: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: "Indicates whether the entity offers local shuttle services.\n\nFiltering Type: `option`\n\n```\nEligible For: \n * hotel\n```" 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.\n\nFiltering Type: `entityId`\n\n```\nEligible For: \n * atm\n```" 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\n\nFiltering Type: `object`\n\n```\nEligible For: \n * job\n```" locationType: enum: - LOCATION - HEALTHCARE_FACILITY - HEALTHCARE_PROFESSIONAL - ATM - RESTAURANT - HOTEL type: string description: "Indicates the entity's type, if it is not an event\n\nFiltering Type: `option`\n\n```\nEligible For: \n * atm\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * restaurant\n```" logo: required: - image additionalProperties: false type: object description: "An image of the entity's logo\n\n\nSupported Aspect Ratios:\n* 1 x 1\n\n**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.\n\n\nFiltering Type: `object`\n\n```\nEligible For: \n * atm\n * contactCard\n * faq\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * job\n * location\n * organization\n * restaurant\n```" 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\n\nMust be a valid phone number.\n\nIf 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.\n\nFiltering Type: `text`\n\n```\nEligible For: \n * atm\n * contactCard\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * organization\n * restaurant\n```" massage: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: "Indicates whether the entity offers massage services.\n\nFiltering Type: `option`\n\n```\nEligible For: \n * hotel\n```" 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\n\nFiltering Type: `integer`\n\n```\nEligible For: \n * hotel\n```" 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\n\nFiltering Type: `integer`\n\n```\nEligible For: \n * hotel\n```" 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\n\nFiltering Type: `list of option`\n\n```\nEligible For: \n * restaurant\n```" meetingRoomCount: multipleOf: 1 minimum: 0 type: number description: "The number of meeting rooms the entity has.\n\nFiltering Type: `integer`\n\n```\nEligible For: \n * hotel\n```" 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\n\nFiltering Type: `object`\n\n```\nEligible For: \n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * restaurant\n```" 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\n\nFiltering Type: `object`\n\n```\nEligible For: \n * hotel\n * location\n * restaurant\n```" middleName: minLength: 0 maxLength: 35 type: string description: "The middle name of the healthcare professional\n\n\nCannot Include:\n* a URL or domain name\n* HTML markup\n\nFiltering Type: `text`\n\n```\nEligible For: \n * healthcareProfessional\n```" mobilePhone: minLength: 0 type: string description: "Must be a valid phone number.\n\nIf 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.\n\nFiltering Type: `text`\n\n```\nEligible For: \n * atm\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * restaurant\n```" mobilityAccessible: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: "Indicates whether the entity is mobility/wheelchair accessible\n\nFiltering Type: `option`\n\n```\nEligible For: \n * hotel\n```" nightclub: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: "Indicates whether the entity has a nightclub.\n\nFiltering Type: `option`\n\n```\nEligible For: \n * hotel\n```" npi: minLength: 0 type: string description: "The National Provider Identifier (NPI) of the healthcare provider\n\nFiltering Type: `text`\n\n```\nEligible For: \n * healthcareFacility\n * healthcareProfessional\n```" nudgeEnabled: type: boolean description: "Indicates whether Knowledge Nudge is enabled for the Yext Knowledge Assistant for this entity\n\nFiltering Type: `boolean`\n\n```\nEligible For: \n * atm\n * faq\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * helpArticle\n * hotel\n * job\n * location\n * organization\n * product\n * restaurant\n```" officeName: minLength: 0 type: string description: "The name of the office where the healthcare professional works, if different from **`name`**\n\nFiltering Type: `text`\n\n```\nEligible For: \n * healthcareProfessional\n```" 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.\n\nEach 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.\nSimilarly, holiday online service hours are represented by the `holidayHours` sub-field.\nSetting the `reopenDate` sub-field indicates that the business is temporarily closed and will reopen on the specified date.\nSPECIAL CASES:\n* 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.\n* 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.\n* If you are providing `openIntervals`, you may not set `isClosed` to true for that day.\n\nFiltering Type: `hours`\n\n```\nEligible For: \n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * location\n * restaurant\n```" openDate: format: date type: string description: "The date that the entity is set to open for the first time.\nMust be formatted in YYYY-MM-DD format.\n\nDate must be on or after 1970-01-01 Date must be before or on 2038-01-01\n\n\nFiltering Type: `date`\n\n```\nEligible For: \n * atm\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * restaurant\n```" 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\n\nFiltering Type: `list of option`\n\n```\nEligible For: \n * organization\n```" 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\n\nFiltering Type: `object`\n\n```\nEligible For: \n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * restaurant\n```" organizerEmail: minLength: 0 format: email type: string description: "Point of contact for the event organizer (not to be published publicly)\n\nFiltering Type: `text`\n\n```\nEligible For: \n * event\n```" organizerName: minLength: 0 type: string description: "Point of contact for the event organizer (not to be published publicly)\n\nFiltering Type: `text`\n\n```\nEligible For: \n * event\n```" organizerPhone: minLength: 0 type: string description: "Point of contact for the event organizer (not to be published publicly)\n\nFiltering Type: `text`\n\n```\nEligible For: \n * event\n```" outdoorPoolCount: multipleOf: 1 minimum: 0 type: number description: "The number of outdoor pools the entity has.\n\nFiltering Type: `integer`\n\n```\nEligible For: \n * hotel\n```" parking: enum: - PARKING_AVAILABLE - PARKING_AVAILABLE_FOR_FREE - NOT_APPLICABLE type: string description: "Indicates whether the entity offers parking services.\n\nFiltering Type: `option`\n\n```\nEligible For: \n * hotel\n```" 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\n\nValid elements depend on the entity's country.\n\n\nFiltering Type: `list of option`\n\n```\nEligible For: \n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * restaurant\n```" performers: description: "Performers at the event\n\n\nArray must be ordered.\n\nArray may have a maximum of 100 elements.\n\n\nFiltering Type: `list of text`\n\n```\nEligible For: \n * event\n```" 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.\n\nFiltering Type: `option`\n\n```\nEligible For: \n * hotel\n```" photoGallery: description: "\n**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.\n\n\n\nArray must be ordered.\n\nArray may have a maximum of 500 elements.\n\nArray item description:\n\n>Supported Aspect Ratios:\n>* 1 x 1\n>* 4 x 3\n>* 3 x 2\n>* 5 x 3\n>* 16 x 9\n>* 3 x 1\n>* 2 x 3\n>* 5 x 7\n>* 4 x 5\n>* 4 x 1\n>\n>**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.\n>\n\nFiltering Type: `list of object`\n\n```\nEligible For: \n * atm\n * event\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * hotelRoomType\n * location\n * organization\n * product\n * restaurant\n```" 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\n\nFiltering Type: `object`\n\n```\nEligible For: \n * atm\n * event\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * restaurant\n```" 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.\n\nEach 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.\nSimilarly, holiday pickup hours are represented by the `holidayHours` sub-field.\nSetting the `reopenDate` sub-field indicates that the business is temporarily closed and will reopen on the specified date.\nSPECIAL CASES:\n* 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.\n* 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.\n* If you are providing `openIntervals`, you may not set `isClosed` to true for that day.\n\nFiltering Type: `hours`\n\n```\nEligible For: \n * healthcareFacility\n * location\n * restaurant\n```" pinterestUrl: minLength: 0 format: uri type: string description: "URL for your Pinterest account, format should be https://www.pinterest.com/yourUsername\n\nFiltering Type: `text`\n\n```\nEligible For: \n * contactCard\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * organization\n * restaurant\n```" 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)\n\nFiltering Type: `option`\n\n```\nEligible For: \n * atm\n * healthcareFacility\n * healthcareProfessional\n * location\n * restaurant\n```" primaryConversationContact: minLength: 0 type: string description: "ID of the user who is the primary Knowledge Assistant contact for the entity\n\nFiltering Type: `option`\n\n```\nEligible For: \n * atm\n * faq\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * helpArticle\n * hotel\n * job\n * location\n * organization\n * product\n * restaurant\n```" privateBeach: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: "Indicates whether the entity has access to a private beach.\n\nFiltering Type: `option`\n\n```\nEligible For: \n * hotel\n```" privateCarService: enum: - PRIVATE_CAR_SERVICE - PRIVATE_CAR_SERVICE_FOR_FREE - NOT_APPLICABLE type: string description: "Indicates whether the entity offers private car services.\n\nFiltering Type: `option`\n\n```\nEligible For: \n * hotel\n```" 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\n\nFiltering Type: `object`\n\n```\nEligible For: \n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * restaurant\n```" products: description: "Products sold by this entity\n\nAll strings must be non-empty when trimmed of whitespace.\n\n\n\nArray must be ordered.\n\nArray may have a maximum of 100 elements.\n\nArray item description:\n\n>Cannot Include:\n>* HTML markup\n\nFiltering Type: `list of text`\n\n```\nEligible For: \n * financialProfessional\n * location\n```" 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\n\nFiltering Type: `boolean`\n\n```\nEligible For: \n * atm\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * organization\n * restaurant\n```" rankTrackingCompetitors: description: "Information about the competitors whose search performance you would like to compare to your own\n\n\nArray must be ordered.\n\nArray may have a maximum of 5 elements.\n\n\nFiltering Type: `list of object`\n\n```\nEligible For: \n * atm\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * organization\n * restaurant\n```" 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\n\nFiltering Type: `boolean`\n\n```\nEligible For: \n * atm\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * organization\n * restaurant\n```" rankTrackingFrequency: enum: - WEEKLY - MONTHLY - QUARTERLY type: string description: "How often we send search queries to track your search performance\n\nFiltering Type: `option`\n\n```\nEligible For: \n * atm\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * organization\n * restaurant\n```" rankTrackingQueryTemplates: description: "The ways in which your keywords will be arranged in the search queries we use to track your performance\n\n\nArray must have a minimum of 2 elements.\n\nArray may have a maximum of 4 elements.\n\n\nFiltering Type: `list of option`\n\n```\nEligible For: \n * atm\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * organization\n * restaurant\n```" 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\n\nFiltering Type: `list of option`\n\n```\nEligible For: \n * atm\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * organization\n * restaurant\n```" 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\n\nFiltering Type: `object`\n\n```\nEligible For: \n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * restaurant\n```" restaurantCount: multipleOf: 1 minimum: 0 type: number description: "The number of restaurants the entity has.\n\nFiltering Type: `integer`\n\n```\nEligible For: \n * hotel\n```" reviewGenerationUrl: minLength: 0 type: string description: "The URL given Review Invitation emails where consumers can leave a review about the entity\n\n```\nEligible For: \n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * restaurant\n```" reviewResponseConversationEnabled: type: boolean description: "Indicates whether Yext Knowledge Assistant review-response conversations are enabled for this entity\n\nFiltering Type: `boolean`\n\n```\nEligible For: \n * atm\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * restaurant\n```" roomCount: multipleOf: 1 minimum: 0 type: number description: "The number of rooms the entity has.\n\nFiltering Type: `integer`\n\n```\nEligible For: \n * hotel\n```" roomService: enum: - ROOM_SERVICE_AVAILABLE - ROOM_SERVICE_AVAILABLE_24_HOURS - NOT_APPLICABLE type: string description: "Indicates whether the entity offers room service.\n\nFiltering Type: `option`\n\n```\nEligible For: \n * hotel\n```" 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\n\nFiltering Type: `object`\n\n```\nEligible For: \n * atm\n * event\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * restaurant\n```" salon: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: "Indicates whether the entity has a salon.\n\nFiltering Type: `option`\n\n```\nEligible For: \n * hotel\n```" sauna: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: "Indicates whether the entity has a sauna.\n\nFiltering Type: `option`\n\n```\nEligible For: \n * hotel\n```" scuba: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: "Indicates whether the entity offers scuba diving.\n\nFiltering Type: `option`\n\n```\nEligible For: \n * hotel\n```" selfParking: enum: - SELF_PARKING_AVAILABLE - SELF_PARKING_AVAILABLE_FOR_FREE - NOT_APPLICABLE type: string description: "Indicates whether the entity offers self parking services.\n\nFiltering Type: `option`\n\n```\nEligible For: \n * hotel\n```" 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.\n\nEach 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.\nSimilarly, holiday senior hours are represented by the `holidayHours` sub-field.\nSetting the `reopenDate` sub-field indicates that the business is temporarily closed and will reopen on the specified date.\nSPECIAL CASES:\n* 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.\n* 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.\n* If you are providing `openIntervals`, you may not set `isClosed` to true for that day.\n\nFiltering Type: `hours`\n\n```\nEligible For: \n * location\n * restaurant\n```" serviceArea: additionalProperties: false type: object properties: places: description: "A list of places served by the entity, where each place is either:\n - a postal code, or\n - the name of a city.\n\n\n\nArray must be ordered.\n\nArray may have a maximum of 200 elements.\n\n\nFiltering 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.\n\n**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.\n\nFiltering Type: `object`\n\n```\nEligible For: \n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * restaurant\n```" 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.\n**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.\n\n\nArray may have a maximum of 200 elements.\n\n\nFiltering Type: `list of object`\n\n```\nEligible For: \n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * restaurant\n```" 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\n\nAll strings must be non-empty when trimmed of whitespace.\n\n\n\nArray must be ordered.\n\nArray may have a maximum of 100 elements.\n\nArray item description:\n\n>Cannot Include:\n>* HTML markup\n\nFiltering Type: `list of text`\n\n```\nEligible For: \n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * restaurant\n```" 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.\n\nFiltering Type: `option`\n\n```\nEligible For: \n * hotel\n```" snorkeling: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: "Indicates whether the entity offers snorkeling.\n\nFiltering Type: `option`\n\n```\nEligible For: \n * hotel\n```" socialHour: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: "Indicates whether the entity offers a social hour.\n\nFiltering Type: `option`\n\n```\nEligible For: \n * hotel\n```" spa: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: "Indicates whether the entity has a spa.\n\nFiltering Type: `option`\n\n```\nEligible For: \n * hotel\n```" specialities: description: "Up to 100 of this entity's specialities (e.g., for food and dining: `Chicago style`)\n\nAll strings must be non-empty when trimmed of whitespace.\n\n\n\nArray must be ordered.\n\nArray may have a maximum of 100 elements.\n\nArray item description:\n\n>Cannot Include:\n>* HTML markup\n\nFiltering Type: `list of text`\n\n```\nEligible For: \n * financialProfessional\n * location\n * restaurant\n```" 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.\n\nFiltering Type: `option`\n\n```\nEligible For: \n * hotel\n```" 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.\n\nEach 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.\nSimilarly, holiday takeout hours are represented by the `holidayHours` sub-field.\nSetting the `reopenDate` sub-field indicates that the business is temporarily closed and will reopen on the specified date.\nSPECIAL CASES:\n* 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.\n* 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.\n* If you are providing `openIntervals`, you may not set `isClosed` to true for that day.\n\nFiltering Type: `hours`\n\n```\nEligible For: \n * location\n * restaurant\n```" tennis: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: "Indicates whether the entity has tennis courts.\n\nFiltering Type: `option`\n\n```\nEligible For: \n * hotel\n```" thermalPool: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: "Indicates whether the entity has a thermal pool.\n\nFiltering Type: `option`\n\n```\nEligible For: \n * hotel\n```" ticketAvailability: enum: - IN_STOCK - SOLD_OUT - PRE_ORDER - UNSPECIFIED type: string description: "Information about the availability of tickets for the event\n\nFiltering Type: `option`\n\n```\nEligible For: \n * event\n```" 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\n\nFiltering Type: `object`\n\n```\nEligible For: \n * event\n```" ticketSaleDateTime: format: date-time type: string description: "The date/time tickets are available for sale (local time)\n\nFiltering Type: `datetime`\n\n```\nEligible For: \n * event\n```" ticketUrl: minLength: 0 format: uri type: string description: "URL to purchase tickets for the event (if ticketed)\n\nFiltering Type: `text`\n\n```\nEligible For: \n * event\n```" tikTokUrl: minLength: 0 format: uri type: string description: "URL for your TikTok profile, format should be https://www.tiktok.com/yourUsername\n\nFiltering Type: `text`\n\n```\nEligible For: \n * contactCard\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * organization\n * restaurant\n```" 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\n\nFiltering Type: `object`\n\n```\nEligible For: \n * event\n```" timeZoneUtcOffset: minLength: 0 type: string description: "Represents the time zone offset of the entity from UTC, in `±hh:mm` format.\n\nFor example, if the entity is 4 hours ahead of UTC time, the offset will be `+04:00`.\n\nIf the entity is 15.5 hours behind UTC time, the offset will be `-15:30`.\n\nIf the entity is in UTC time, the offset will be `+00:00`.\n\n\n```\nEligible For: \n * atm\n * event\n * faq\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * job\n * location\n * restaurant\n```" 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\"`\n\nFiltering Type: `option`\n\n```\nEligible For: \n * atm\n * board\n * card\n * contactCard\n * event\n * faq\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * helpArticle\n * hotel\n * hotelRoomType\n * job\n * location\n * organization\n * product\n * restaurant\n```" tollFreePhone: minLength: 0 type: string description: "Must be a valid phone number.\n\nIf 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.\n\nFiltering Type: `text`\n\n```\nEligible For: \n * atm\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * restaurant\n```" treadmill: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: "Indicates whether the entity has a treadmill.\n\nFiltering Type: `option`\n\n```\nEligible For: \n * hotel\n```" ttyPhone: minLength: 0 type: string description: "Must be a valid phone number.\n\nIf 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.\n\nFiltering Type: `text`\n\n```\nEligible For: \n * atm\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * restaurant\n```" turndownService: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: "Indicates whether the entity offers turndown service.\n\nFiltering Type: `option`\n\n```\nEligible For: \n * hotel\n```" twitterHandle: minLength: 0 maxLength: 15 type: string description: "Valid Twitter handle for the entity without the leading \"@\" (e.g., `JohnSmith`)\n\nIf 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.\n\nFiltering Type: `text`\n\n```\nEligible For: \n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * organization\n * restaurant\n```" 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\n\nFiltering Type: `object`\n\n```\nEligible For: \n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * restaurant\n```" 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\n\nFiltering Type: `object`\n\n```\nEligible For: \n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * restaurant\n```" valetParking: enum: - VALET_PARKING_AVAILABLE - VALET_PARKING_AVAILABLE_FOR_FREE - NOT_APPLICABLE type: string description: "Indicates whether the entity offers valet parking services.\n\nFiltering Type: `option`\n\n```\nEligible For: \n * hotel\n```" validThrough: format: date-time type: string description: "The date this entity is valid through.\n\nFiltering Type: `datetime`\n\n```\nEligible For: \n * job\n```" vendingMachine: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: "Indicates whether the entity has a vending machine.\n\nFiltering Type: `option`\n\n```\nEligible For: \n * hotel\n```" venueName: minLength: 0 type: string description: "Name of the venue where the event is being held\n\nFiltering Type: `text`\n\n```\nEligible For: \n * event\n```" videos: description: "Valid YouTube URLs for embedding a video on some publisher sites\n\n**NOTE:** Currently, only the first URL in the Array appears in your listings.\n\n\n\nArray must be ordered.\n\n\nFiltering Type: `list of object`\n\n```\nEligible For: \n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * hotelRoomType\n * location\n * organization\n * product\n * restaurant\n```" 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.\n\nFiltering Type: `option`\n\n```\nEligible For: \n * hotel\n```" wakeUpCalls: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: "Indicates whether the entity offers wake up call services.\n\nFiltering Type: `option`\n\n```\nEligible For: \n * hotel\n```" 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\n\nFiltering Type: `object`\n\n```\nEligible For: \n * atm\n * event\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * restaurant\n```" waterPark: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: "Indicates whether the entity has a water park.\n\nFiltering Type: `option`\n\n```\nEligible For: \n * hotel\n```" waterSkiing: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: "Indicates whether the entity offers water skiing.\n\nFiltering Type: `option`\n\n```\nEligible For: \n * hotel\n```" watercraft: enum: - WATERCRAFT_RENTALS - WATERCRAFT_RENTALS_FOR_FREE - NOT_APPLICABLE type: string description: "Indicates whether the entity offers any kind of watercrafts.\n\nFiltering Type: `option`\n\n```\nEligible For: \n * hotel\n```" waterslide: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: "Indicates whether the entity has a water slide.\n\nFiltering Type: `option`\n\n```\nEligible For: \n * hotel\n```" wavePool: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: "Indicates whether the entity has a wave pool.\n\nFiltering Type: `option`\n\n```\nEligible For: \n * hotel\n```" 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\n\nFiltering Type: `object`\n\n```\nEligible For: \n * atm\n * contactCard\n * event\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * organization\n * restaurant\n```" weightMachine: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: "Indicates whether the entity has a weight machine.\n\nFiltering Type: `option`\n\n```\nEligible For: \n * hotel\n```" wheelchairAccessible: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: "Indicates if the entity is wheelchair accessible.\n\nFiltering Type: `option`\n\n```\nEligible For: \n * hotel\n```" wifiAvailable: enum: - WIFI_AVAILABLE - WIFI_AVAILABLE_FOR_FREE - NOT_APPLICABLE type: string description: "Indicates whether the entity has WiFi available\n\nFiltering Type: `option`\n\n```\nEligible For: \n * hotel\n```" workRemote: type: boolean description: "Indicates whether the job is remote.\n\nFiltering Type: `boolean`\n\n```\nEligible For: \n * job\n```" yearEstablished: multipleOf: 1 minimum: 1000 maximum: 2028 type: number description: "The year the entity was established.\n\nFiltering Type: `integer`\n\n```\nEligible For: \n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * restaurant\n```" yearLastRenovated: multipleOf: 1 minimum: 1000 maximum: 2028 type: number description: "The most recent year the entity was partially or completely renovated.\n\nFiltering Type: `integer`\n\n```\nEligible For: \n * hotel\n```" 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\n\nFiltering Type: `object`\n\n```\nEligible For: \n * atm\n * event\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * job\n * location\n * restaurant\n```" 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\n\nFiltering Type: `object`\n\n```\nEligible For: \n * atm\n * event\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * restaurant\n```" 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\n\nFiltering Type: `object`\n\n```\nEligible For: \n * atm\n * event\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * restaurant\n```" 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\n\nFiltering Type: `object`\n\n```\nEligible For: \n * atm\n * event\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * restaurant\n```" 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\n\nFiltering Type: `object`\n\n```\nEligible For: \n * atm\n * event\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * restaurant\n```" youTubeChannelUrl: minLength: 0 format: uri type: string description: "URL for your YouTube channel, format should be https://www.youtube.com/c/yourUsername\n\nFiltering Type: `text`\n\n```\nEligible For: \n * contactCard\n * financialProfessional\n * healthcareFacility\n * healthcareProfessional\n * hotel\n * location\n * organization\n * restaurant\n```" 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:\n\nd:oh:om:ch:cm\n* d = day of the week –\n * 1 – Sunday\n * 2 – Monday\n * 3 – Tuesday\n * 4 – Wednesday\n * 5 – Thursday\n * 6 – Friday\n * 7 – Saturday\n* oh:om = opening time in 24-hour format\n* ch:cm = closing time in 24-hour format\n\nTimes with single-digit hours (e.g., 9 AM) can be submitted with or without a leading zero (9:00 or 09:00).\n\n**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\n\nSPECIAL CASES:\n* 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.\n * **Example:** open all day on Saturdays – 7:00:00:00:00\n* 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).\n * **Example:** closed on Sundays – 1:closed\n * **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.\n* 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.\n * **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\n\n**NOTE:** To set hours for specific days of the year rather than days of the week, use **holidayHours**.\n" 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' photos: type: array items: $ref: '#/components/schemas/Photo' 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' 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' 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' 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' 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' 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.\n\nTo retrieve a list of custom fields for your account, use the Custom Fields: List endpoint.\n\nIf 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.\n\nExamples of each type of custom field:\n\n* BOOLEAN:\n * `{ \"9662\": \"true\" }`\n* DAILY_TIMES:\n * `{ \"10012\": { \"dailyTimes\": \"2:7:00,3:7:00,4:7:00,5:7:00,6:7:00,7:7:00,1:7:00\" } }`\n* DATE:\n * `{ \"7066\": \"2016-10-12\" }`\n* GALLERY:\n * `{ \"7070\": [ { \"url\": \"http://a.mktgcdn.com/p/ounkg7aq6Oy029-sRf4CIH64/128x128.jpg\" }, { \"url\": \"http://a.mktgcdn.com/p/YkQGqxK8jFBqOlailQ9QIBsgs/1.0000/316x316.png\" } ] }`\n* HOURS:\n * `{ \"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\" }`\n* LOCATION_LIST:\n * `{ \"8098\" : [ \"locationId1\", \"locationId2\" ] }`\n* MULTILINE_TEXT (up to 4,000 characters):\n * `{ \"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.\" }`\n* MULTI_OPTION:\n * `{ \"7068\": [\"2614\", \"2615\"] }` (`\"2614\"` and `\"2615\"` are the options' **`key`**s)\n* NUMBER:\n * `{ \"7078\": \"123\" }`\n* PHOTO:\n * `{ \"7071\": { \"url\": \"http://a.mktgcdn.com/p/bRtQXQZP2kEzgy2C8/800x800.jpg\", \"description\": \"New storefront\", \"details\": \"A picture of the new storefront\" } }`\n * `{ \"7071\": null }` (This setting will clear the existing value of the Photo custom field.)\n* SINGLE_OPTION:\n * `{ \"7069\": \"2617\" }` (`\"2617\"` is the option's **`key`**)\n* TEXT (up to 255 characters):\n * `{ \"6157\": \"Buy One, Get One 50% Off\" }`\n* TEXT_LIST:\n * `{ \"7072\": [ \"Item 1\", \"Item 2\", \"Item 3\" ] }`\n* URL:\n * `{ \"9381\": \"http://www.location.example.com\" }`\n* VIDEO:\n * `{ \"7077\": { \"url\": \"http://www.youtube.com/watch?v=6KQPho\" } }`\n* VIDEO_GALLERY:\n * `{ \"8452\": [ { \"url\": \"http://www.youtube.com/watch?v=B1EC1U\" }, { \"url\": \"http://www.youtube.com/watch?v=SkEtnN\" } ] }`\n" 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 ' EntityFieldSuggestionRead: type: object properties: entity: description: 'Information about the entity which the suggestion is being made on. ' type: object $ref: '#/components/schemas/EntityRead' existingContent: description: 'Contains the fields and existing values for the field(s) which are included in the suggestion. ' type: object $ref: '#/components/schemas/Entity-2' suggestedContent: description: 'Contains the fields and suggested values for the field(s) which are included in the suggestion. ' type: object $ref: '#/components/schemas/Entity-2' AtmWrite: allOf: - $ref: '#/components/schemas/EntityWrite' - additionalProperties: false type: object properties: meta: additionalProperties: false type: object properties: countryCode: minLength: 0 type: string description: Country code of this Entity's Language Profile (defaults to the country of the account) folderId: minLength: 0 type: string description: The ID of the folder containing this Entity id: minLength: 0 type: string description: ID of this Entity labels: uniqueItems: false type: array items: minLength: 0 type: string description: This Entity's labels. If the **`v`** parameter is before `20211215`, this will be an integer. language: minLength: 0 type: string description: Language code of this Entity's Language Profile (defaults to the language code of the account) description: Contains the metadata about the entity. name: minLength: 0 maxLength: 5000 type: string description: ' Cannot Include: * HTML markup' 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' countryCode: minLength: 0 pattern: ^[a-zA-Z]{2}$ type: string 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`).' line1: minLength: 0 maxLength: 255 type: string description: ' Cannot Include: * a URL or domain name' line2: minLength: 0 maxLength: 255 type: string description: ' Cannot Include: * a URL or domain name' 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' region: minLength: 0 maxLength: 255 type: string description: 'The name of the entity''s region or state. Cannot Include: * a URL or domain name' sublocality: minLength: 0 maxLength: 255 type: string description: 'The name of the entity''s sublocality Cannot Include: * a URL or domain name' 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.' 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. openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). start: format: time type: string description: The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). 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. 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. ' 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' isClosed: type: boolean description: Indicates if the access hours are "closed" on on the given date. 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. openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). start: format: time type: string description: The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). description: Contains the time intervals for which the Entity is open on the specified date. monday: additionalProperties: false type: object properties: isClosed: type: boolean description: Indicates if the access hours are "closed" on Monday. openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). start: format: time type: string description: The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). 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. reopenDate: format: date type: string description: ' Date must be on or after 1970-01-01 Date must be before or on 2038-01-01' saturday: additionalProperties: false type: object properties: isClosed: type: boolean description: Indicates if the access hours are "closed" on Saturday. openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). start: format: time type: string description: The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). 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. sunday: additionalProperties: false type: object properties: isClosed: type: boolean description: Indicates if the access hours are "closed" on Sunday. openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). start: format: time type: string description: The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). 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. thursday: additionalProperties: false type: object properties: isClosed: type: boolean description: Indicates if the access hours are "closed" on Thursday. openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). start: format: time type: string description: The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). 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. tuesday: additionalProperties: false type: object properties: isClosed: type: boolean description: Indicates if the access hours are "closed" on Tuesday. openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). start: format: time type: string description: The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). 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. wednesday: additionalProperties: false type: object properties: isClosed: type: boolean description: Indicates if the access hours are "closed" on Wednesday. openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). start: format: time type: string description: The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). 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. 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.' additionalHoursText: minLength: 0 maxLength: 255 type: string description: Additional information about hours that does not fit in **`hours`** (e.g., `"Closed during the winter"`) 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' uniqueItems: true type: array items: minLength: 0 maxLength: 100 type: string description: ' Cannot Include: * HTML markup' 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.' 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.' 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.' 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. ' uniqueItems: true type: array items: required: - category - quickLinkUrl - appName additionalProperties: false type: object properties: appName: minLength: 0 maxLength: 18 type: string appStoreUrl: minLength: 0 maxLength: 2000 format: uri type: string 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 quickLinkUrl: minLength: 0 maxLength: 2000 format: uri type: string appleBusinessDescription: minLength: 0 maxLength: 500 type: string description: The business description to be sent to Apple appleBusinessId: minLength: 0 pattern: ^\d*\.?\d*$ type: string description: The ID associated with an individual Business Folder in your Apple account appleCompanyId: minLength: 0 pattern: ^\d*\.?\d*$ type: string description: The ID associated with your Apple account. Numerical values only 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. ' properties: alternateText: minLength: 0 type: string url: minLength: 0 format: uri type: string appleDisplayName: minLength: 0 maxLength: 5000 type: string description: "The name to be displayed on Apple for the entity.\nNOTE: The names of Brands and their respective Locations within an Apple Business Connect Account must match identically.\nCannot Include:\nHTML markup \n\n\nCannot Include:\n* HTML markup" 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. ' categoryIds: uniqueItems: false type: array items: minLength: 0 type: string 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. ' closed: type: boolean description: Indicates whether the entity is closed 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. ' uniqueItems: true type: array items: minLength: 0 maxLength: 100 type: string description: minLength: 10 maxLength: 15000 type: string description: 'A description of the entity Cannot Include: * HTML markup' displayCoordinate: additionalProperties: false type: object properties: latitude: minimum: -90 maximum: 90 type: number longitude: minimum: -180 maximum: 180 type: number description: Coordinates where the map pin for the entity should be displayed, as provided by you 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. openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). start: format: time type: string description: The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). 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. 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. ' 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' isClosed: type: boolean description: Indicates if the drive-through hours are "closed" on on the given date. 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. openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). start: format: time type: string description: The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). description: Contains the time intervals for which the Entity's drive-through is open on the specified date. monday: additionalProperties: false type: object properties: isClosed: type: boolean description: Indicates if the drive-through hours are "closed" on Monday. openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). start: format: time type: string description: The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). 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. reopenDate: format: date type: string description: ' Date must be on or after 1970-01-01 Date must be before or on 2038-01-01' saturday: additionalProperties: false type: object properties: isClosed: type: boolean description: Indicates if the drive-through hours are "closed" on Saturday. openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). start: format: time type: string description: The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). 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. sunday: additionalProperties: false type: object properties: isClosed: type: boolean description: Indicates if the drive-through hours are "closed" on Sunday. openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). start: format: time type: string description: The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). 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. thursday: additionalProperties: false type: object properties: isClosed: type: boolean description: Indicates if the drive-through hours are "closed" on Thursday. openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). start: format: time type: string description: The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). 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. tuesday: additionalProperties: false type: object properties: isClosed: type: boolean description: Indicates if the drive-through hours are "closed" on Tuesday. openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). start: format: time type: string description: The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). 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. wednesday: additionalProperties: false type: object properties: isClosed: type: boolean description: Indicates if the drive-through hours are "closed" on Wednesday. openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). start: format: time type: string description: The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). 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. 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.' dropoffCoordinate: additionalProperties: false type: object properties: latitude: minimum: -90 maximum: 90 type: number longitude: minimum: -180 maximum: 180 type: number description: Coordinates of the drop-off area for the entity, as provided by you facebookAbout: minLength: 0 maxLength: 255 type: string description: A description of the entity to be used in the "About You" section on Facebook 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 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.' 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' 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. ' properties: alternateText: minLength: 0 type: string url: minLength: 0 format: uri type: string 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' 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. facebookOverrideCity: minLength: 0 type: string description: The city to be displayed on this entity's Facebook profile 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.' 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 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. ' properties: alternateText: minLength: 0 type: string url: minLength: 0 format: uri type: string facebookStoreId: minLength: 0 type: string description: The Store ID used for this entity in a brand page location structure 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. 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). 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.' 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' url: minLength: 0 maxLength: 255 format: uri type: string description: Valid URL linked to the Featured Message text description: Information about the entity's Featured Message 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. ' uniqueItems: true type: array items: required: - question additionalProperties: false type: object properties: answer: minLength: 1 maxLength: 4096 type: string question: minLength: 1 maxLength: 4096 type: string geomodifier: minLength: 0 type: string description: Provides additional information on where the entity can be found (e.g., `Times Square`, `Global Center Mall`) 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.' 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 ' properties: alternateText: minLength: 0 type: string url: minLength: 0 format: uri type: string 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. ' whatsappMessagingUrl: minLength: 0 maxLength: 2000 format: uri type: string description: 'A valid URL for this entity''s WhatsApp account. Must be a valid URL ' 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.' 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' uniqueItems: true type: array items: minLength: 0 maxLength: 50 type: string description: ' Cannot Include: * HTML markup' googlePlaceId: minLength: 0 type: string description: The unique identifier of this entity on Google Maps. 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. ' properties: alternateText: minLength: 0 type: string url: minLength: 0 format: uri type: string 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.' holidayHoursConversationEnabled: type: boolean description: Indicates whether holiday-hour confirmation alerts are enabled for the Yext Knowledge Assistant for this entity 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. openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). start: format: time type: string description: The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). 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. 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. ' 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' isClosed: type: boolean description: Indicates if the hours of operation are "closed" on on the given date. 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. openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). start: format: time type: string description: The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). description: Contains the time intervals for which the Entity is open on the specified date. monday: additionalProperties: false type: object properties: isClosed: type: boolean description: Indicates if the hours of operation are "closed" on Monday. openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). start: format: time type: string description: The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). 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. reopenDate: format: date type: string description: ' Date must be on or after 1970-01-01 Date must be before or on 2038-01-01' saturday: additionalProperties: false type: object properties: isClosed: type: boolean description: Indicates if the hours of operation are "closed" on Saturday. openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). start: format: time type: string description: The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). 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. sunday: additionalProperties: false type: object properties: isClosed: type: boolean description: Indicates if the hours of operation are "closed" on Sunday. openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). start: format: time type: string description: The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). 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. thursday: additionalProperties: false type: object properties: isClosed: type: boolean description: Indicates if the hours of operation are "closed" on Thursday. openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). start: format: time type: string description: The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). 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. tuesday: additionalProperties: false type: object properties: isClosed: type: boolean description: Indicates if the hours of operation are "closed" on Tuesday. openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). start: format: time type: string description: The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). 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. wednesday: additionalProperties: false type: object properties: isClosed: type: boolean description: Indicates if the hours of operation are "closed" on Wednesday. openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). start: format: time type: string description: The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). 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. 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.' 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. 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.' 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' uniqueItems: true type: array items: minLength: 0 maxLength: 100 type: string description: ' Cannot Include: * HTML markup' 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.' landingPageUrl: minLength: 0 format: uri type: string description: The URL of this entity's Landing Page that was created with Yext Pages 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. 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. locationType: enum: - LOCATION - HEALTHCARE_FACILITY - HEALTHCARE_PROFESSIONAL - ATM - RESTAURANT - HOTEL type: string description: Indicates the entity's type, if it is not an event 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. ' properties: clickthroughUrl: minLength: 0 format: uri type: string description: minLength: 0 type: string details: minLength: 0 type: string 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. ' properties: alternateText: minLength: 0 type: string url: minLength: 0 format: uri type: string 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.' 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.' nudgeEnabled: type: boolean description: Indicates whether Knowledge Nudge is enabled for the Yext Knowledge Assistant for this entity 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 ' 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. >' 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. ' properties: clickthroughUrl: minLength: 0 format: uri type: string description: minLength: 0 type: string details: minLength: 0 type: string 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. ' properties: alternateText: minLength: 0 type: string url: minLength: 0 format: uri type: string pickupCoordinate: additionalProperties: false type: object properties: latitude: minimum: -90 maximum: 90 type: number longitude: minimum: -180 maximum: 180 type: number description: Coordinates of where consumers can be picked up at the entity, as provided by you 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) primaryConversationContact: minLength: 0 type: string description: ID of the user who is the primary Knowledge Assistant contact for the entity questionsAndAnswers: type: boolean description: Indicates whether Yext Knowledge Assistant question-and-answer conversations are enabled for this entity 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. ' 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' 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.' rankTrackingEnabled: type: boolean description: Indicates whether Rank Tracking is enabled rankTrackingFrequency: enum: - WEEKLY - MONTHLY - QUARTERLY type: string description: How often we send search queries to track your search performance rankTrackingKeywords: description: 'The keywords for which you would like to track your search performance ' uniqueItems: true type: array items: enum: - NAME - PRIMARY_CATEGORY - SECONDARY_CATEGORY type: string 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. ' uniqueItems: true type: array items: enum: - KEYWORD - KEYWORD_ZIP - KEYWORD_CITY - KEYWORD_IN_CITY - KEYWORD_NEAR_ME - KEYWORD_CITY_STATE type: string rankTrackingSites: uniqueItems: true type: array items: enum: - GOOGLE_DESKTOP - GOOGLE_MOBILE - BING_DESKTOP - BING_MOBILE - YAHOO_DESKTOP - YAHOO_MOBILE type: string description: The search engines that we will use to track your performance reviewResponseConversationEnabled: type: boolean description: Indicates whether Yext Knowledge Assistant review-response conversations are enabled for this entity routableCoordinate: additionalProperties: false type: object properties: latitude: minimum: -90 maximum: 90 type: number longitude: minimum: -180 maximum: 180 type: number description: Destination coordinates to use for driving directions to the entity, as provided by you 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"` 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.' 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.' walkableCoordinate: additionalProperties: false type: object properties: latitude: minimum: -90 maximum: 90 type: number longitude: minimum: -180 maximum: 180 type: number description: Destination coordinates to use for walking directions to the entity, as provided by you 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`**.' 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. url: minLength: 0 maxLength: 2000 format: uri type: string description: A valid URL for this entity's website description: Information about the website for this entity EntityFieldSuggestionWrite: type: object description: 'An object containing information about a suggestion for a single field on a single entity. Only valid if the suggestion is for a field on a single entity. ' required: - entity - suggestedContent properties: entity: description: 'Information about the entity which the suggestion is being made on. ' type: object $ref: '#/components/schemas/EntityWrite-2' suggestedContent: description: 'Contains the fields and suggested values for the field(s) which are included in the suggestion. ' type: object $ref: '#/components/schemas/SuggestedContentWrite' EntityWrite-2: type: object description: The Entity which the suggestion is being made to. In Upsert requests, one of `entity.id` or `entity.uid` must be included, to identify the entity. properties: id: description: 'The ID of the entity. ' type: string uid: description: 'The UID of the entity. Formerly known as the Yext ID, this is the immutable ID of the entity. ' type: string language: description: 'Language code of this Entity''s Language Profile (defaults to the primary profile). ' type: string PageToken: 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. ' GoogleCategory: type: object properties: categoryId: type: string description: Google's ID for the category. clientCategoryIds: type: array items: type: string description: 'All category IDs taken from either the business'' partner category list, if defined, or otherwise from Yext, that map to this Google category. **NOTE**: If the **`v`** parameter is `20241030` or later, this field will only be returned if no filter is given (i.e. no **`clientCategoryId`** or **`entityId`**). ' fields: type: array description: List of fields for this category. items: $ref: '#/components/schemas/GoogleField' UpsertSuggestion: type: object required: - entityFieldSuggestion properties: entityFieldSuggestion: description: 'An object containing suggestion content and data for the entity and field the suggestion is on. ' type: object $ref: '#/components/schemas/EntityFieldSuggestionWrite' EventWrite: allOf: - $ref: '#/components/schemas/EntityWrite' - additionalProperties: false type: object properties: meta: additionalProperties: false type: object properties: countryCode: minLength: 0 type: string description: Country code of this Entity's Language Profile (defaults to the country of the account) folderId: minLength: 0 type: string description: The ID of the folder containing this Entity id: minLength: 0 type: string description: ID of this Entity labels: uniqueItems: false type: array items: minLength: 0 type: string description: This Entity's labels. If the **`v`** parameter is before `20211215`, this will be an integer. language: minLength: 0 type: string description: Language code of this Entity's Language Profile (defaults to the language code of the account) description: Contains the metadata about the entity. name: minLength: 0 maxLength: 5000 type: string description: ' Cannot Include: * HTML markup' 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' countryCode: minLength: 0 pattern: ^[a-zA-Z]{2}$ type: string 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`).' line1: minLength: 0 maxLength: 255 type: string description: ' Cannot Include: * a URL or domain name' line2: minLength: 0 maxLength: 255 type: string description: ' Cannot Include: * a URL or domain name' 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' region: minLength: 0 maxLength: 255 type: string description: 'The name of the entity''s region or state. Cannot Include: * a URL or domain name' sublocality: minLength: 0 maxLength: 255 type: string description: 'The name of the entity''s sublocality Cannot Include: * a URL or domain name' 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.' 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. ' uniqueItems: true type: array items: type: string ageRange: additionalProperties: false type: object properties: maxValue: multipleOf: 1 type: number description: Maximum age for the event minValue: multipleOf: 1 type: number description: Minimum age for the event description: Contains the age range for the event attendance: required: - attendanceMode additionalProperties: false type: object properties: attendanceMode: enum: - OFFLINE - ONLINE - MIXED type: string virtualLocationUrl: minLength: 0 format: uri type: string description: 'Indicates whether the event is online, offline, or a mix. A `virtualLocationUrl` must be specified for online and mixed events.' 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. ' categoryIds: uniqueItems: false type: array items: minLength: 0 type: string 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. ' description: minLength: 10 maxLength: 15000 type: string description: 'A description of the entity Cannot Include: * HTML markup' displayCoordinate: additionalProperties: false type: object properties: latitude: minimum: -90 maximum: 90 type: number longitude: minimum: -180 maximum: 180 type: number description: Coordinates where the map pin for the entity should be displayed, as provided by you dropoffCoordinate: additionalProperties: false type: object properties: latitude: minimum: -90 maximum: 90 type: number longitude: minimum: -180 maximum: 180 type: number description: Coordinates of the drop-off area for the entity, as provided by you eventStatus: enum: - SCHEDULED - RESCHEDULED - POSTPONED - CANCELED - EVENT_MOVED_ONLINE type: string description: Information on whether the event will take place as scheduled 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. ' uniqueItems: true type: array items: required: - question additionalProperties: false type: object properties: answer: minLength: 1 maxLength: 4096 type: string question: minLength: 1 maxLength: 4096 type: string isFreeEvent: type: boolean description: Indicates whether or not the event is free 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' uniqueItems: true type: array items: minLength: 0 maxLength: 100 type: string description: ' Cannot Include: * HTML markup' 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.' landingPageUrl: minLength: 0 format: uri type: string description: The URL of this entity's Landing Page that was created with Yext Pages linkedLocation: type: string description: location ID of the event location, if the event is held at a location managed in the Yext Knowledge Manager organizerEmail: minLength: 0 format: email type: string description: Point of contact for the event organizer (not to be published publicly) organizerName: minLength: 0 type: string description: Point of contact for the event organizer (not to be published publicly) organizerPhone: minLength: 0 type: string description: Point of contact for the event organizer (not to be published publicly) performers: description: 'Performers at the event Array must be ordered. Array may have a maximum of 100 elements. ' uniqueItems: true type: array items: minLength: 0 maxLength: 100 type: string 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. >' 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. ' properties: clickthroughUrl: minLength: 0 format: uri type: string description: minLength: 0 type: string details: minLength: 0 type: string 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. ' properties: alternateText: minLength: 0 type: string url: minLength: 0 format: uri type: string pickupCoordinate: additionalProperties: false type: object properties: latitude: minimum: -90 maximum: 90 type: number longitude: minimum: -180 maximum: 180 type: number description: Coordinates of where consumers can be picked up at the entity, as provided by you routableCoordinate: additionalProperties: false type: object properties: latitude: minimum: -90 maximum: 90 type: number longitude: minimum: -180 maximum: 180 type: number description: Destination coordinates to use for driving directions to the entity, as provided by you ticketAvailability: enum: - IN_STOCK - SOLD_OUT - PRE_ORDER - UNSPECIFIED type: string description: Information about the availability of tickets for the event ticketPriceRange: additionalProperties: false type: object properties: currencyCode: minLength: 0 type: string description: Three letter currency code (ISO standard) maxValue: pattern: ^\d*\.?\d*$ type: string description: Maximum ticket price minValue: pattern: ^\d*\.?\d*$ type: string description: Minimum ticket price description: Contains the price range for the event ticketSaleDateTime: format: date-time type: string description: The date/time tickets are available for sale (local time) ticketUrl: minLength: 0 format: uri type: string description: URL to purchase tickets for the event (if ticketed) 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` ' 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` ' description: Contains the start/end times for the event 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"` venueName: minLength: 0 type: string description: Name of the venue where the event is being held walkableCoordinate: additionalProperties: false type: object properties: latitude: minimum: -90 maximum: 90 type: number longitude: minimum: -180 maximum: 180 type: number description: Destination coordinates to use for walking directions to the entity, as provided by you 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`**.' 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. url: minLength: 0 maxLength: 2000 format: uri type: string description: A valid URL for this entity's website description: Information about the website for this entity Field: allOf: - $ref: '#/components/schemas/FieldUpdate' - type: object required: - type properties: id: type: string description: ' ID that should be used when referencing the field in API calls. This ID will also serve as the Custom Field''s key in our upcoming Entities API endpoints. Note that in Locations endpoints, Custom Fields are still referenced by their numeric **`id`**, which can be obtained by calling the Custom Fields: List endpoint with a **`v`** param before `20180809`. (For Create requests) Must have a prefix of `c_` and contain only alphanumeric characters or underscores. ' type: type: string description: ' The data type of the Custom Field''s contents. Only the types listed here are supported. Note that the `ENTITY_LIST` type has been renamed to `ENTITY_RELATIONSHIP`. The former can still be obtained by calling Custom Fields endpoints with a **`v`** param before `20220615`. Before `20180809`, this type was named `LOCATION_LIST`. ' enum: - BOOLEAN - CTA - DAILY_TIMES - DATE - GALLERY - HOURS - ENTITY_RELATIONSHIP - MARKDOWN - MULTILINE_TEXT - MULTI_OPTION - NUMBER - PHOTO - RICH_TEXT - RICH_TEXT_V2 - SINGLE_OPTION - TEXT - TEXT_LIST - URL - VIDEO - VIDEO_GALLERY GoogleOption: type: object properties: id: type: string description: Google's ID for the option. label: type: string description: Google's display name for the option. BaseEclSection: type: object properties: id: type: string description: Section ID. name: type: string description: Section name. description: type: string description: Section description. 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' 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. Source: type: object description: Provides information about the user/system responsible for creating the suggestion. properties: userId: description: 'The Yext User ID of the user responsible for the suggestion. Only included when the suggester is a Yext User. ' type: string appId: description: 'The Yext App ID of the app responsible for the suggestion. Only included when the suggester is an App. ' type: string publisherId: description: 'The ID of the publisher responsible for the suggestion. Only included when the suggester is a Publisher ' type: string yextSource: description: "A string identifier denoting the source of the Yext Suggestion.\n\nFor now, the only valid value here will be:\n * employee\n" type: string AssetForEntities: type: object required: - mappingType properties: mappingType: type: string description: 'The type of asset-to-entity mapping: * `NO_ENTITIES`: Not available to any entity. * `ALL_ENTITIES`: Available to all entities. * `FOLDER`: Available to all entities in a specified folder. * `ENTITIES`: Available to entities with the IDs you specify. ' folderId: type: string description: 'The *external* ID of the folder containing the entities this asset can be used for. Optional - can only be set if **`mappingType`** = `FOLDER`. ' entityIds: type: array items: type: string description: 'The *external* IDs of the entities this asset can be used for. Optional - can only be set if **`mappingType`** = `ENTITIES`. ' labelIds: type: array items: type: string description: 'The *external* IDs of the labels given to the entities this asset can be used for. Note that these labels are NOT asset labels. They are entity labels associated with particular entities in the Knowledge Manager. Optional - can only be set if **`mappingType`** = `FOLDER` or `ALL_ENTITIES`. ' labelOperator: type: string enum: - AND - OR description: 'The operator on the labels in **`labelIds`** (i.e., whether the asset can be used on entities with all (`AND`) or any (`OR`) of the labels specified). Optional - can only be set if **`mappingType`** = `FOLDER` or `ALL_ENTITIES`. ' Comment-2: type: object description: A comment on a Suggestion. properties: commenter: $ref: '#/components/schemas/Commenter' text: description: 'The text of the comment. ' type: string createdDate: description: 'Timestamp for when the comment was created. The format is ISO 8601 standard in UTC, e.g. **`yyyy-MM-ddTHH:mm:ssZ`**. ' type: string attachments: description: 'Attachments included in the comment. ' type: array items: $ref: '#/components/schemas/Attachment' Asset: type: object discriminator: propertyName: type mapping: complexImage: '#/components/schemas/AssetForComplexImage' complexVideo: '#/components/schemas/AssetForComplexVideo' text: '#/components/schemas/AssetForText' required: - name - type - forEntities - usage - value properties: id: type: string maxLength: 16 description: Primary key. Unique alphanumeric (Latin-1) ID assigned by the Yext. readOnly: true name: type: string maxLength: 100 description: Asset name. description: type: string maxLength: 255 description: Asset description. type: type: string description: 'Asset Type. In addition to the choices below, names of custom field types may also be used. One of: ' forEntities: $ref: '#/components/schemas/AssetForEntities' usage: type: array items: $ref: '#/components/schemas/AssetUsage' locale: type: string description: Language of the asset. labels: type: array items: type: string maxLength: 30 description: List of text labels for this asset. owner: type: string description: ID of the user who owns the asset. LocationWrite: allOf: - $ref: '#/components/schemas/EntityWrite' - additionalProperties: false type: object properties: meta: additionalProperties: false type: object properties: countryCode: minLength: 0 type: string description: Country code of this Entity's Language Profile (defaults to the country of the account) folderId: minLength: 0 type: string description: The ID of the folder containing this Entity id: minLength: 0 type: string description: ID of this Entity labels: uniqueItems: false type: array items: minLength: 0 type: string description: This Entity's labels. If the **`v`** parameter is before `20211215`, this will be an integer. language: minLength: 0 type: string description: Language code of this Entity's Language Profile (defaults to the language code of the account) description: Contains the metadata about the entity. name: minLength: 0 maxLength: 5000 type: string description: ' Cannot Include: * HTML markup' 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' countryCode: minLength: 0 pattern: ^[a-zA-Z]{2}$ type: string 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`).' line1: minLength: 0 maxLength: 255 type: string description: ' Cannot Include: * a URL or domain name' line2: minLength: 0 maxLength: 255 type: string description: ' Cannot Include: * a URL or domain name' 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' region: minLength: 0 maxLength: 255 type: string description: 'The name of the entity''s region or state. Cannot Include: * a URL or domain name' sublocality: minLength: 0 maxLength: 255 type: string description: 'The name of the entity''s sublocality Cannot Include: * a URL or domain name' 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.' 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. openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). start: format: time type: string description: The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). 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. 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. ' 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' isClosed: type: boolean description: Indicates if the access hours are "closed" on on the given date. 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. openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). start: format: time type: string description: The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). description: Contains the time intervals for which the Entity is open on the specified date. monday: additionalProperties: false type: object properties: isClosed: type: boolean description: Indicates if the access hours are "closed" on Monday. openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). start: format: time type: string description: The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). 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. reopenDate: format: date type: string description: ' Date must be on or after 1970-01-01 Date must be before or on 2038-01-01' saturday: additionalProperties: false type: object properties: isClosed: type: boolean description: Indicates if the access hours are "closed" on Saturday. openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). start: format: time type: string description: The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). 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. sunday: additionalProperties: false type: object properties: isClosed: type: boolean description: Indicates if the access hours are "closed" on Sunday. openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). start: format: time type: string description: The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). 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. thursday: additionalProperties: false type: object properties: isClosed: type: boolean description: Indicates if the access hours are "closed" on Thursday. openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). start: format: time type: string description: The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). 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. tuesday: additionalProperties: false type: object properties: isClosed: type: boolean description: Indicates if the access hours are "closed" on Tuesday. openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). start: format: time type: string description: The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). 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. wednesday: additionalProperties: false type: object properties: isClosed: type: boolean description: Indicates if the access hours are "closed" on Wednesday. openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). start: format: time type: string description: The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). 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. 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.' additionalHoursText: minLength: 0 maxLength: 255 type: string description: Additional information about hours that does not fit in **`hours`** (e.g., `"Closed during the winter"`) addressHidden: type: boolean description: If `true`, the entity's street address will not be shown on listings. Defaults to `false`. 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' uniqueItems: true type: array items: minLength: 0 maxLength: 100 type: string description: ' Cannot Include: * HTML markup' 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.' 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.' 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.' androidAppUrl: minLength: 0 type: string description: The URL where consumers can download the entity's Android app 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. ' uniqueItems: true type: array items: required: - category - quickLinkUrl - appName additionalProperties: false type: object properties: appName: minLength: 0 maxLength: 18 type: string appStoreUrl: minLength: 0 maxLength: 2000 format: uri type: string 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 quickLinkUrl: minLength: 0 maxLength: 2000 format: uri type: string appleBusinessDescription: minLength: 0 maxLength: 500 type: string description: The business description to be sent to Apple appleBusinessId: minLength: 0 pattern: ^\d*\.?\d*$ type: string description: The ID associated with an individual Business Folder in your Apple account appleCompanyId: minLength: 0 pattern: ^\d*\.?\d*$ type: string description: The ID associated with your Apple account. Numerical values only 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. ' properties: alternateText: minLength: 0 type: string url: minLength: 0 format: uri type: string appleDisplayName: minLength: 0 maxLength: 5000 type: string description: "The name to be displayed on Apple for the entity.\nNOTE: The names of Brands and their respective Locations within an Apple Business Connect Account must match identically.\nCannot Include:\nHTML markup \n\n\nCannot Include:\n* HTML markup" 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' uniqueItems: true type: array items: minLength: 0 maxLength: 100 type: string description: ' Cannot Include: * HTML markup' 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. ' uniqueItems: true type: array items: minLength: 0 type: string 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. description: Information about the Bio Content Lists associated with this entity 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' uniqueItems: true type: array items: minLength: 0 maxLength: 100 type: string description: ' Cannot Include: * HTML markup' 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. openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). start: format: time type: string description: The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). 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. 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. ' 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' isClosed: type: boolean description: Indicates if the brunch hours are "closed" on on the given date. 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. openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). start: format: time type: string description: The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). description: Contains the time intervals for which the Entity is open on the specified date. monday: additionalProperties: false type: object properties: isClosed: type: boolean description: Indicates if the brunch hours are "closed" on Monday. openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). start: format: time type: string description: The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). 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. reopenDate: format: date type: string description: ' Date must be on or after 1970-01-01 Date must be before or on 2038-01-01' saturday: additionalProperties: false type: object properties: isClosed: type: boolean description: Indicates if the brunch hours are "closed" on Saturday. openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). start: format: time type: string description: The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). 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. sunday: additionalProperties: false type: object properties: isClosed: type: boolean description: Indicates if the brunch hours are "closed" on Sunday. openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). start: format: time type: string description: The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). 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. thursday: additionalProperties: false type: object properties: isClosed: type: boolean description: Indicates if the brunch hours are "closed" on Thursday. openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). start: format: time type: string description: The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). 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. tuesday: additionalProperties: false type: object properties: isClosed: type: boolean description: Indicates if the brunch hours are "closed" on Tuesday. openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). start: format: time type: string description: The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). 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. wednesday: additionalProperties: false type: object properties: isClosed: type: boolean description: Indicates if the brunch hours are "closed" on Wednesday. openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). start: format: time type: string description: The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). 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. 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.' 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. ' uniqueItems: true type: array items: minLength: 0 type: string 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. description: Information about the events Content Lists (Calendars) associated with this entity 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. ' categoryIds: uniqueItems: false type: array items: minLength: 0 type: string 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. ' closed: type: boolean description: Indicates whether the entity is closed covidMessaging: minLength: 0 maxLength: 15000 type: string description: Information or messaging related to COVID-19. covidTestAppointmentUrl: minLength: 0 format: uri type: string description: An appointment URL for scheduling a COVID-19 test. covidTestingAppointmentRequired: type: boolean description: Indicates whether an appointment is required for a COVID-19 test. covidTestingDriveThroughSite: type: boolean description: Indicates whether location is a drive-through site for COVID-19 tests. covidTestingIsFree: type: boolean description: Indicates whether location offers free COVID-19 testing. covidTestingPatientRestrictions: type: boolean description: Indicates whether there are patient restrictions for COVID-19 testing. covidTestingReferralRequired: type: boolean description: Indicates whether a referral is required for COVID-19 testing. covidTestingSiteInstructions: minLength: 0 maxLength: 15000 type: string description: Information or instructions for the COVID-19 testing site. covidVaccineAppointmentRequired: type: boolean description: Indicates whether an appointment is required for a COVID-19 vaccine. covidVaccineDriveThroughSite: type: boolean description: Indicates whether location is a drive-through site for COVID-19 vaccines. covidVaccineInformationUrl: minLength: 0 format: uri type: string description: An information URL for more information about COVID-19 vaccines. covidVaccinePatientRestrictions: type: boolean description: Indicates whether there are patient restrictions for a COVID-19 vaccine. covidVaccineReferralRequired: type: boolean description: Indicates whether a referral is required for a COVID-19 vaccine. covidVaccineSiteInstructions: minLength: 0 maxLength: 15000 type: string description: Information or instructions for the COVID-19 vaccination site. covidVaccinesOffered: uniqueItems: true type: array items: enum: - PFIZER - MODERNA - JOHNSON_&_JOHNSON type: string description: Indicates which COVID-19 vaccines the location offers. 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. ' uniqueItems: true type: array items: minLength: 0 maxLength: 100 type: string 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. openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). start: format: time type: string description: The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). 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. 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. ' 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' isClosed: type: boolean description: Indicates if the delivery hours are "closed" on on the given date. 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. openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). start: format: time type: string description: The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). description: Contains the time intervals for which the Entity is delivering on the specified date. monday: additionalProperties: false type: object properties: isClosed: type: boolean description: Indicates if the delivery hours are "closed" on Monday. openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). start: format: time type: string description: The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). 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. reopenDate: format: date type: string description: ' Date must be on or after 1970-01-01 Date must be before or on 2038-01-01' saturday: additionalProperties: false type: object properties: isClosed: type: boolean description: Indicates if the delivery hours are "closed" on Saturday. openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). start: format: time type: string description: The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). 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. sunday: additionalProperties: false type: object properties: isClosed: type: boolean description: Indicates if the delivery hours are "closed" on Sunday. openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). start: format: time type: string description: The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). 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. thursday: additionalProperties: false type: object properties: isClosed: type: boolean description: Indicates if the delivery hours are "closed" on Thursday. openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). start: format: time type: string description: The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). 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. tuesday: additionalProperties: false type: object properties: isClosed: type: boolean description: Indicates if the delivery hours are "closed" on Tuesday. openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). start: format: time type: string description: The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). 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. wednesday: additionalProperties: false type: object properties: isClosed: type: boolean description: Indicates if the delivery hours are "closed" on Wednesday. openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). start: format: time type: string description: The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). 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. 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.' description: minLength: 10 maxLength: 15000 type: string description: 'A description of the entity Cannot Include: * HTML markup' displayCoordinate: additionalProperties: false type: object properties: latitude: minimum: -90 maximum: 90 type: number longitude: minimum: -180 maximum: 180 type: number description: Coordinates where the map pin for the entity should be displayed, as provided by you 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. openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). start: format: time type: string description: The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). 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. 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. ' 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' isClosed: type: boolean description: Indicates if the drive-through hours are "closed" on on the given date. 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. openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). start: format: time type: string description: The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). description: Contains the time intervals for which the Entity's drive-through is open on the specified date. monday: additionalProperties: false type: object properties: isClosed: type: boolean description: Indicates if the drive-through hours are "closed" on Monday. openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). start: format: time type: string description: The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). 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. reopenDate: format: date type: string description: ' Date must be on or after 1970-01-01 Date must be before or on 2038-01-01' saturday: additionalProperties: false type: object properties: isClosed: type: boolean description: Indicates if the drive-through hours are "closed" on Saturday. openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). start: format: time type: string description: The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). 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. sunday: additionalProperties: false type: object properties: isClosed: type: boolean description: Indicates if the drive-through hours are "closed" on Sunday. openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). start: format: time type: string description: The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). 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. thursday: additionalProperties: false type: object properties: isClosed: type: boolean description: Indicates if the drive-through hours are "closed" on Thursday. openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). start: format: time type: string description: The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). 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. tuesday: additionalProperties: false type: object properties: isClosed: type: boolean description: Indicates if the drive-through hours are "closed" on Tuesday. openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). start: format: time type: string description: The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). 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. wednesday: additionalProperties: false type: object properties: isClosed: type: boolean description: Indicates if the drive-through hours are "closed" on Wednesday. openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). start: format: time type: string description: The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). 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. 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.' dropoffCoordinate: additionalProperties: false type: object properties: latitude: minimum: -90 maximum: 90 type: number longitude: minimum: -180 maximum: 180 type: number description: Coordinates of the drop-off area for the entity, as provided by you 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. ' uniqueItems: true type: array items: minLength: 0 format: email type: string facebookAbout: minLength: 0 maxLength: 255 type: string description: A description of the entity to be used in the "About You" section on Facebook 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 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.' 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' 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. ' properties: alternateText: minLength: 0 type: string url: minLength: 0 format: uri type: string 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' 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. facebookOverrideCity: minLength: 0 type: string description: The city to be displayed on this entity's Facebook profile 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.' 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 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. ' properties: alternateText: minLength: 0 type: string url: minLength: 0 format: uri type: string facebookStoreId: minLength: 0 type: string description: The Store ID used for this entity in a brand page location structure 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. 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). 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.' 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' url: minLength: 0 maxLength: 255 format: uri type: string description: Valid URL linked to the Featured Message text description: Information about the entity's Featured Message firstPartyReviewPage: minLength: 0 type: string description: Link to the review-collection page, where consumers can leave first-party reviews 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. ' uniqueItems: true type: array items: required: - question additionalProperties: false type: object properties: answer: minLength: 1 maxLength: 4096 type: string question: minLength: 1 maxLength: 4096 type: string fullyVaccinatedStaff: type: boolean description: Indicates whether the staff is vaccinated against COVID-19. geomodifier: minLength: 0 type: string description: Provides additional information on where the entity can be found (e.g., `Times Square`, `Global Center Mall`) 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.' 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 ' properties: alternateText: minLength: 0 type: string url: minLength: 0 format: uri type: string 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. ' whatsappMessagingUrl: minLength: 0 maxLength: 2000 format: uri type: string description: 'A valid URL for this entity''s WhatsApp account. Must be a valid URL ' 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.' 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' uniqueItems: true type: array items: minLength: 0 maxLength: 50 type: string description: ' Cannot Include: * HTML markup' googlePlaceId: minLength: 0 type: string description: The unique identifier of this entity on Google Maps. 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. ' properties: alternateText: minLength: 0 type: string url: minLength: 0 format: uri type: string 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.' 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. openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). start: format: time type: string description: The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). 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. 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. ' 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' isClosed: type: boolean description: Indicates if the happy hours are "closed" on on the given date. 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. openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). start: format: time type: string description: The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). description: Contains the time intervals for the Entity's happy hours on the specified date. monday: additionalProperties: false type: object properties: isClosed: type: boolean description: Indicates if the happy hours are "closed" on Monday. openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). start: format: time type: string description: The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). 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. reopenDate: format: date type: string description: ' Date must be on or after 1970-01-01 Date must be before or on 2038-01-01' saturday: additionalProperties: false type: object properties: isClosed: type: boolean description: Indicates if the happy hours are "closed" on Saturday. openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). start: format: time type: string description: The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). 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. sunday: additionalProperties: false type: object properties: isClosed: type: boolean description: Indicates if the happy hours are "closed" on Sunday. openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). start: format: time type: string description: The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). 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. thursday: additionalProperties: false type: object properties: isClosed: type: boolean description: Indicates if the happy hours are "closed" on Thursday. openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). start: format: time type: string description: The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). 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. tuesday: additionalProperties: false type: object properties: isClosed: type: boolean description: Indicates if the happy hours are "closed" on Tuesday. openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). start: format: time type: string description: The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). 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. wednesday: additionalProperties: false type: object properties: isClosed: type: boolean description: Indicates if the happy hours are "closed" on Wednesday. openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). start: format: time type: string description: The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). 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. 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.' holidayHoursConversationEnabled: type: boolean description: Indicates whether holiday-hour confirmation alerts are enabled for the Yext Knowledge Assistant for this entity 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. openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). start: format: time type: string description: The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). 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. 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. ' 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' isClosed: type: boolean description: Indicates if the hours of operation are "closed" on on the given date. 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. openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). start: format: time type: string description: The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). description: Contains the time intervals for which the Entity is open on the specified date. monday: additionalProperties: false type: object properties: isClosed: type: boolean description: Indicates if the hours of operation are "closed" on Monday. openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). start: format: time type: string description: The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). 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. reopenDate: format: date type: string description: ' Date must be on or after 1970-01-01 Date must be before or on 2038-01-01' saturday: additionalProperties: false type: object properties: isClosed: type: boolean description: Indicates if the hours of operation are "closed" on Saturday. openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). start: format: time type: string description: The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). 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. sunday: additionalProperties: false type: object properties: isClosed: type: boolean description: Indicates if the hours of operation are "closed" on Sunday. openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). start: format: time type: string description: The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). 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. thursday: additionalProperties: false type: object properties: isClosed: type: boolean description: Indicates if the hours of operation are "closed" on Thursday. openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). start: format: time type: string description: The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). 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. tuesday: additionalProperties: false type: object properties: isClosed: type: boolean description: Indicates if the hours of operation are "closed" on Tuesday. openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). start: format: time type: string description: The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). 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. wednesday: additionalProperties: false type: object properties: isClosed: type: boolean description: Indicates if the hours of operation are "closed" on Wednesday. openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). start: format: time type: string description: The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). 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. 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.' 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. instagramHandle: minLength: 0 maxLength: 30 type: string description: Valid Instagram username for the entity without the leading "@" (e.g., `NewCityAuto`) iosAppUrl: minLength: 0 type: string description: The URL where consumers can download the entity's app to their iPhone or iPad 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.' 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' uniqueItems: true type: array items: minLength: 0 maxLength: 100 type: string description: ' Cannot Include: * HTML markup' 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. openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). start: format: time type: string description: The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). 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. 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. ' 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' isClosed: type: boolean description: Indicates if the kitchen hours are "closed" on on the given date. 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. openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). start: format: time type: string description: The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). description: Contains the time intervals for which the Entity's kitchen is open on the specified date. monday: additionalProperties: false type: object properties: isClosed: type: boolean description: Indicates if the kitchen hours are "closed" on Monday. openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). start: format: time type: string description: The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). 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. reopenDate: format: date type: string description: ' Date must be on or after 1970-01-01 Date must be before or on 2038-01-01' saturday: additionalProperties: false type: object properties: isClosed: type: boolean description: Indicates if the kitchen hours are "closed" on Saturday. openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). start: format: time type: string description: The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). 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. sunday: additionalProperties: false type: object properties: isClosed: type: boolean description: Indicates if the kitchen hours are "closed" on Sunday. openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). start: format: time type: string description: The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). 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. thursday: additionalProperties: false type: object properties: isClosed: type: boolean description: Indicates if the kitchen hours are "closed" on Thursday. openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). start: format: time type: string description: The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). 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. tuesday: additionalProperties: false type: object properties: isClosed: type: boolean description: Indicates if the kitchen hours are "closed" on Tuesday. openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). start: format: time type: string description: The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). 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. wednesday: additionalProperties: false type: object properties: isClosed: type: boolean description: Indicates if the kitchen hours are "closed" on Wednesday. openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). start: format: time type: string description: The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). 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. 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.' 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.' landingPageUrl: minLength: 0 format: uri type: string description: The URL of this entity's Landing Page that was created with Yext Pages 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' uniqueItems: true type: array items: minLength: 0 maxLength: 100 type: string description: ' Cannot Include: * HTML markup' linkedInUrl: minLength: 0 format: uri type: string description: URL for your LinkedIn account, format should be https://www.linkedin.com/in/yourUsername 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. locationType: enum: - LOCATION - HEALTHCARE_FACILITY - HEALTHCARE_PROFESSIONAL - ATM - RESTAURANT - HOTEL type: string description: Indicates the entity's type, if it is not an event 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. ' properties: clickthroughUrl: minLength: 0 format: uri type: string description: minLength: 0 type: string details: minLength: 0 type: string 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. ' properties: alternateText: minLength: 0 type: string url: minLength: 0 format: uri type: string 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.' 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`**. 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. url: minLength: 0 maxLength: 2000 format: uri type: string description: A valid URL where consumers can view the entity's menu description: Information about the URL where consumers can view the entity's menu 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. ' uniqueItems: true type: array items: minLength: 0 type: string 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. description: Information about the Menu Content Lists associated with this entity 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.' nudgeEnabled: type: boolean description: Indicates whether Knowledge Nudge is enabled for the Yext Knowledge Assistant for this entity 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. openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). start: format: time type: string description: The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). 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. 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. ' 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' isClosed: type: boolean description: Indicates if the online service hours are "closed" on on the given date. 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. openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). start: format: time type: string description: The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). description: Contains the time intervals for the Entity's online service hours on the specified date. monday: additionalProperties: false type: object properties: isClosed: type: boolean description: Indicates if the online service hours are "closed" on Monday. openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). start: format: time type: string description: The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). 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. reopenDate: format: date type: string description: ' Date must be on or after 1970-01-01 Date must be before or on 2038-01-01' saturday: additionalProperties: false type: object properties: isClosed: type: boolean description: Indicates if the online service hours are "closed" on Saturday. openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). start: format: time type: string description: The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). 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. sunday: additionalProperties: false type: object properties: isClosed: type: boolean description: Indicates if the online service hours are "closed" on Sunday. openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). start: format: time type: string description: The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). 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. thursday: additionalProperties: false type: object properties: isClosed: type: boolean description: Indicates if the online service hours are "closed" on Thursday. openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). start: format: time type: string description: The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). 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. tuesday: additionalProperties: false type: object properties: isClosed: type: boolean description: Indicates if the online service hours are "closed" on Tuesday. openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). start: format: time type: string description: The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). 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. wednesday: additionalProperties: false type: object properties: isClosed: type: boolean description: Indicates if the online service hours are "closed" on Wednesday. openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). start: format: time type: string description: The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). 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. 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.' 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 ' 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`**. 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. url: minLength: 0 maxLength: 2000 format: uri type: string description: A valid URL used to place an order at this entity description: Information about the URL used to place orders that will be fulfilled by the entity 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: 'The payment methods accepted by this entity Valid elements depend on the entity''s country. ' 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. >' 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. ' properties: clickthroughUrl: minLength: 0 format: uri type: string description: minLength: 0 type: string details: minLength: 0 type: string 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. ' properties: alternateText: minLength: 0 type: string url: minLength: 0 format: uri type: string pickupCoordinate: additionalProperties: false type: object properties: latitude: minimum: -90 maximum: 90 type: number longitude: minimum: -180 maximum: 180 type: number description: Coordinates of where consumers can be picked up at the entity, as provided by you 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. openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). start: format: time type: string description: The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). 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. 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. ' 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' isClosed: type: boolean description: Indicates if the pickup hours are "closed" on on the given date. 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. openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). start: format: time type: string description: The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). description: Contains the time intervals for which the Entity is open for pickup on the specified date. monday: additionalProperties: false type: object properties: isClosed: type: boolean description: Indicates if the pickup hours are "closed" on Monday. openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). start: format: time type: string description: The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). 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. reopenDate: format: date type: string description: ' Date must be on or after 1970-01-01 Date must be before or on 2038-01-01' saturday: additionalProperties: false type: object properties: isClosed: type: boolean description: Indicates if the pickup hours are "closed" on Saturday. openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). start: format: time type: string description: The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). 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. sunday: additionalProperties: false type: object properties: isClosed: type: boolean description: Indicates if the pickup hours are "closed" on Sunday. openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). start: format: time type: string description: The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). 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. thursday: additionalProperties: false type: object properties: isClosed: type: boolean description: Indicates if the pickup hours are "closed" on Thursday. openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). start: format: time type: string description: The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). 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. tuesday: additionalProperties: false type: object properties: isClosed: type: boolean description: Indicates if the pickup hours are "closed" on Tuesday. openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). start: format: time type: string description: The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). 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. wednesday: additionalProperties: false type: object properties: isClosed: type: boolean description: Indicates if the pickup hours are "closed" on Wednesday. openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). start: format: time type: string description: The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). 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. 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.' pinterestUrl: minLength: 0 format: uri type: string description: URL for your Pinterest account, format should be https://www.pinterest.com/yourUsername 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) primaryConversationContact: minLength: 0 type: string description: ID of the user who is the primary Knowledge Assistant contact for the entity 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. ' uniqueItems: true type: array items: minLength: 0 type: string 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. description: Information about the Products & Services Content Lists associated with this entity 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' uniqueItems: true type: array items: minLength: 0 maxLength: 100 type: string description: ' Cannot Include: * HTML markup' questionsAndAnswers: type: boolean description: Indicates whether Yext Knowledge Assistant question-and-answer conversations are enabled for this entity 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. ' 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' 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.' rankTrackingEnabled: type: boolean description: Indicates whether Rank Tracking is enabled rankTrackingFrequency: enum: - WEEKLY - MONTHLY - QUARTERLY type: string description: How often we send search queries to track your search performance rankTrackingKeywords: description: 'The keywords for which you would like to track your search performance ' uniqueItems: true type: array items: enum: - NAME - PRIMARY_CATEGORY - SECONDARY_CATEGORY type: string 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. ' uniqueItems: true type: array items: enum: - KEYWORD - KEYWORD_ZIP - KEYWORD_CITY - KEYWORD_IN_CITY - KEYWORD_NEAR_ME - KEYWORD_CITY_STATE type: string rankTrackingSites: uniqueItems: true type: array items: enum: - GOOGLE_DESKTOP - GOOGLE_MOBILE - BING_DESKTOP - BING_MOBILE - YAHOO_DESKTOP - YAHOO_MOBILE type: string description: The search engines that we will use to track your performance 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`**.' 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. url: minLength: 0 maxLength: 2000 format: uri type: string description: A valid URL used to make reservations at this entity description: Information about the URL consumers can visit to make reservations at this entity reviewGenerationUrl: minLength: 0 type: string description: The URL given Review Invitation emails where consumers can leave a review about the entity reviewResponseConversationEnabled: type: boolean description: Indicates whether Yext Knowledge Assistant review-response conversations are enabled for this entity routableCoordinate: additionalProperties: false type: object properties: latitude: minimum: -90 maximum: 90 type: number longitude: minimum: -180 maximum: 180 type: number description: Destination coordinates to use for driving directions to the entity, as provided by you 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. openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). start: format: time type: string description: The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). 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. 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. ' 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' isClosed: type: boolean description: Indicates if the senior hours are "closed" on on the given date. 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. openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). start: format: time type: string description: The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). description: Contains the time intervals for the Entity's senior hours on the specified date. monday: additionalProperties: false type: object properties: isClosed: type: boolean description: Indicates if the senior hours are "closed" on Monday. openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). start: format: time type: string description: The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). 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. reopenDate: format: date type: string description: ' Date must be on or after 1970-01-01 Date must be before or on 2038-01-01' saturday: additionalProperties: false type: object properties: isClosed: type: boolean description: Indicates if the senior hours are "closed" on Saturday. openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). start: format: time type: string description: The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). 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. sunday: additionalProperties: false type: object properties: isClosed: type: boolean description: Indicates if the senior hours are "closed" on Sunday. openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). start: format: time type: string description: The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). 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. thursday: additionalProperties: false type: object properties: isClosed: type: boolean description: Indicates if the senior hours are "closed" on Thursday. openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). start: format: time type: string description: The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). 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. tuesday: additionalProperties: false type: object properties: isClosed: type: boolean description: Indicates if the senior hours are "closed" on Tuesday. openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). start: format: time type: string description: The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). 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. wednesday: additionalProperties: false type: object properties: isClosed: type: boolean description: Indicates if the senior hours are "closed" on Wednesday. openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). start: format: time type: string description: The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). 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. 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.' serviceArea: additionalProperties: false type: object properties: places: description: "A list of places served by the entity, where each place is either:\n - a postal code, or\n - the name of a city.\n\n\n\nArray must be ordered.\n\nArray may have a maximum of 200 elements.\n" uniqueItems: true type: array items: minLength: 0 maxLength: 100 type: string 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.' 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. ' uniqueItems: true type: array items: additionalProperties: false type: object properties: name: minLength: 0 maxLength: 100 type: string googlePlaceId: minLength: 0 type: string type: enum: - POSTAL_CODE - REGION - COUNTY - CITY - SUBLOCALITY type: string 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' uniqueItems: true type: array items: minLength: 0 maxLength: 100 type: string description: ' Cannot Include: * HTML markup' 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' uniqueItems: true type: array items: minLength: 0 maxLength: 100 type: string description: ' Cannot Include: * HTML markup' 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. openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). start: format: time type: string description: The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). 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. 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. ' 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' isClosed: type: boolean description: Indicates if the takeout hours are "closed" on on the given date. 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. openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). start: format: time type: string description: The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). description: Contains the time intervals for which the Entity is open for takeout on the specified date. monday: additionalProperties: false type: object properties: isClosed: type: boolean description: Indicates if the takeout hours are "closed" on Monday. openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). start: format: time type: string description: The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). 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. reopenDate: format: date type: string description: ' Date must be on or after 1970-01-01 Date must be before or on 2038-01-01' saturday: additionalProperties: false type: object properties: isClosed: type: boolean description: Indicates if the takeout hours are "closed" on Saturday. openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). start: format: time type: string description: The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). 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. sunday: additionalProperties: false type: object properties: isClosed: type: boolean description: Indicates if the takeout hours are "closed" on Sunday. openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). start: format: time type: string description: The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). 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. thursday: additionalProperties: false type: object properties: isClosed: type: boolean description: Indicates if the takeout hours are "closed" on Thursday. openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). start: format: time type: string description: The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). 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. tuesday: additionalProperties: false type: object properties: isClosed: type: boolean description: Indicates if the takeout hours are "closed" on Tuesday. openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). start: format: time type: string description: The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). 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. wednesday: additionalProperties: false type: object properties: isClosed: type: boolean description: Indicates if the takeout hours are "closed" on Wednesday. openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). start: format: time type: string description: The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). 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. 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.' tikTokUrl: minLength: 0 format: uri type: string description: URL for your TikTok profile, format should be https://www.tiktok.com/yourUsername 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"` 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.' 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.' 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.' 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.' 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`.' 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 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`**.' 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`**.' 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`**.' description: Information about the call-to-action consumers will see in the Uber app during a trip to your entity 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. ' uniqueItems: true type: array items: required: - video additionalProperties: false type: object properties: description: minLength: 0 maxLength: 140 type: string description: ' Cannot Include: * HTML markup' video: required: - url additionalProperties: false type: object properties: url: minLength: 0 format: uri type: string walkableCoordinate: additionalProperties: false type: object properties: latitude: minimum: -90 maximum: 90 type: number longitude: minimum: -180 maximum: 180 type: number description: Destination coordinates to use for walking directions to the entity, as provided by you 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`**.' 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. url: minLength: 0 maxLength: 2000 format: uri type: string description: A valid URL for this entity's website description: Information about the website for this entity yearEstablished: multipleOf: 1 minimum: 1000 maximum: 2028 type: number description: The year the entity was established. youTubeChannelUrl: minLength: 0 format: uri type: string description: URL for your YouTube channel, format should be https://www.youtube.com/c/yourUsername FaqWrite: allOf: - $ref: '#/components/schemas/EntityWrite' - additionalProperties: false type: object properties: meta: additionalProperties: false type: object properties: countryCode: minLength: 0 type: string description: Country code of this Entity's Language Profile (defaults to the country of the account) folderId: minLength: 0 type: string description: The ID of the folder containing this Entity id: minLength: 0 type: string description: ID of this Entity labels: uniqueItems: false type: array items: minLength: 0 type: string description: This Entity's labels. If the **`v`** parameter is before `20211215`, this will be an integer. language: minLength: 0 type: string description: Language code of this Entity's Language Profile (defaults to the language code of the account) description: Contains the metadata about the entity. name: minLength: 0 maxLength: 5000 type: string description: ' Cannot Include: * HTML markup' 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' type: string format: rich-text 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' uniqueItems: true type: array items: minLength: 0 maxLength: 100 type: string description: ' Cannot Include: * HTML markup' 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.' landingPageUrl: minLength: 0 format: uri type: string description: The URL of this entity's Landing Page that was created with Yext Pages 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. ' properties: clickthroughUrl: minLength: 0 format: uri type: string description: minLength: 0 type: string details: minLength: 0 type: string 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. ' properties: alternateText: minLength: 0 type: string url: minLength: 0 format: uri type: string nudgeEnabled: type: boolean description: Indicates whether Knowledge Nudge is enabled for the Yext Knowledge Assistant for this entity primaryConversationContact: minLength: 0 type: string description: ID of the user who is the primary Knowledge Assistant contact for the entity 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"` Approver: type: object description: Provides information about the user/system responsible for approving/rejecting the suggestion. Only included if the suggestion has been approved or rejected. properties: userId: description: 'The Yext User ID of the user responsible for resolving the suggestion. Only included when the approver is a Yext User. ' type: string appId: description: 'The Yext App ID of the app responsible for resolving the suggestion. Only included when the approver is an App. ' type: string EntityRead: type: object description: The Entity information for the suggestion. properties: id: description: 'The ID of the entity. ' type: string uid: description: 'The UID of the entity. Formerly known as the Yext ID, this is the immutable ID of the entity. ' type: string type: description: 'The type of the entity. ' type: string language: description: 'Language code of this Entity''s Language Profile. ' type: string folderId: description: 'The ID of the folder which the entity is in, if the entity is in a folder. ' type: string labels: description: 'Any labels included on the entity. ' type: array items: type: string BioItem: allOf: - $ref: '#/components/schemas/BaseEclItem' - type: object properties: photo: $ref: '#/components/schemas/CommonEclDefinitions_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. GoogleField: type: object properties: label: type: string description: Google's display name for the field. id: type: string description: Google's ID for this field. group: type: string description: The name of the group that contains this attribute. options: type: array items: $ref: '#/components/schemas/GoogleOption' ProductEcl_Section: allOf: - $ref: '#/components/schemas/BaseEclSection' - type: object properties: items: type: array description: Section Items. items: $ref: '#/components/schemas/ProductItem' ResponseMeta: type: object properties: uuid: type: string example: 4f72b877-e2d0-4de4-9324-b9cf2c03e1a0 description: Unique ID for this request / response. 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' requestBodies: eventRequest: required: true content: application/kjson: schema: $ref: '#/components/schemas/Event' menuRequest: required: true content: application/json: schema: $ref: '#/components/schemas/Menu' productRequest: required: true content: application/kjson: schema: $ref: '#/components/schemas/Product' assetRequest: required: true content: application/json: schema: $ref: '#/components/schemas/Asset' locationRequest: required: true content: application/json: schema: $ref: '#/components/schemas/Location' bioRequest: required: true content: application/kjson: schema: $ref: '#/components/schemas/Bio' responses: LocationsSearchResponse: description: Locations Search Response. content: application/json: schema: title: LocationsSearchResponse type: object properties: meta: $ref: '#/components/schemas/ResponseMeta' response: type: object properties: count: type: integer description: Total number of Locations that meet filter criteria (ignores limit / offset). locations: type: array items: $ref: '#/components/schemas/Location' BiosResponse: description: Bio Lists Response. content: application/json: schema: title: BioListsResponse type: object properties: meta: $ref: '#/components/schemas/ResponseMeta' response: type: object properties: count: type: integer description: Total number of Bio Lists that meet filter criteria (ignores limit / offset). bios: type: array items: $ref: '#/components/schemas/Bio' AssetResponse: description: Asset Response. content: application/json: schema: title: AssetResponse type: object properties: meta: $ref: '#/components/schemas/ResponseMeta' response: $ref: '#/components/schemas/Asset' EventsResponse: description: Event Lists Response. content: application/json: schema: title: EventListsResponse type: object properties: meta: $ref: '#/components/schemas/ResponseMeta' response: type: object properties: count: type: integer description: Total number of Event Lists that meet filter criteria (ignores limit / offset). events: type: array items: $ref: '#/components/schemas/Event' IdsResponse: description: IDs Response. content: application/json: schema: title: IdsResponse type: object properties: meta: $ref: '#/components/schemas/ResponseMeta' response: type: array items: properties: id: type: string CommentResponse: description: Success Response content: application/json: schema: title: SuggestionResponse type: object properties: meta: $ref: '#/components/schemas/ResponseMeta' response: $ref: '#/components/schemas/Comment-2' ProductResponse: description: Product List Response. content: application/json: schema: title: ProductListResponse type: object properties: meta: $ref: '#/components/schemas/ResponseMeta' response: $ref: '#/components/schemas/Product' ProductsResponse: description: Product Lists Response. content: application/json: schema: title: ProductListsResponse type: object properties: meta: $ref: '#/components/schemas/ResponseMeta' response: type: object properties: count: type: integer description: Total number of Product Lists that meet filter criteria (ignores limit / offset). products: type: array items: $ref: '#/components/schemas/Product' 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' CustomFieldResponse: description: Custom Field Response. content: application/json: schema: title: CustomFieldResponse type: object properties: meta: $ref: '#/components/schemas/ResponseMeta' response: $ref: '#/components/schemas/Field' CategoriesResponse: description: Business Categories Response. content: application/json: schema: title: BusinessCategoriesResponse type: object properties: meta: $ref: '#/components/schemas/ResponseMeta' response: type: array items: $ref: '#/components/schemas/Category' FoldersResponse: description: Folders Response. content: application/json: schema: title: FoldersResponse type: object properties: meta: $ref: '#/components/schemas/ResponseMeta' response: type: object properties: count: type: integer description: Total number of Location Folders in the Account. folders: type: array items: $ref: '#/components/schemas/Folders' IdResponse: description: ID Response. content: application/json: schema: title: IdResponse type: object properties: meta: $ref: '#/components/schemas/ResponseMeta' response: type: object properties: id: type: string EmptyResponse: description: Empty Response. content: application/json: schema: title: EmptyResponse type: object properties: meta: $ref: '#/components/schemas/ResponseMeta' response: type: object GoogleFieldsResponse: description: Google Fields Response. content: application/json: schema: title: GoogleFieldsResponse type: object properties: meta: $ref: '#/components/schemas/ResponseMeta' response: type: object properties: items: type: array description: List of Google Fields. items: $ref: '#/components/schemas/GoogleCategory' MenusResponse: description: Menus Response. content: application/json: schema: title: MenuListsResponse type: object properties: meta: $ref: '#/components/schemas/ResponseMeta' response: type: object properties: count: type: integer description: Total number of Menus that meet filter criteria (ignores limit / offset). menus: type: array items: $ref: '#/components/schemas/Menu' AssetsResponse: description: Assets Response. content: application/json: schema: title: AssetsResponse type: object properties: meta: $ref: '#/components/schemas/ResponseMeta' response: type: object properties: count: type: integer description: Total number of assets in the account (ignores **`limit`** and **`offset`** parameters). assets: type: array items: $ref: '#/components/schemas/Asset' pageToken: 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 **`offset`** parameter. ' LocationResponse: description: Location Response. content: application/json: schema: title: LocationResponse type: object properties: meta: $ref: '#/components/schemas/ResponseMeta' response: $ref: '#/components/schemas/Location' SuggestionResponse: description: Success Response content: application/json: schema: title: SuggestionResponse type: object properties: meta: $ref: '#/components/schemas/ResponseMeta' response: additionalProperties: false type: object properties: suggestion: $ref: '#/components/schemas/SuggestionRead' LanguageProfileResponse: description: Language Profile Response. content: application/json: schema: title: LanguageProfileResponse type: object properties: meta: $ref: '#/components/schemas/ResponseMeta' response: $ref: '#/components/schemas/Location' MenuResponse: description: Menu Response. content: application/json: schema: title: MenuListResponse type: object properties: meta: $ref: '#/components/schemas/ResponseMeta' response: $ref: '#/components/schemas/Menu' CustomFieldsResponse: description: Custom Fields Response. content: application/json: schema: title: CustomFieldsResponse type: object properties: meta: $ref: '#/components/schemas/ResponseMeta' response: type: object properties: count: type: integer description: Total number of Custom Fields in the account. customFields: type: array items: $ref: '#/components/schemas/Field' pageToken: $ref: '#/components/schemas/PageToken' ErrorResponse: description: Error Response content: application/json: schema: title: ErrorResponse type: object properties: meta: $ref: '#/components/schemas/ResponseMetaWithError' response: type: object EventResponse: description: Event List Response. content: application/json: schema: title: EventListResponse type: object properties: meta: $ref: '#/components/schemas/ResponseMeta' response: $ref: '#/components/schemas/Event' BioResponse: description: Bio List Response. content: application/json: schema: title: BioListResponse type: object properties: meta: $ref: '#/components/schemas/ResponseMeta' response: $ref: '#/components/schemas/Bio' 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 that meet filter criteria (ignores limit / offset). nextPageToken: $ref: '#/components/schemas/NextPageToken' locations: type: array items: $ref: '#/components/schemas/Location' SuggestionsResponse: description: Success Response content: application/json: schema: title: SuggestionsResponse type: object properties: meta: $ref: '#/components/schemas/ResponseMeta' response: additionalProperties: false type: object properties: count: type: integer description: 'Total number of Suggestions that meet the filter criteria ' suggestions: type: array items: $ref: '#/components/schemas/SuggestionRead' nextPageToken: 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 **`nextPageToken`** value will not be returned. ' securitySchemes: api_key: type: apiKey name: api_key in: query api-key: type: apiKey name: api-key in: header